Microsoft.ApiManagement service/certificates

11/04/2020
2 minutes to read

Template format

To create a Microsoft.ApiManagement/service/certificates resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.ApiManagement/service/certificates",
  "apiVersion": "2020-06-01-preview",
  "properties": {
    "data": "string",
    "password": "string",
    "keyVault": {
      "secretIdentifier": "string",
      "identityClientId": "string"
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.ApiManagement/service/certificates object

Name	Type	Required	Value
name	string	Yes	Identifier of the certificate entity. Must be unique in the current API Management service instance.
type	enum	Yes	certificates -or- Microsoft.ApiManagement/service/certificates See Set name and type for child resources.
apiVersion	enum	Yes	2020-06-01-preview
properties	object	Yes	Certificate create or update properties details. - CertificateCreateOrUpdateProperties object

CertificateCreateOrUpdateProperties object

Name	Type	Required	Value
data	string	No	Base 64 encoded certificate using the application/x-pkcs12 representation.
password	string	No	Password for the Certificate
keyVault	object	No	KeyVault location details of the certificate. - KeyVaultContractCreateProperties object

KeyVaultContractCreateProperties object

Name	Type	Required	Value
secretIdentifier	string	No	Key vault secret identifier for fetching secret.
identityClientId	string	No	SystemAssignedIdentity or UserAssignedIdentity Client Id which will be used to access key vault secret.

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create an API Management instance and all sub resources using template	This template demonstrates how to create a API Management service and configure sub-entities