Serviço/certificados Microsoft.ApiManagement
Definição de recursos do bíceps
O tipo de recurso serviço/certificados pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo 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 Bíceps ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/certificates@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
data: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
password: 'string'
}
}
Valores de propriedade
Serviço/Certificados
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso Veja como definir nomes e tipos para recursos filho no Bicep. |
string (obrigatório) Limite de caracteres: 1-80 Caracteres válidos: Alfanuméricos e hífenes. Comece com letra e termine com alfanumérico. |
| 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. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| 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. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| palavra-passe | Senha para o certificado | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 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 |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
Crie uma instância de Gerenciamento de API e todos os subrecursos usando o modelo
|
Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar subentidades |
Definição de recurso de modelo ARM
O tipo de recurso serviço/certificados pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo 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 JSON ao seu modelo.
{
"type": "Microsoft.ApiManagement/service/certificates",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"data": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"password": "string"
}
}
Valores de propriedade
Serviço/Certificados
| Designação | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.ApiManagement/service/certificates' |
| apiVersion | A versão da api de recursos | '2023-09-01-pré-visualização' |
| Designação | O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos JSON ARM. |
string (obrigatório) Limite de caracteres: 1-80 Caracteres válidos: Alfanuméricos e hífenes. Comece com letra e termine com alfanumérico. |
| propriedades | Detalhes das propriedades de criação ou atualização de certificados. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| 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. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| palavra-passe | Senha para o certificado | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 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 |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
|
Crie uma instância de Gerenciamento de API e todos os subrecursos usando o modelo
|
Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar subentidades |
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@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
data = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
password = "string"
}
})
}
Valores de propriedade
Serviço/Certificados
| Designação | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/certificates@2023-09-01-preview" |
| Designação | O nome do recurso | string (obrigatório) Limite de caracteres: 1-80 Caracteres válidos: Alfanuméricos e hífenes. Comece com letra e termine com alfanumérico. |
| 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. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| 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. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| palavra-passe | Senha para o certificado | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 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 |