Share via

Microsoft.ApiManagement service/certificates

  • Article

Bicep resource definition

The service/certificates resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/certificates resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/certificates@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    data: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    password: 'string'
  }
}

Property values

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

Microsoft.ApiManagement/service/certificates

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[^*#&+:<>?]+$ (required)
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

ARM template resource definition

The service/certificates resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

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

Property values

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

Microsoft.ApiManagement/service/certificates

Name Description Value
apiVersion The api version '2024-06-01-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[^*#&+:<>?]+$ (required)
properties Certificate create or update properties details. CertificateCreateOrUpdatePropertiesOrCertificateContractProperties
type The resource type 'Microsoft.ApiManagement/service/certificates'

Terraform (AzAPI provider) resource definition

The service/certificates resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/certificates resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/certificates@2024-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      data = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      password = "string"
    }
  })
}

Property values

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

Microsoft.ApiManagement/service/certificates

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[^*#&+:<>?]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
properties Certificate create or update properties details. CertificateCreateOrUpdatePropertiesOrCertificateContractProperties
type The resource type "Microsoft.ApiManagement/service/certificates@2024-06-01-preview"