Microsoft.ApiManagement service/certificates
The service/certificates resource type can be deployed to: Resource groups.
To learn about resource group deployments, see Bicep or ARM template.
Template format
To create a Microsoft.ApiManagement/service/certificates resource, add the following Bicep or JSON to your template.
resource symbolicname 'Microsoft.ApiManagement/service/certificates@2021-12-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
data: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
password: 'string'
}
}
Property values
service/certificates
Name | Description | Value |
---|---|---|
type | The resource type For Bicep, set this value in the resource declaration. |
'Microsoft.ApiManagement/service/certificates' |
apiVersion | The resource api version For Bicep, set this value in the resource declaration. |
'2021-12-01-preview' |
name | The resource name See how to set names and types for child resources in Bicep or JSON ARM templates. |
string (required) Character limit: 1-80 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: service |
properties | Certificate create or update properties details. | CertificateCreateOrUpdatePropertiesOrCertificateContractProperties |
CertificateCreateOrUpdatePropertiesOrCertificateContractProperties
Name | Description | Value |
---|---|---|
data | Base 64 encoded certificate using the application/x-pkcs12 representation. | string |
keyVault | KeyVault location details of the certificate. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
password | Password for the Certificate | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
Name | Description | Value |
---|---|---|
identityClientId | Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. | string |
secretIdentifier | Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi | string |
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 |