Serviço Microsoft.ApiManagement/namedValues 2019-12-01
Definição de recurso do Bicep
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.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/namedValues, adicione o seguinte Bicep ao modelo.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2019-12-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Valores de propriedade
Microsoft.ApiManagement/service/namedValues
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | corda Restrições: Comprimento máximo = 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 |
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 = 1 Padrão = ^[A-Za-z0-9-._]+$ (obrigatório) |
| 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ínimo = 1 Comprimento máximo = 1 (obrigatório) |
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam 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. |
Definição de recurso de modelo do ARM
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.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/namedValues, adicione o JSON a seguir ao seu modelo.
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2019-12-01",
"name": "string",
"properties": {
"displayName": "string",
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Valores de propriedade
Microsoft.ApiManagement/service/namedValues
| Nome | Descrição | Valor |
|---|---|---|
| apiVersion | A versão da API | '2019-12-01' |
| nome | O nome do recurso | corda Restrições: Comprimento máximo = 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' |
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 = 1 Padrão = ^[A-Za-z0-9-._]+$ (obrigatório) |
| 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ínimo = 1 Comprimento máximo = 1 (obrigatório) |
Modelos de início rápido
Os modelos de início rápido a seguir implantam 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. |
Definição de recurso do Terraform (provedor de AzAPI)
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.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/namedValues, adicione o Terraform a seguir ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2019-12-01"
name = "string"
body = jsonencode({
properties = {
displayName = "string"
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Valores de propriedade
Microsoft.ApiManagement/service/namedValues
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | corda Restrições: Comprimento máximo = 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@2019-12-01" |
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 = 1 Padrão = ^[A-Za-z0-9-._]+$ (obrigatório) |
| 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ínimo = 1 Comprimento máximo = 1 (obrigatório) |