azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.i...

350 строки
28 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.iothub.models.Certificates"
fullName: "com.azure.resourcemanager.iothub.models.Certificates"
name: "Certificates"
nameWithType: "Certificates"
summary: "Resource collection API of Certificates."
syntax: "public interface **Certificates**"
methods:
- uid: "com.azure.resourcemanager.iothub.models.Certificates.define(java.lang.String)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.define(String name)"
name: "define(String name)"
nameWithType: "Certificates.define(String name)"
summary: "Begins definition for a new Certificate<wbr>Description resource."
modifiers:
- "abstract"
parameters:
- description: "resource name."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract CertificateDescription.DefinitionStages.Blank define(String name)"
desc: "Begins definition for a new CertificateDescription resource."
returns:
description: "the first stage of the new CertificateDescription definition."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.CertificateDescription.DefinitionStages.Blank?alt=com.azure.resourcemanager.iothub.models.CertificateDescription.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.Certificates.delete(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.delete(String resourceGroupName, String resourceName, String certificateName, String ifMatch)"
name: "delete(String resourceGroupName, String resourceName, String certificateName, String ifMatch)"
nameWithType: "Certificates.delete(String resourceGroupName, String resourceName, String certificateName, String ifMatch)"
summary: "Delete an X509 certificate."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT hub."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the IoT hub."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the certificate."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "ETag of the Certificate."
name: "ifMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void delete(String resourceGroupName, String resourceName, String certificateName, String ifMatch)"
desc: "Delete an X509 certificate.\n\nDeletes an existing X509 certificate or does nothing if it does not exist."
- uid: "com.azure.resourcemanager.iothub.models.Certificates.deleteById(java.lang.String)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.deleteById(String id)"
name: "deleteById(String id)"
nameWithType: "Certificates.deleteById(String id)"
summary: "Delete an X509 certificate."
modifiers:
- "abstract"
parameters:
- description: "the resource ID."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void deleteById(String id)"
desc: "Delete an X509 certificate.\n\nDeletes an existing X509 certificate or does nothing if it does not exist."
- uid: "com.azure.resourcemanager.iothub.models.Certificates.deleteByIdWithResponse(java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.deleteByIdWithResponse(String id, String ifMatch, Context context)"
name: "deleteByIdWithResponse(String id, String ifMatch, Context context)"
nameWithType: "Certificates.deleteByIdWithResponse(String id, String ifMatch, Context context)"
summary: "Delete an X509 certificate."
modifiers:
- "abstract"
parameters:
- description: "the resource ID."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "ETag of the Certificate."
name: "ifMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<Void> deleteByIdWithResponse(String id, String ifMatch, Context context)"
desc: "Delete an X509 certificate.\n\nDeletes an existing X509 certificate or does nothing if it does not exist."
returns:
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.iothub.models.Certificates.deleteWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.deleteWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, Context context)"
name: "deleteWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, Context context)"
nameWithType: "Certificates.deleteWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, Context context)"
summary: "Delete an X509 certificate."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT hub."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the IoT hub."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the certificate."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "ETag of the Certificate."
name: "ifMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<Void> deleteWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, Context context)"
desc: "Delete an X509 certificate.\n\nDeletes an existing X509 certificate or does nothing if it does not exist."
returns:
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.iothub.models.Certificates.generateVerificationCode(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.generateVerificationCode(String resourceGroupName, String resourceName, String certificateName, String ifMatch)"
name: "generateVerificationCode(String resourceGroupName, String resourceName, String certificateName, String ifMatch)"
nameWithType: "Certificates.generateVerificationCode(String resourceGroupName, String resourceName, String certificateName, String ifMatch)"
summary: "Generate verification code for proof of possession flow."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT hub."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the IoT hub."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the certificate."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "ETag of the Certificate."
name: "ifMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract CertificateWithNonceDescription generateVerificationCode(String resourceGroupName, String resourceName, String certificateName, String ifMatch)"
desc: "Generate verification code for proof of possession flow.\n\nGenerates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate."
returns:
description: "the X509 Certificate."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.CertificateWithNonceDescription?alt=com.azure.resourcemanager.iothub.models.CertificateWithNonceDescription&text=CertificateWithNonceDescription\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.Certificates.generateVerificationCodeWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.generateVerificationCodeWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, Context context)"
name: "generateVerificationCodeWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, Context context)"
nameWithType: "Certificates.generateVerificationCodeWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, Context context)"
summary: "Generate verification code for proof of possession flow."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT hub."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the IoT hub."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the certificate."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "ETag of the Certificate."
name: "ifMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<CertificateWithNonceDescription> generateVerificationCodeWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, Context context)"
desc: "Generate verification code for proof of possession flow.\n\nGenerates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate."
returns:
description: "the X509 Certificate along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.iothub.models.CertificateWithNonceDescription?alt=com.azure.resourcemanager.iothub.models.CertificateWithNonceDescription&text=CertificateWithNonceDescription\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iothub.models.Certificates.get(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.get(String resourceGroupName, String resourceName, String certificateName)"
name: "get(String resourceGroupName, String resourceName, String certificateName)"
nameWithType: "Certificates.get(String resourceGroupName, String resourceName, String certificateName)"
summary: "Get the certificate."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT hub."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the IoT hub."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the certificate."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract CertificateDescription get(String resourceGroupName, String resourceName, String certificateName)"
desc: "Get the certificate.\n\nReturns the certificate."
returns:
description: "the X509 Certificate."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.CertificateDescription?alt=com.azure.resourcemanager.iothub.models.CertificateDescription&text=CertificateDescription\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.Certificates.getById(java.lang.String)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.getById(String id)"
name: "getById(String id)"
nameWithType: "Certificates.getById(String id)"
summary: "Get the certificate."
modifiers:
- "abstract"
parameters:
- description: "the resource ID."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract CertificateDescription getById(String id)"
desc: "Get the certificate.\n\nReturns the certificate."
returns:
description: "the X509 Certificate along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.CertificateDescription?alt=com.azure.resourcemanager.iothub.models.CertificateDescription&text=CertificateDescription\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.Certificates.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.getByIdWithResponse(String id, Context context)"
name: "getByIdWithResponse(String id, Context context)"
nameWithType: "Certificates.getByIdWithResponse(String id, Context context)"
summary: "Get the certificate."
modifiers:
- "abstract"
parameters:
- description: "the resource ID."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<CertificateDescription> getByIdWithResponse(String id, Context context)"
desc: "Get the certificate.\n\nReturns the certificate."
returns:
description: "the X509 Certificate along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.iothub.models.CertificateDescription?alt=com.azure.resourcemanager.iothub.models.CertificateDescription&text=CertificateDescription\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iothub.models.Certificates.getWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.getWithResponse(String resourceGroupName, String resourceName, String certificateName, Context context)"
name: "getWithResponse(String resourceGroupName, String resourceName, String certificateName, Context context)"
nameWithType: "Certificates.getWithResponse(String resourceGroupName, String resourceName, String certificateName, Context context)"
summary: "Get the certificate."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT hub."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the IoT hub."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the certificate."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<CertificateDescription> getWithResponse(String resourceGroupName, String resourceName, String certificateName, Context context)"
desc: "Get the certificate.\n\nReturns the certificate."
returns:
description: "the X509 Certificate along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.iothub.models.CertificateDescription?alt=com.azure.resourcemanager.iothub.models.CertificateDescription&text=CertificateDescription\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iothub.models.Certificates.listByIotHub(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.listByIotHub(String resourceGroupName, String resourceName)"
name: "listByIotHub(String resourceGroupName, String resourceName)"
nameWithType: "Certificates.listByIotHub(String resourceGroupName, String resourceName)"
summary: "Get the certificate list."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT hub."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the IoT hub."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract CertificateListDescription listByIotHub(String resourceGroupName, String resourceName)"
desc: "Get the certificate list.\n\nReturns the list of certificates."
returns:
description: "the JSON-serialized array of Certificate objects."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.CertificateListDescription?alt=com.azure.resourcemanager.iothub.models.CertificateListDescription&text=CertificateListDescription\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.Certificates.listByIotHubWithResponse(java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.listByIotHubWithResponse(String resourceGroupName, String resourceName, Context context)"
name: "listByIotHubWithResponse(String resourceGroupName, String resourceName, Context context)"
nameWithType: "Certificates.listByIotHubWithResponse(String resourceGroupName, String resourceName, Context context)"
summary: "Get the certificate list."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT hub."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the IoT hub."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<CertificateListDescription> listByIotHubWithResponse(String resourceGroupName, String resourceName, Context context)"
desc: "Get the certificate list.\n\nReturns the list of certificates."
returns:
description: "the JSON-serialized array of Certificate objects along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.iothub.models.CertificateListDescription?alt=com.azure.resourcemanager.iothub.models.CertificateListDescription&text=CertificateListDescription\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iothub.models.Certificates.verify(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.iothub.models.CertificateVerificationDescription)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.verify(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody)"
name: "verify(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody)"
nameWithType: "Certificates.verify(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody)"
summary: "Verify certificate's private key possession."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT hub."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the IoT hub."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the certificate."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "ETag of the Certificate."
name: "ifMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the certificate."
name: "certificateVerificationBody"
type: "<xref href=\"com.azure.resourcemanager.iothub.models.CertificateVerificationDescription?alt=com.azure.resourcemanager.iothub.models.CertificateVerificationDescription&text=CertificateVerificationDescription\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract CertificateDescription verify(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody)"
desc: "Verify certificate's private key possession.\n\nVerifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate."
returns:
description: "the X509 Certificate."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.CertificateDescription?alt=com.azure.resourcemanager.iothub.models.CertificateDescription&text=CertificateDescription\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.Certificates.verifyWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.iothub.models.CertificateVerificationDescription,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iothub.models.Certificates.verifyWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody, Context context)"
name: "verifyWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody, Context context)"
nameWithType: "Certificates.verifyWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody, Context context)"
summary: "Verify certificate's private key possession."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT hub."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the IoT hub."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the certificate."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "ETag of the Certificate."
name: "ifMatch"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the certificate."
name: "certificateVerificationBody"
type: "<xref href=\"com.azure.resourcemanager.iothub.models.CertificateVerificationDescription?alt=com.azure.resourcemanager.iothub.models.CertificateVerificationDescription&text=CertificateVerificationDescription\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<CertificateDescription> verifyWithResponse(String resourceGroupName, String resourceName, String certificateName, String ifMatch, CertificateVerificationDescription certificateVerificationBody, Context context)"
desc: "Verify certificate's private key possession.\n\nVerifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate."
returns:
description: "the X509 Certificate along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.iothub.models.CertificateDescription?alt=com.azure.resourcemanager.iothub.models.CertificateDescription&text=CertificateDescription\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Resource collection API of Certificates."
metadata: {}
package: "com.azure.resourcemanager.iothub.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-iothub:1.2.0