Serviço Microsoft.ApiManagement/namedValues 2021-04-01-preview
O tipo de recurso service/namedValues 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.
Para criar um recurso Microsoft.ApiManagement/service/namedValues, adicione o seguinte Bicep ao modelo.
Bicep
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2021-04-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
| 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 |
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | corda Restrições: Comprimento máximo = 256 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 do recurso do tipo: de serviço |
| Propriedades | Propriedades do contrato de entidade NamedValue para a operação PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| Nome | Descrição | Valor |
|---|---|---|
| displayName | Nome exclusivo de NamedValue. Ele pode conter apenas letras, dígitos, ponto final, traço e caracteres de sublinhado. | corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 Padrão = ^[A-Za-z0-9-._]+$ (obrigatório) |
| keyVault | Detalhes da localização de KeyVault do chamadoValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| segredo | Determina se o valor é um segredo e deve ser criptografado ou não. O valor padrão é falso. | Bool |
| Tags | Marcas opcionais que, quando fornecidas, podem ser usadas para filtrar a lista NamedValue. | string[] |
| valor | Valor do NamedValue. Pode conter expressões de política. Ele pode não estar vazio ou consistir apenas em espaço em branco. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. | corda Restrições: Comprimento máximo = 4096 |
Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar esse tipo de recurso.
| Arquivo Bicep | Descrição |
|---|---|
| Front Door Standard/Premium com origem do Gerenciamento de API | Esse modelo cria um Front Door Premium e uma instância de Gerenciamento de API e usa uma política de Gerenciamento de API global e NSG para validar que o tráfego veio por meio da origem do Front Door. |
O tipo de recurso service/namedValues 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.
Para criar um recurso Microsoft.ApiManagement/service/namedValues, adicione o JSON a seguir ao seu modelo.
JSON
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2021-04-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
| 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 |
| Nome | Descrição | Valor |
|---|---|---|
| apiVersion | A versão da API | '2021-04-01-preview' |
| nome | O nome do recurso | corda Restrições: Comprimento máximo = 256 Padrão = ^[^*#&+:<>?]+$ (obrigatório) |
| Propriedades | Propriedades do contrato de entidade NamedValue para a operação PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| tipo | O tipo de recurso | 'Microsoft.ApiManagement/service/namedValues' |
| Nome | Descrição | Valor |
|---|---|---|
| displayName | Nome exclusivo de NamedValue. Ele pode conter apenas letras, dígitos, ponto final, traço e caracteres de sublinhado. | corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 Padrão = ^[A-Za-z0-9-._]+$ (obrigatório) |
| keyVault | Detalhes da localização de KeyVault do chamadoValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| segredo | Determina se o valor é um segredo e deve ser criptografado ou não. O valor padrão é falso. | Bool |
| Tags | Marcas opcionais que, quando fornecidas, podem ser usadas para filtrar a lista NamedValue. | string[] |
| valor | Valor do NamedValue. Pode conter expressões de política. Ele pode não estar vazio ou consistir apenas em espaço em branco. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. | corda Restrições: Comprimento máximo = 4096 |
Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.
| Modelo | Descrição |
|---|---|
Front Door Standard/Premium com origem do Gerenciamento de API
|
Esse modelo cria um Front Door Premium e uma instância de Gerenciamento de API e usa uma política de Gerenciamento de API global e NSG para validar que o tráfego veio por meio da origem do Front Door. |
O tipo de recurso service/namedValues 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.
Para criar um recurso Microsoft.ApiManagement/service/namedValues, adicione o Terraform a seguir ao seu modelo.
Terraform
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2021-04-01-preview"
name = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
| 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 |
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | corda Restrições: Comprimento máximo = 256 Padrão = ^[^*#&+:<>?]+$ (obrigatório) |
| parent_id | A ID do recurso que é o pai desse recurso. | ID do recurso do tipo: serviço |
| Propriedades | Propriedades do contrato de entidade NamedValue para a operação PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/namedValues@2021-04-01-preview" |
| Nome | Descrição | Valor |
|---|---|---|
| displayName | Nome exclusivo de NamedValue. Ele pode conter apenas letras, dígitos, ponto final, traço e caracteres de sublinhado. | corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 Padrão = ^[A-Za-z0-9-._]+$ (obrigatório) |
| keyVault | Detalhes da localização de KeyVault do chamadoValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| segredo | Determina se o valor é um segredo e deve ser criptografado ou não. O valor padrão é falso. | Bool |
| Tags | Marcas opcionais que, quando fornecidas, podem ser usadas para filtrar a lista NamedValue. | string[] |
| valor | Valor do NamedValue. Pode conter expressões de política. Ele pode não estar vazio ou consistir apenas em espaço em branco. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. | corda Restrições: Comprimento máximo = 4096 |