swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Certificates API schemes: - https tags: - name: Certificates paths: /certificates: get: operationId: microsoftAzureBatchListcertificates summary: Microsoft Azure Lists All Of The Certificates That Have Been Added To The Specified Account description: Lists all of the Certificates that have been added to the specified Account. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: maxresults in: query description: 'The maximum number of items to return in the response. A maximum of 1000 applications can be returned.' required: false type: integer format: int32 default: 1000 minimum: 1 maximum: 1000 - name: $filter in: query description: 'An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.' required: false type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchCertificateListResult' headers: ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' deprecated: true x-ms-examples: Certificate list: $ref: ./examples/CertificateList.json x-ms-pageable: nextLinkName: odata.nextLink tags: - Certificates post: operationId: microsoftAzureBatchCreatecertificate summary: Microsoft Azure Creates A Certificate To The Specified Account description: Creates a Certificate to the specified Account. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: certificate in: body description: The Certificate to be created. required: true schema: $ref: '#/definitions/BatchCertificate' responses: '201': description: The request has succeeded and a new resource has been created as a result. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' deprecated: true x-ms-examples: Certificate create: $ref: ./examples/CertificateCreate.json tags: - Certificates /certificates/{certificate-name}/create: post: operationId: Certificates_Create summary: Microsoft Azure Create a Certificate description: Creates a new certificate. If this is the first version, the certificate resource is created. This operation requires the certificates/create permission. tags: - Certificates parameters: - name: certificate-name in: path required: true description: The name of the certificate. schema: type: string pattern: ^[0-9a-zA-Z-]+$ example: example_value - $ref: '#/components/parameters/ApiVersionParameter' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CertificateCreateParameters' examples: CertificatesCreateRequestExample: summary: Default Certificates_Create request x-microcks-default: true value: policy: id: abc123 key_props: exportable: true kty: RSA key_size: 10 reuse_key: true crv: P-256 secret_props: contentType: example_value x509_props: subject: example_value sans: {} ekus: {} key_usage: {} validity_months: 10 issuer: name: Example Title cty: example_value lifetime_actions: - {} attributes: enabled: true nbf: 10 exp: 10 created: 10 updated: 10 recoveryLevel: example_value recoverableDays: 10 tags: example_value responses: '202': description: Accepted. The certificate create operation is pending. content: application/json: schema: $ref: '#/components/schemas/CertificateOperation' examples: CertificatesCreate202Example: summary: Default Certificates_Create 202 response x-microcks-default: true value: id: abc123 issuer: name: Example Title csr: example_value cancellation_requested: true status: example_value status_details: example_value error: code: example_value message: example_value target: example_value request_id: '500123' default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/KeyVaultError' examples: CertificatesCreatedefaultExample: summary: Default Certificates_Create default response x-microcks-default: true value: error: code: example_value message: example_value innererror: code: example_value innererror: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates : get: operationId: microsoftAzureCertificatesListbycatalog tags: - Certificates description: List Certificate resources by Catalog parameters: - $ref: '#/parameters/CustomFilterQueryParameter' - $ref: '#/parameters/CustomTopQueryParameter' - $ref: '#/parameters/CustomSkipQueryParameter' - $ref: '#/parameters/CustomMaxPageSizeQueryParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: catalogName in: path description: Name of catalog required: true type: string pattern: ^[A-Za-z0-9_-]{1,50}$ responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/CertificateListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Certificates_ListByCatalog: $ref: ./examples/GetCertificates.json x-ms-pageable: nextLinkName: nextLink summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Certificates ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber} : get: operationId: microsoftAzureCertificatesGet tags: - Certificates description: Get a Certificate parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: catalogName in: path description: Name of catalog required: true type: string pattern: ^[A-Za-z0-9_-]{1,50}$ - name: serialNumber in: path description: Serial number of the certificate. Use '.default' to get current active certificate. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/Certificate' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Certificates_Get: $ref: ./examples/GetCertificate.json summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Certificates Serialnumber ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveCertChain : post: operationId: microsoftAzureCertificatesRetrievecertchain tags: - Certificates description: Retrieves cert chain. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: catalogName in: path description: Name of catalog required: true type: string pattern: ^[A-Za-z0-9_-]{1,50}$ - name: serialNumber in: path description: Serial number of the certificate. Use '.default' to get current active certificate. required: true type: string responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/CertificateChainResponse' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Certificates_RetrieveCertChain: $ref: ./examples/PostRetrieveCatalogCertChain.json summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Certificates Serialnumber Retrievecertchain ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveProofOfPossessionNonce : post: operationId: microsoftAzureCertificatesRetrieveproofofpossessionnonce tags: - Certificates description: Gets the proof of possession nonce. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: catalogName in: path description: Name of catalog required: true type: string pattern: ^[A-Za-z0-9_-]{1,50}$ - name: serialNumber in: path description: Serial number of the certificate. Use '.default' to get current active certificate. required: true type: string - name: proofOfPossessionNonceRequest in: body description: 'Proof of possession nonce request body ' required: true schema: $ref: '#/definitions/ProofOfPossessionNonceRequest' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/ProofOfPossessionNonceResponse' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Certificates_RetrieveProofOfPossessionNonce: $ref: ./examples/PostRetrieveProofOfPossessionNonce.json summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Certificates Serialnumber Retrieveproofofpossessionnonce /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete: post: tags: - Certificates operationId: microsoftAzureCertificateCanceldeletion x-ms-examples: Certificate cancel delete: $ref: ./examples/CertificateCancelDelete.json summary: Microsoft Azure Cancels A Failed Deletion Of A Certificate From The Specified Account description: If you try to delete a Certificate that is being used by a Pool or Compute Node, the status of the Certificate changes to deleteFailed. If you decide that you want to continue using the Certificate, you can use this operation to set the status of the Certificate back to active. If you intend to delete the Certificate, you do not need to run this operation after the deletion failed. You must make sure that the Certificate is not being used by any resources, and then you can try again to delete the Certificate. x-ms-request-id: request-id parameters: - name: thumbprintAlgorithm in: path required: true type: string description: The algorithm used to derive the thumbprint parameter. This must be sha1. - name: thumbprint in: path required: true type: string description: The thumbprint of the Certificate being deleted. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '204': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError_2' /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint}): delete: tags: - Certificates operationId: microsoftAzureCertificateDelete x-ms-examples: Certificate delete: $ref: ./examples/CertificateDelete.json summary: Microsoft Azure Deletes A Certificate From The Specified Account description: You cannot delete a Certificate if a resource (Pool or Compute Node) is using it. Before you can delete a Certificate, you must therefore make sure that the Certificate is not associated with any existing Pools, the Certificate is not installed on any Nodes (even if you remove a Certificate from a Pool, it is not removed from existing Compute Nodes in that Pool until they restart), and no running Tasks depend on the Certificate. If you try to delete a Certificate that is in use, the deletion fails. The Certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the Certificate. x-ms-request-id: request-id parameters: - name: thumbprintAlgorithm in: path required: true type: string description: The algorithm used to derive the thumbprint parameter. This must be sha1. - name: thumbprint in: path required: true type: string description: The thumbprint of the Certificate to be deleted. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '202': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError_2' get: tags: - Certificates operationId: microsoftAzureCertificateGet x-ms-examples: Certificate get: $ref: ./examples/CertificateGet.json description: Gets information about the specified Certificate. x-ms-request-id: request-id parameters: - name: thumbprintAlgorithm in: path required: true type: string description: The algorithm used to derive the thumbprint parameter. This must be sha1. - name: thumbprint in: path required: true type: string description: The thumbprint of the Certificate to get. - name: $select in: query required: false type: string description: An OData $select clause. x-ms-parameter-grouping: postfix: Options - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: A response containing the Certificate. schema: $ref: '#/definitions/Certificate_2' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError_2' summary: Microsoft Azure Get Certificates Thumbprintalgorithm Thumbprintalgorithm,thumbprint Thumbprint /subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates: get: tags: - Certificates summary: Microsoft Azure Get All Certificates For A Subscription description: Description for Get all certificates for a subscription. operationId: microsoftAzureCertificatesList parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' - name: $filter in: query description: 'Return only information specified in the filter (using OData syntax). For example: $filter=KeyVaultId eq ''KeyVaultId''' type: string x-ms-skip-url-encoding: true responses: '200': description: OK schema: $ref: '#/definitions/CertificateCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List Certificates for subscription: $ref: ./examples/ListCertificates.json x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates: get: tags: - Certificates summary: Microsoft Azure Get All Certificates In A Resource Group description: Description for Get all certificates in a resource group. operationId: microsoftAzureCertificatesListbyresourcegroup parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: '#/definitions/CertificateCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List Certificates by resource group: $ref: ./examples/ListCertificatesByResourceGroup.json x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}: get: tags: - Certificates summary: Microsoft Azure Get A Certificate description: Description for Get a certificate. operationId: microsoftAzureCertificatesGet parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the certificate. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Certificate_4' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get Certificate: $ref: ./examples/GetCertificate.json put: tags: - Certificates summary: Microsoft Azure Create Or Update A Certificate description: Description for Create or update a certificate. operationId: microsoftAzureCertificatesCreateorupdate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the certificate. required: true type: string - name: certificateEnvelope in: body description: Details of certificate, if it exists already. required: true schema: $ref: '#/definitions/Certificate_4' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: '#/definitions/Certificate_4' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Create Or Update Certificate: $ref: ./examples/CreateOrUpdateCertificate.json delete: tags: - Certificates summary: Microsoft Azure Delete A Certificate description: Description for Delete a certificate. operationId: microsoftAzureCertificatesDelete parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the certificate. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted certificate. '204': description: Certificate does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Delete Certificate: $ref: ./examples/DeleteCertificate.json patch: tags: - Certificates summary: Microsoft Azure Create Or Update A Certificate description: Description for Create or update a certificate. operationId: microsoftAzureCertificatesUpdate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the certificate. required: true type: string - name: certificateEnvelope in: body description: Details of certificate, if it exists already. required: true schema: $ref: '#/definitions/CertificatePatchResource' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: '#/definitions/Certificate_4' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Patch Certificate: $ref: ./examples/PatchCertificate.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates : get: tags: - Certificates summary: Microsoft Azure Get The Certificate List description: Returns the list of certificates. operationId: microsoftAzureCertificatesListbyiothub x-ms-examples: Certificates_ListByIotHub: $ref: ./examples/iothub_listcertificates.json parameters: - $ref: '#/parameters/api-version' - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/resourceName' responses: '200': description: The body contains all the certificate list. schema: $ref: '#/definitions/CertificateListDescription' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorDetails' deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName} : get: tags: - Certificates summary: Microsoft Azure Get The Certificate description: Returns the certificate. operationId: microsoftAzureCertificatesGet x-ms-examples: Certificates_Get: $ref: ./examples/iothub_getcertificate.json parameters: - $ref: '#/parameters/api-version' - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/resourceName' - $ref: '#/parameters/certificateName' responses: '200': description: The body contains the certificate. schema: $ref: '#/definitions/CertificateDescription' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorDetails' deprecated: false put: tags: - Certificates summary: Microsoft Azure Upload The Certificate To The Iot Hub description: Adds new or replaces existing certificate. operationId: microsoftAzureCertificatesCreateorupdate x-ms-examples: Certificates_CreateOrUpdate: $ref: ./examples/iothub_certificatescreateorupdate.json parameters: - $ref: '#/parameters/api-version' - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/resourceName' - $ref: '#/parameters/certificateName' - name: certificateDescription in: body description: The certificate body. required: true schema: $ref: '#/definitions/CertificateDescription' - name: If-Match in: header required: false type: string description: ETag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate. responses: '200': description: If certificate already exist and update was successful, the operation returns HTTP status code of 201 (OK). schema: $ref: '#/definitions/CertificateDescription' '201': description: If certificate didn't exist creation was successful, the operation returns HTTP status code of 201 (OK). schema: $ref: '#/definitions/CertificateDescription' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorDetails' deprecated: false delete: tags: - Certificates summary: Microsoft Azure Delete An X509 Certificate description: Deletes an existing X509 certificate or does nothing if it does not exist. operationId: microsoftAzureCertificatesDelete x-ms-examples: Certificates_Delete: $ref: ./examples/iothub_certificatesdelete.json parameters: - $ref: '#/parameters/api-version' - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/resourceName' - $ref: '#/parameters/certificateName' - name: If-Match in: header required: true type: string description: ETag of the Certificate. responses: '200': description: Certificate has been deleted. '204': description: Certificate does not exist. default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorDetails' deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/generateVerificationCode : post: tags: - Certificates summary: Microsoft Azure Generate Verification Code For Proof Of Possession Flow description: Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate. operationId: microsoftAzureCertificatesGenerateverificationcode x-ms-examples: Certificates_GenerateVerificationCode: $ref: ./examples/iothub_generateverificationcode.json parameters: - $ref: '#/parameters/api-version' - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/resourceName' - $ref: '#/parameters/certificateName' - name: If-Match in: header required: true type: string description: ETag of the Certificate. responses: '200': description: The body contains the certificate. schema: $ref: '#/definitions/CertificateWithNonceDescription' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorDetails' deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/verify : post: tags: - Certificates summary: Microsoft Azure Verify Certificate S Private Key Possession description: Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate. operationId: microsoftAzureCertificatesVerify x-ms-examples: Certificates_Verify: $ref: ./examples/iothub_certverify.json parameters: - $ref: '#/parameters/api-version' - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/resourceName' - $ref: '#/parameters/certificateName' - name: certificateVerificationBody in: body description: The name of the certificate required: true schema: $ref: '#/definitions/CertificateVerificationDescription' - name: If-Match in: header required: true type: string description: ETag of the Certificate. responses: '200': description: The body contains the certificate. schema: $ref: '#/definitions/CertificateDescription' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorDetails' deprecated: false /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs: get: tags: - Certificates summary: Microsoft Azure Gets The Certificate Signing Requests For A Subscription In The Specified Resource Group operationId: microsoftAzureCertificatesGetcsrs consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/Csr' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}: get: tags: - Certificates summary: Microsoft Azure Gets A Certificate Signing Request By Certificate Name For A Subscription In The Specified Resource Group operationId: microsoftAzureCertificatesGetcsr consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the certificate. required: true type: string - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/Csr' deprecated: false description: Needs a more full description created. put: tags: - Certificates summary: Microsoft Azure Creates Or Modifies An Existing Certificate Signing Request operationId: microsoftAzureCertificatesCreateorupdatecsr consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the certificate. required: true type: string - name: csrEnvelope in: body description: Details of certificate signing request if it exists already. required: true schema: $ref: '#/definitions/Csr' - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/Csr' deprecated: false description: Needs a more full description created. delete: tags: - Certificates summary: Microsoft Azure Delete The Certificate Signing Request operationId: microsoftAzureCertificatesDeletecsr consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the certificate signing request. required: true type: string - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. patch: tags: - Certificates summary: Microsoft Azure Creates Or Modifies An Existing Certificate Signing Request operationId: microsoftAzureCertificatesUpdatecsr consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the certificate. required: true type: string - name: csrEnvelope in: body description: Details of certificate signing request if it exists already. required: true schema: $ref: '#/definitions/Csr' - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/Csr' deprecated: false description: Needs a more full description created. components: schemas: KeyVaultError: type: object description: The key vault error exception. properties: error: type: object readOnly: true description: The key vault server error. properties: code: type: string readOnly: true description: The error code. message: type: string readOnly: true description: The error message. innererror: type: object readOnly: true description: Inner error details. properties: code: type: string readOnly: true innererror: type: object readOnly: true example: example_value CertificatePolicy: type: object description: Management policy for a certificate. properties: id: type: string readOnly: true example: abc123 key_props: type: object description: Properties of the key pair. properties: exportable: type: boolean kty: type: string enum: - RSA - RSA-HSM - EC - EC-HSM key_size: type: integer reuse_key: type: boolean crv: type: string enum: - P-256 - P-384 - P-521 - P-256K example: example_value secret_props: type: object description: Properties of the secret backing a certificate. properties: contentType: type: string example: example_value x509_props: type: object description: Properties of the X509 component. properties: subject: type: string sans: type: object properties: emails: type: array items: type: string dns_names: type: array items: type: string upns: type: array items: type: string ekus: type: array items: type: string key_usage: type: array items: type: string validity_months: type: integer example: example_value issuer: type: object description: Parameters for the issuer of the X509 component. properties: name: type: string description: Name of the referenced issuer object or reserved names (Self, Unknown). cty: type: string description: Certificate type as supported by the provider. example: example_value attributes: $ref: '#/components/schemas/CertificateAttributes' lifetime_actions: type: array items: type: object properties: trigger: type: object properties: lifetime_percentage: type: integer days_before_expiry: type: integer action: type: object properties: action_type: type: string enum: - EmailContacts - AutoRenew example: [] CertificateCreateParameters: type: object description: The certificate create parameters. properties: policy: $ref: '#/components/schemas/CertificatePolicy' attributes: $ref: '#/components/schemas/CertificateAttributes' tags: type: object additionalProperties: type: string example: example_value CertificateAttributes: type: object description: The certificate management attributes. properties: enabled: type: boolean example: true nbf: type: integer example: 10 exp: type: integer example: 10 created: type: integer readOnly: true example: 10 updated: type: integer readOnly: true example: 10 recoveryLevel: type: string readOnly: true example: example_value recoverableDays: type: integer readOnly: true example: 10 CertificateOperation: type: object description: A certificate operation is returned in case of asynchronous requests. properties: id: type: string readOnly: true example: abc123 issuer: type: object properties: name: type: string example: example_value csr: type: string description: The certificate signing request (CSR) in base64. example: example_value cancellation_requested: type: boolean example: true status: type: string example: example_value status_details: type: string example: example_value error: type: object properties: code: type: string message: type: string example: example_value target: type: string example: example_value request_id: type: string example: '500123' parameters: ApiVersionParameter: name: api-version in: query required: true description: Client API version. schema: type: string default: '7.5' definitions: ErrorMessage: properties: lang: type: string title: The language code of the error message value: type: string title: The text of the message. title: An error message received in an Azure Batch error response. CertificateChainResponse: type: object description: The certificate chain response. properties: certificateChain: type: string description: The certificate chain. readOnly: true CertificatePatchResource: description: ARM resource for a certificate. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: CertificatePatchResource resource specific properties type: object properties: password: description: Certificate password. type: string x-ms-mutability: - create friendlyName: description: Friendly name of the certificate. type: string readOnly: true subjectName: description: Subject name of the certificate. type: string readOnly: true hostNames: description: Host names the certificate applies to. type: array items: type: string pfxBlob: format: byte description: Pfx blob. type: string siteName: description: App name. type: string readOnly: true selfLink: description: Self link. type: string readOnly: true issuer: description: Certificate issuer. type: string readOnly: true issueDate: format: date-time description: Certificate issue Date. type: string readOnly: true expirationDate: format: date-time description: Certificate expiration date. type: string readOnly: true thumbprint: description: Certificate thumbprint. type: string readOnly: true valid: description: Is the certificate valid?. type: boolean readOnly: true cerBlob: format: byte description: Raw bytes of .cer file type: string readOnly: true publicKeyHash: description: Public key hash. type: string readOnly: true hostingEnvironmentProfile: $ref: ./CommonDefinitions.json#/definitions/HostingEnvironmentProfile description: Specification for the App Service Environment to use for the certificate. readOnly: true keyVaultId: description: Key Vault Csm resource Id. type: string keyVaultSecretName: description: Key Vault secret name. type: string keyVaultSecretStatus: description: Status of the Key Vault secret. enum: - Initialized - WaitingOnCertificateOrder - Succeeded - CertificateOrderFailed - OperationNotPermittedOnKeyVault - AzureServiceUnauthorizedToAccessKeyVault - KeyVaultDoesNotExist - KeyVaultSecretDoesNotExist - UnknownError - ExternalPrivateKey - Unknown type: string readOnly: true x-ms-enum: name: KeyVaultSecretStatus modelAsString: false serverFarmId: description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".' type: string canonicalName: description: CNAME of the certificate to be issued via free certificate type: string domainValidationMethod: description: Method of domain validation for free cert type: string x-ms-client-flatten: true DeleteCertificateError: properties: code: type: string title: An identifier for the Certificate deletion error. Codes are invariant and are intended to be consumed programmatically. message: type: string title: A message describing the Certificate deletion error, intended to be suitable for display in a user interface. values: type: array items: $ref: '#/definitions/NameValuePair_2' title: A list of additional error details related to the Certificate deletion error. description: This list includes details such as the active Pools and Compute Nodes referencing this Certificate. However, if a large number of resources reference the Certificate, the list contains only about the first hundred. title: An error encountered by the Batch service when deleting a Certificate. ErrorDetails: description: Error details. type: object properties: code: description: The error code. type: string readOnly: true httpStatusCode: description: The HTTP status code. type: string readOnly: true message: description: The error message. type: string readOnly: true details: description: The error details. type: string readOnly: true CertificateListResult: type: object description: The response of a Certificate list operation. properties: value: type: array description: The Certificate items on this page items: $ref: '#/definitions/Certificate' nextLink: type: string format: uri description: The link to the next page of items readOnly: true required: - value BatchErrorDetail_2: properties: key: type: string title: An identifier specifying the meaning of the Value property. value: type: string title: The additional information included with the error response. title: An item of additional information included in an Azure Batch error response. CertificateDescription: description: The X509 Certificate. type: object properties: properties: $ref: '#/definitions/CertificateProperties_2' id: readOnly: true type: string description: The resource identifier. name: description: The name of the certificate. type: string readOnly: true etag: description: The entity tag. type: string readOnly: true type: readOnly: true type: string description: The resource type. x-ms-azure-resource: true ProofOfPossessionNonceResponse: type: object description: Result of the action to generate a proof of possession nonce allOf: - $ref: '#/definitions/CertificateProperties' CertificateProperties: type: object description: The properties of certificate properties: certificate: type: string description: The certificate as a UTF-8 encoded base 64 string. readOnly: true status: $ref: '#/definitions/CertificateStatus' description: The certificate status. readOnly: true subject: type: string description: The certificate subject. readOnly: true thumbprint: type: string description: The certificate thumbprint. readOnly: true expiryUtc: type: string format: date-time description: The certificate expiry date. readOnly: true notBeforeUtc: type: string format: date-time description: The certificate not before date. readOnly: true provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. readOnly: true BatchError_2: properties: code: type: string title: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: $ref: '#/definitions/ErrorMessage' title: A message describing the error, intended to be suitable for display in a user interface. values: type: array items: $ref: '#/definitions/BatchErrorDetail_2' title: A collection of key-value pairs containing additional details about the error. title: An error response received from the Azure Batch service. Resource: required: - location properties: id: description: Resource Id type: string name: description: Resource Name type: string kind: description: Kind of resource type: string location: description: Resource Location type: string type: description: Resource type type: string tags: description: Resource tags type: object additionalProperties: type: string x-ms-azure-resource: true CertificateProperties_2: description: The description of an X509 CA Certificate. type: object properties: subject: description: The certificate's subject name. type: string readOnly: true expiry: description: The certificate's expiration date and time. type: string format: date-time-rfc1123 readOnly: true thumbprint: description: The certificate's thumbprint. type: string readOnly: true isVerified: description: Determines whether certificate has been verified. type: boolean created: description: The certificate's create date and time. type: string format: date-time-rfc1123 readOnly: true updated: description: The certificate's last update date and time. type: string format: date-time-rfc1123 readOnly: true certificate: description: The certificate content type: string CertificateListDescription: description: The JSON-serialized array of Certificate objects. type: object properties: value: description: The array of Certificate objects. type: array items: $ref: '#/definitions/CertificateDescription' BatchError: type: object description: An error response received from the Azure Batch service. properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: $ref: '#/definitions/BatchErrorMessage' description: A message describing the error, intended to be suitable for display in a user interface. values: type: array description: A collection of key-value pairs containing additional details about the error. items: $ref: '#/definitions/BatchErrorDetail' x-ms-identifiers: [] required: - code BatchCertificateState: type: string description: BatchCertificateState enums enum: - active - deleting - deletefailed x-ms-enum: name: BatchCertificateState modelAsString: true values: - name: Active value: active description: The Certificate is available for use in Pools. - name: Deleting value: deleting description: The user has requested that the Certificate be deleted, but the delete operation has not yet completed. You may not reference the Certificate when creating or updating Pools. - name: DeleteFailed value: deletefailed description: The user requested that the Certificate be deleted, but there are Pools that still have references to the Certificate, or it is still installed on one or more Nodes. (The latter can occur if the Certificate has been removed from the Pool, but the Compute Node has not yet restarted. Compute Nodes refresh their Certificates only when they restart.) You may use the cancel Certificate delete operation to cancel the delete, or the delete Certificate operation to retry the delete. BatchErrorMessage: type: object description: An error message received in an Azure Batch error response. properties: lang: type: string description: The language code of the error message. value: type: string description: The text of the message. CertificateCollection: description: Collection of certificates. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/Certificate_4' nextLink: description: Link to next page of resources. type: string readOnly: true Csr: description: Certificate signing request object type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: Name used to locate CSR object type: string distinguishedName: description: Distinguished name of certificate to be created type: string csrString: description: Actual CSR string created type: string pfxBlob: description: PFX certificate of created certificate type: string password: description: PFX password type: string publicKeyHash: description: Hash of the certificates public key type: string hostingEnvironment: description: Hosting environment type: string x-ms-client-flatten: true CertificateVerificationDescription: description: The JSON-serialized leaf certificate type: object properties: certificate: description: base-64 representation of X509 certificate .cer file or just .pem file content. type: string CertificateStatus: type: string description: Certificate status values. enum: - Active - Inactive - Expired - Revoked x-ms-enum: name: CertificateStatus modelAsString: true values: - name: Active value: Active description: Certificate is active - name: Inactive value: Inactive description: Certificate is inactive - name: Expired value: Expired description: Certificate has expired - name: Revoked value: Revoked description: Certificate has been revoked CertificatePropertiesWithNonce: description: The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow. type: object properties: subject: description: The certificate's subject name. type: string readOnly: true expiry: description: The certificate's expiration date and time. type: string format: date-time-rfc1123 readOnly: true thumbprint: description: The certificate's thumbprint. type: string readOnly: true isVerified: description: Determines whether certificate has been verified. type: boolean readOnly: true created: description: The certificate's create date and time. type: string format: date-time-rfc1123 readOnly: true updated: description: The certificate's last update date and time. type: string format: date-time-rfc1123 readOnly: true verificationCode: description: The certificate's verification code that will be used for proof of possession. type: string readOnly: true certificate: description: The certificate content type: string readOnly: true CertificateState: type: string title: The state of the Certificate. enum: - active - deleting - deletefailed x-ms-enum: name: CertificateState modelAsString: false values: - value: active description: The Certificate is available for use in Pools. - value: deleting description: The user has requested that the Certificate be deleted, but the delete operation has not yet completed. You may not reference the Certificate when creating or updating Pools. - value: deletefailed description: The user requested that the Certificate be deleted, but there are Pools that still have references to the Certificate, or it is still installed on one or more Nodes. (The latter can occur if the Certificate has been removed from the Pool, but the Compute Node has not yet restarted. Compute Nodes refresh their Certificates only when they restart.) You may use the cancel Certificate delete operation to cancel the delete, or the delete Certificate operation to retry the delete. name: deleteFailed CertificateWithNonceDescription: description: The X509 Certificate. type: object properties: properties: $ref: '#/definitions/CertificatePropertiesWithNonce' id: readOnly: true type: string description: The resource identifier. name: description: The name of the certificate. type: string readOnly: true etag: description: The entity tag. type: string readOnly: true type: readOnly: true type: string description: The resource type. x-ms-azure-resource: true Certificate_2: properties: thumbprint: type: string title: The X.509 thumbprint of the Certificate. This is a sequence of up to 40 hex digits. thumbprintAlgorithm: type: string title: The algorithm used to derive the thumbprint. url: type: string title: The URL of the Certificate. state: title: The current state of the Certificate. $ref: '#/definitions/CertificateState' stateTransitionTime: type: string format: date-time title: The time at which the Certificate entered its current state. previousState: title: The previous state of the Certificate. description: This property is not set if the Certificate is in its initial active state. $ref: '#/definitions/CertificateState' previousStateTransitionTime: type: string format: date-time title: The time at which the Certificate entered its previous state. description: This property is not set if the Certificate is in its initial Active state. publicData: type: string title: The public part of the Certificate as a base-64 encoded .cer file. deleteCertificateError: $ref: '#/definitions/DeleteCertificateError' title: The error that occurred on the last attempt to delete this Certificate. description: This property is set only if the Certificate is in the DeleteFailed state. description: A Certificate that can be installed on Compute Nodes and can be used to authenticate operations on the machine. Certificate: type: object description: An certificate resource belonging to a catalog resource. properties: properties: $ref: '#/definitions/CertificateProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource NameValuePair_2: properties: name: type: string title: The name in the name-value pair. value: type: string title: The value in the name-value pair. title: Represents a name-value pair. Certificate_4: description: SSL certificate for an app. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/Resource properties: properties: description: Certificate resource specific properties type: object properties: password: description: Certificate password. type: string x-ms-mutability: - create friendlyName: description: Friendly name of the certificate. type: string readOnly: true subjectName: description: Subject name of the certificate. type: string readOnly: true hostNames: description: Host names the certificate applies to. type: array items: type: string pfxBlob: format: byte description: Pfx blob. type: string siteName: description: App name. type: string readOnly: true selfLink: description: Self link. type: string readOnly: true issuer: description: Certificate issuer. type: string readOnly: true issueDate: format: date-time description: Certificate issue Date. type: string readOnly: true expirationDate: format: date-time description: Certificate expiration date. type: string readOnly: true thumbprint: description: Certificate thumbprint. type: string readOnly: true valid: description: Is the certificate valid?. type: boolean readOnly: true cerBlob: format: byte description: Raw bytes of .cer file type: string readOnly: true publicKeyHash: description: Public key hash. type: string readOnly: true hostingEnvironmentProfile: $ref: ./CommonDefinitions.json#/definitions/HostingEnvironmentProfile description: Specification for the App Service Environment to use for the certificate. readOnly: true keyVaultId: description: Key Vault Csm resource Id. type: string keyVaultSecretName: description: Key Vault secret name. type: string keyVaultSecretStatus: description: Status of the Key Vault secret. enum: - Initialized - WaitingOnCertificateOrder - Succeeded - CertificateOrderFailed - OperationNotPermittedOnKeyVault - AzureServiceUnauthorizedToAccessKeyVault - KeyVaultDoesNotExist - KeyVaultSecretDoesNotExist - UnknownError - ExternalPrivateKey - Unknown type: string readOnly: true x-ms-enum: name: KeyVaultSecretStatus modelAsString: false serverFarmId: description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".' type: string canonicalName: description: CNAME of the certificate to be issued via free certificate type: string domainValidationMethod: description: Method of domain validation for free cert type: string x-ms-client-flatten: true ProvisioningState: type: string description: Provisioning state of resource. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. - name: Provisioning value: Provisioning description: The resource is being provisioned - name: Updating value: Updating description: The resource is being updated - name: Deleting value: Deleting description: The resource is being deleted - name: Accepted value: Accepted description: The resource create request has been accepted NameValuePair: type: object description: Represents a name-value pair. properties: name: type: string description: The name in the name-value pair. value: type: string description: The value in the name-value pair. BatchCertificateListResult: type: object description: The result of listing the Certificates in the Account. properties: value: type: array description: The list of Certificates. items: $ref: '#/definitions/BatchCertificate' x-ms-identifiers: [] odata.nextLink: type: string description: The URL to get the next set of results. DeleteBatchCertificateError: type: object description: An error encountered by the Batch service when deleting a Certificate. properties: code: type: string description: An identifier for the Certificate deletion error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the Certificate deletion error, intended to be suitable for display in a user interface. values: type: array description: A list of additional error details related to the Certificate deletion error. This list includes details such as the active Pools and Compute Nodes referencing this Certificate. However, if a large number of resources reference the Certificate, the list contains only about the first hundred. items: $ref: '#/definitions/NameValuePair' x-ms-identifiers: [] Object: type: object properties: {} BatchCertificate: type: object description: 'A Certificate that can be installed on Compute Nodes and can be used to authenticate operations on the machine.' properties: thumbprint: type: string description: The X.509 thumbprint of the Certificate. This is a sequence of up to 40 hex digits (it may include spaces but these are removed). thumbprintAlgorithm: type: string description: The algorithm used to derive the thumbprint. This must be sha1. url: type: string description: The URL of the Certificate. readOnly: true state: $ref: '#/definitions/BatchCertificateState' description: The state of the Certificate. readOnly: true stateTransitionTime: type: string format: date-time description: The time at which the Certificate entered its current state. readOnly: true previousState: $ref: '#/definitions/BatchCertificateState' description: The previous state of the Certificate. This property is not set if the Certificate is in its initial active state. readOnly: true previousStateTransitionTime: type: string format: date-time description: The time at which the Certificate entered its previous state. This property is not set if the Certificate is in its initial Active state. readOnly: true publicData: type: string description: The public part of the Certificate as a base-64 encoded .cer file. readOnly: true deleteCertificateError: $ref: '#/definitions/DeleteBatchCertificateError' description: The error that occurred on the last attempt to delete this Certificate. This property is set only if the Certificate is in the DeleteFailed state. readOnly: true data: type: string description: The base64-encoded contents of the Certificate. The maximum size is 10KB. x-ms-mutability: - create certificateFormat: $ref: '#/definitions/BatchCertificateFormat' description: The format of the Certificate data. x-ms-mutability: - create password: type: string description: The password to access the Certificate's private key. This must be omitted if the Certificate format is cer. x-ms-mutability: - create required: - thumbprint - thumbprintAlgorithm - data ProofOfPossessionNonceRequest: type: object description: Request for the proof of possession nonce properties: proofOfPossessionNonce: type: string description: The proof of possession nonce required: - proofOfPossessionNonce BatchErrorDetail: type: object description: An item of additional information included in an Azure Batch error response. properties: key: type: string description: An identifier specifying the meaning of the Value property. value: type: string description: The additional information included with the error response. BatchCertificateFormat: type: string description: BatchCertificateFormat enums enum: - pfx - cer x-ms-enum: name: BatchCertificateFormat modelAsString: true values: - name: Pfx value: pfx description: The Certificate is a PFX (PKCS#12) formatted Certificate or Certificate chain. - name: Cer value: cer description: The Certificate is a base64-encoded X.509 Certificate. parameters: resourceName: name: resourceName in: path description: The name of the IoT hub. required: true type: string x-ms-parameter-location: method ApiVersionParameter: name: api-version in: query required: true type: string description: Client API Version. resourceGroupNameParameter: name: resourceGroupName in: path description: Name of the resource group to which the resource belongs. required: true type: string maxLength: 90 minLength: 1 pattern: ^[-\w\._\(\)]+[^\.]$ x-ms-parameter-location: method resourceGroupName: name: resourceGroupName description: The name of the resource group that contains the IoT hub. in: path required: true type: string x-ms-parameter-location: method api-version: name: api-version in: query description: The version of the API. required: true type: string CustomSkipQueryParameter: name: $skip in: query description: The number of result items to skip. required: false type: integer format: int32 x-ms-parameter-location: method x-ms-client-name: skip certificateName: name: certificateName in: path description: The name of the certificate required: true type: string pattern: ^[A-Za-z0-9-._]{1,64}$ x-ms-parameter-location: method apiVersionParameter_2: name: api-version in: query description: API Version required: true type: string subscriptionId: name: subscriptionId in: path description: The subscription identifier. required: true type: string subscriptionIdParameter_2: name: subscriptionId in: path description: Subscription Id required: true type: string apiVersionParameter: name: api-version in: query description: API Version required: true type: string x-ms-parameter-location: client CustomTopQueryParameter: name: $top in: query description: The number of result items to return. required: false type: integer format: int32 x-ms-parameter-location: method x-ms-client-name: top CustomMaxPageSizeQueryParameter: name: $maxpagesize in: query description: The maximum number of result items per page. required: false type: integer format: int32 x-ms-parameter-location: method x-ms-client-name: maxpagesize subscriptionIdParameter: name: subscriptionId in: path description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). required: true type: string x-ms-parameter-location: client Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion CustomFilterQueryParameter: name: $filter in: query description: Filter the result list using the given expression required: false type: string x-ms-parameter-location: method x-ms-client-name: filter x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'