Serviço Microsoft.ApiManagement/namedValues 2021-08-01

Definição de recurso do Bicep

O tipo de recurso service/namedValues pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/namedValues, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    displayName: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    secret: bool
    tags: [
      'string'
    ]
    value: 'string'
  }
}

Valores de propriedade

service/namedValues

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.
cadeia (obrigatório)
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.
Nome simbólico para recurso do tipo: serviço
propriedades Propriedades do contrato de entidade NamedValue para a operação PUT. NamedValueCreateContractPropertiesOrNamedValueContra...

NamedValueCreateContractPropertiesOrNamedValueContra...

Nome Descrição Valor
displayName Nome exclusivo de NamedValue. Pode conter apenas letras, dígitos, ponto final, traço e carateres de sublinhado. cadeia (obrigatório)
keyVault Detalhes da localização do KeyVault do nomeValue. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
segredo Determina se o valor é um segredo e deve ser encriptado ou não. O valor predefinido é falso. bool
etiquetas Etiquetas opcionais que, quando fornecidas, podem ser utilizadas para filtrar a lista NamedValue. cadeia[]
valor Valor do NamedValue. Pode conter expressões de política. Pode não estar vazio ou consistir apenas em espaço em branco. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor. string

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nome Descrição Valor
identityClientId Null para SystemAssignedIdentity ou ID de Cliente para UserAssignedIdentity , que será utilizado para aceder ao segredo do cofre de chaves. string
secretIdentifier Identificador do segredo do cofre de chaves para obter o segredo. Fornecer um segredo com versões impedirá a atualização automática. Isto requer que Gestão de API serviço seja configurado com aka.ms/apimmsi string

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Front Door Standard/Premium com origem Gestão de API

Implementar no Azure
Este modelo cria um Front Door Premium e uma instância de Gestão de API e utiliza uma política de Gestão de API global e NSG para validar que o tráfego passou pela origem do Front Door.

Definição de recurso de modelo do ARM

O tipo de recurso service/namedValues pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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

service/namedValues

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.ApiManagement/service/namedValues"
apiVersion A versão da API de recursos '2021-08-01'
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos do ARM JSON.
cadeia (obrigatório)
propriedades Propriedades do contrato de entidade NamedValue para a operação PUT. NamedValueCreateContractPropertiesOrNamedValueContra...

NamedValueCreateContractPropertiesOrNamedValueContra...

Nome Descrição Valor
displayName Nome exclusivo de NamedValue. Pode conter apenas letras, dígitos, ponto final, traço e carateres de sublinhado. cadeia (obrigatório)
keyVault Detalhes da localização do KeyVault do nomeValue. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
segredo Determina se o valor é um segredo e deve ser encriptado ou não. O valor predefinido é falso. bool
etiquetas Etiquetas opcionais que, quando fornecidas, podem ser utilizadas para filtrar a lista NamedValue. cadeia[]
valor Valor do NamedValue. Pode conter expressões de política. Pode não estar vazio ou consistir apenas em espaço em branco. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor. string

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nome Descrição Valor
identityClientId Null para SystemAssignedIdentity ou ID de Cliente para UserAssignedIdentity , que será utilizado para aceder ao segredo do cofre de chaves. string
secretIdentifier Identificador do segredo do cofre de chaves para obter o segredo. Fornecer um segredo com versões impedirá a atualização automática. Isto requer que Gestão de API serviço seja configurado com aka.ms/apimmsi string

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Front Door Standard/Premium com origem Gestão de API

Implementar no Azure
Este modelo cria um Front Door Premium e uma instância de Gestão de API e utiliza uma política de Gestão de API global e NSG para validar que o tráfego passou pela origem do Front Door.

Definição de recurso do Terraform (fornecedor AzAPI)

O tipo de recurso service/namedValues pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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"
  parent_id = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      secret = bool
      tags = [
        "string"
      ]
      value = "string"
    }
  })
}

Valores de propriedade

service/namedValues

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.ApiManagement/service/namedValues@2021-08-01"
name O nome do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este recurso. ID para recurso do tipo: serviço
propriedades Propriedades do contrato de entidade NamedValue para a operação PUT. NamedValueCreateContractPropertiesOrNamedValueContra...

NamedValueCreateContractPropertiesOrNamedValueContra...

Nome Descrição Valor
displayName Nome exclusivo de NamedValue. Pode conter apenas letras, dígitos, ponto final, traço e carateres de sublinhado. cadeia (obrigatório)
keyVault Detalhes da localização do KeyVault do nomeValue. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
segredo Determina se o valor é um segredo e deve ser encriptado ou não. O valor predefinido é falso. bool
etiquetas Etiquetas opcionais que, quando fornecidas, podem ser utilizadas para filtrar a lista NamedValue. cadeia[]
valor Valor do NamedValue. Pode conter expressões de política. Pode não estar vazio ou consistir apenas em espaço em branco. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor. string

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nome Descrição Valor
identityClientId Null para SystemAssignedIdentity ou ID de Cliente para UserAssignedIdentity , que será utilizado para aceder ao segredo do cofre de chaves. string
secretIdentifier Identificador do segredo do cofre de chaves para obter o segredo. Fornecer um segredo com versões impedirá a atualização automática. Isto requer que Gestão de API serviço seja configurado com aka.ms/apimmsi string