Partilhar via

Serviço/certificados Microsoft.ApiManagement

  • Artigo

Definição de recursos do bíceps

O tipo de recurso serviço/certificados pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/certificates, adicione o seguinte Bíceps ao seu modelo.

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

Valores de propriedade

CertificateCreateOrUpdatePropertiesOrCertificateContractProperties

Designação Descrição Valor
dados Certificado codificado Base 64 usando a representação application/x-pkcs12. string
keyVault [en] Detalhes do local do KeyVault do certificado. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
palavra-passe Senha para o certificado string

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

Designação Descrição Valor
identityClientId Nulo para SystemAssignedIdentity ou ID do Cliente para UserAssignedIdentity , que será usado para acessar o segredo do cofre de chaves. string
secretIdentifier Identificador secreto do cofre de chaves para buscar segredo. Fornecer um segredo versionado impedirá a atualização automática. Isso requer que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi string

Microsoft.ApiManagement/serviço/certificados

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para recurso do tipo: serviço
propriedades Detalhes das propriedades de criação ou atualização de certificados. CertificateCreateOrUpdatePropertiesOrCertificateContractProperties

Definição de recurso de modelo ARM

O tipo de recurso serviço/certificados pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/certificates, adicione o seguinte JSON ao seu modelo.

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

Valores de propriedade

CertificateCreateOrUpdatePropertiesOrCertificateContractProperties

Designação Descrição Valor
dados Certificado codificado Base 64 usando a representação application/x-pkcs12. string
keyVault [en] Detalhes do local do KeyVault do certificado. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
palavra-passe Senha para o certificado string

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

Designação Descrição Valor
identityClientId Nulo para SystemAssignedIdentity ou ID do Cliente para UserAssignedIdentity , que será usado para acessar o segredo do cofre de chaves. string
secretIdentifier Identificador secreto do cofre de chaves para buscar segredo. Fornecer um segredo versionado impedirá a atualização automática. Isso requer que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi string

Microsoft.ApiManagement/serviço/certificados

Designação Descrição Valor
apiVersion A versão api '2024-06-01-pré-visualização'
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
propriedades Detalhes das propriedades de criação ou atualização de certificados. CertificateCreateOrUpdatePropertiesOrCertificateContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/certificates'

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso serviço/certificados pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/certificates, adicione o seguinte Terraform ao seu modelo.

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"
    }
  })
}

Valores de propriedade

CertificateCreateOrUpdatePropertiesOrCertificateContractProperties

Designação Descrição Valor
dados Certificado codificado Base 64 usando a representação application/x-pkcs12. string
keyVault [en] Detalhes do local do KeyVault do certificado. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
palavra-passe Senha para o certificado string

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

Designação Descrição Valor
identityClientId Nulo para SystemAssignedIdentity ou ID do Cliente para UserAssignedIdentity , que será usado para acessar o segredo do cofre de chaves. string
secretIdentifier Identificador secreto do cofre de chaves para buscar segredo. Fornecer um segredo versionado impedirá a atualização automática. Isso requer que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi string

Microsoft.ApiManagement/serviço/certificados

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: serviço
propriedades Detalhes das propriedades de criação ou atualização de certificados. CertificateCreateOrUpdatePropertiesOrCertificateContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/certificates@2024-06-01-preview"