Serviço Microsoft.ApiManagement/namedValues 2021-08-01
Definição de recursos do bíceps
O tipo de recurso service/namedValues pode ser implantado com operações direcionadas:
- 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/namedValues, adicione o seguinte Bíceps ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2021-08-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Valores de propriedade
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/service/namedValues
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso | string 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 para recurso do tipo: serviço |
| propriedades | Propriedades do contrato da entidade NamedValue para a operação PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Designação | Descrição | Valor |
|---|---|---|
| displayName | Nome exclusivo de NamedValue. Pode conter apenas letras, dígitos, ponto, travessão e caracteres sublinhados. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 Padrão = ^[A-Za-z0-9-._]+$ (obrigatório) |
| keyVault [en] | Detalhes da localização do KeyVault do namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| segredo | Determina se o valor é um segredo e deve ser criptografado ou não. O valor padrão é false. | Bool |
| Etiquetas | Tags opcionais que, quando fornecidas, podem ser usadas para filtrar a lista NamedValue. | string[] |
| valor | Valor do NamedValue. Pode conter expressões de política. Não pode estar vazio ou consistir apenas em espaço em branco. Esta propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. | string Restrições: Comprimento máximo = 4096 |
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
| Arquivo Bicep | Descrição |
|---|---|
| Porta Frontal Standard/Premium com origem API Management | Este modelo cria um Front Door Premium e uma instância de Gerenciamento de API, e usa uma política NSG e global de Gerenciamento de API para validar que o tráfego passou pela origem do Front Door. |
Definição de recurso de modelo ARM
O tipo de recurso service/namedValues pode ser implantado com operações direcionadas:
- 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/namedValues, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2021-08-01",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Valores de propriedade
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/service/namedValues
| Designação | Descrição | Valor |
|---|---|---|
| apiVersion | A versão api | '2021-08-01' |
| Designação | O nome do recurso | string Restrições: Comprimento máximo = 256 Padrão = ^[^*#&+:<>?]+$ (obrigatório) |
| propriedades | Propriedades do contrato da entidade NamedValue para a operação PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| tipo | O tipo de recurso | 'Microsoft.ApiManagement/service/namedValues' |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Designação | Descrição | Valor |
|---|---|---|
| displayName | Nome exclusivo de NamedValue. Pode conter apenas letras, dígitos, ponto, travessão e caracteres sublinhados. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 Padrão = ^[A-Za-z0-9-._]+$ (obrigatório) |
| keyVault [en] | Detalhes da localização do KeyVault do namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| segredo | Determina se o valor é um segredo e deve ser criptografado ou não. O valor padrão é false. | Bool |
| Etiquetas | Tags opcionais que, quando fornecidas, podem ser usadas para filtrar a lista NamedValue. | string[] |
| valor | Valor do NamedValue. Pode conter expressões de política. Não pode estar vazio ou consistir apenas em espaço em branco. Esta propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. | string Restrições: Comprimento máximo = 4096 |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
Porta Frontal Standard/Premium com origem API Management
|
Este modelo cria um Front Door Premium e uma instância de Gerenciamento de API, e usa uma política NSG e global de Gerenciamento de API para validar que o tráfego passou pela origem do Front Door. |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso service/namedValues pode ser implantado com operações direcionadas:
- 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/namedValues, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2021-08-01"
name = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Valores de propriedade
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/service/namedValues
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso | string Restrições: Comprimento máximo = 256 Padrão = ^[^*#&+:<>?]+$ (obrigatório) |
| parent_id | A ID do recurso que é o pai para este recurso. | ID do recurso do tipo: serviço |
| propriedades | Propriedades do contrato da entidade NamedValue para a operação PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/namedValues@2021-08-01" |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Designação | Descrição | Valor |
|---|---|---|
| displayName | Nome exclusivo de NamedValue. Pode conter apenas letras, dígitos, ponto, travessão e caracteres sublinhados. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 Padrão = ^[A-Za-z0-9-._]+$ (obrigatório) |
| keyVault [en] | Detalhes da localização do KeyVault do namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| segredo | Determina se o valor é um segredo e deve ser criptografado ou não. O valor padrão é false. | Bool |
| Etiquetas | Tags opcionais que, quando fornecidas, podem ser usadas para filtrar a lista NamedValue. | string[] |
| valor | Valor do NamedValue. Pode conter expressões de política. Não pode estar vazio ou consistir apenas em espaço em branco. Esta propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. | string Restrições: Comprimento máximo = 4096 |