Serviço/certificados Microsoft.ApiManagement 2023-09-01-preview
Definição de recurso do Bicep
O tipo de recurso de serviço/certificados pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/certificates, adicione o Bicep a seguir ao 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
service/certificates
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso Veja como definir nomes e tipos para recursos filho no Bicep. |
cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Alfanuméricos e hifens. 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 do recurso do tipo: de serviço |
| Propriedades | Detalhes da criação ou atualização de propriedades do certificado. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Nome | Descrição | Valor |
|---|---|---|
| dados | Certificado codificado em base 64 usando a representação application/x-pkcs12. | corda |
| keyVault | Detalhes do local do KeyVault do certificado. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| senha | Senha do certificado | corda |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nome | Descrição | Valor |
|---|---|---|
| identityClientId | Nulo para SystemAssignedIdentity ou ID do cliente para UserAssignedIdentity, que será usado para acessar o segredo do cofre de chaves. | corda |
| secretIdentifier | Identificador de segredo do cofre de chaves para busca de segredo. Fornecer um segredo com versão impedirá a atualização automática. Isso requer que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi | corda |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
Criar uma instância de Gerenciamento de API e todos os sub-recursos usando de modelo
|
Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar sub entidades |
Definição de recurso de modelo do ARM
O tipo de recurso de serviço/certificados pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/certificates, adicione o JSON a seguir ao 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
service/certificates
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.ApiManagement/service/certificates' |
| apiVersion | A versão da API do recurso | '2023-09-01-preview' |
| nome | O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON. |
cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Alfanuméricos e hifens. Comece com letra e termine com alfanumérico. |
| Propriedades | Detalhes da criação ou atualização de propriedades do certificado. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Nome | Descrição | Valor |
|---|---|---|
| dados | Certificado codificado em base 64 usando a representação application/x-pkcs12. | corda |
| keyVault | Detalhes do local do KeyVault do certificado. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| senha | Senha do certificado | corda |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nome | Descrição | Valor |
|---|---|---|
| identityClientId | Nulo para SystemAssignedIdentity ou ID do cliente para UserAssignedIdentity, que será usado para acessar o segredo do cofre de chaves. | corda |
| secretIdentifier | Identificador de segredo do cofre de chaves para busca de segredo. Fornecer um segredo com versão impedirá a atualização automática. Isso requer que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi | corda |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
|
Criar uma instância de Gerenciamento de API e todos os sub-recursos usando de modelo
|
Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar sub entidades |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso de serviço/certificados pode ser implantado com operações de destino:
- grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/certificates, adicione o Terraform a seguir 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
service/certificates
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/certificates@2023-09-01-preview" |
| nome | O nome do recurso | cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Alfanuméricos e hifens. Comece com letra e termine com alfanumérico. |
| parent_id | A ID do recurso que é o pai desse recurso. | ID do recurso do tipo: serviço |
| Propriedades | Detalhes da criação ou atualização de propriedades do certificado. | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| Nome | Descrição | Valor |
|---|---|---|
| dados | Certificado codificado em base 64 usando a representação application/x-pkcs12. | corda |
| keyVault | Detalhes do local do KeyVault do certificado. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| senha | Senha do certificado | corda |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nome | Descrição | Valor |
|---|---|---|
| identityClientId | Nulo para SystemAssignedIdentity ou ID do cliente para UserAssignedIdentity, que será usado para acessar o segredo do cofre de chaves. | corda |
| secretIdentifier | Identificador de segredo do cofre de chaves para busca de segredo. Fornecer um segredo com versão impedirá a atualização automática. Isso requer que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi | corda |