Compartir a través de

Servicio Microsoft.ApiManagement/namedValues

  • Artículo

Definición de recursos de Bicep

El tipo de recurso service/namedValues se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service/namedValues, agregue el siguiente bicep a la plantilla.

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

Valores de propiedad

service/namedValues

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)
primario En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: servicio
properties Propiedades del contrato de entidad NamedValue para la operación PUT. NamedValueCreateContractPropertiesOrNamedValueContra...

NamedValueCreateContractPropertiesOrNamedValueContra...

Nombre Descripción Valor
DisplayName Nombre único de NamedValue. Puede contener solo letras, dígitos, puntos, guiones o caracteres de subrayado. string (obligatorio)
keyVault Detalles de ubicación de KeyVault del elemento namedValue. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
secret Determina si el valor es secreto y si se debe cifrar. El valor predeterminado es False. bool
etiquetas Etiquetas opcionales que, cuando se proporcionan, se pueden usar para filtrar la lista NamedValue. string[]
value Valor de NamedValue. Puede contener expresiones de directiva. No puede estar vacío ni contener solo espacios en blanco. Esta propiedad no se rellenará en las operaciones "GET". Use la solicitud POST "/listSecrets" para obtener el valor. string

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nombre Descripción Valor
identityClientId Null para SystemAssignedIdentity o Id. de cliente para UserAssignedIdentity, que se usará para acceder al secreto del almacén de claves. string
secretIdentifier Identificador de secreto del almacén de claves para capturar el secreto. Proporcionar un secreto con versiones impedirá la actualización automática. Esto requiere que API Management servicio se configure con aka.ms/apimmsi string

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Front Door Estándar/Premium con origen de API Management

Implementación en Azure		 Esta plantilla crea una instancia de Front Door Premium y una instancia de API Management, y usa un grupo de seguridad de red y una directiva de API Management global para validar que el tráfico ha llegado a través del origen de Front Door.

Definición de recursos de plantilla de ARM

El tipo de recurso service/namedValues se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service/namedValues, agregue el siguiente código JSON a la plantilla.

{
  "type": "Microsoft.ApiManagement/service/namedValues",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "displayName": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "secret": "bool",
    "tags": [ "string" ],
    "value": "string"
  }
}

Valores de propiedad

service/namedValues

Nombre Descripción Value
type Tipo de recurso 'Microsoft.ApiManagement/service/namedValues'
apiVersion La versión de la API de recursos "2023-05-01-preview"
name El nombre del recurso

Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.		 string (obligatorio)
properties Propiedades del contrato de entidad NamedValue para la operación PUT. NamedValueCreateContractPropertiesOrNamedValueContra...

NamedValueCreateContractPropertiesOrNamedValueContra...

Nombre Descripción Valor
DisplayName Nombre único de NamedValue. Puede contener solo letras, dígitos, puntos, guiones o caracteres de subrayado. string (obligatorio)
keyVault Detalles de ubicación de KeyVault del elemento namedValue. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
secret Determina si el valor es secreto y si se debe cifrar. El valor predeterminado es False. bool
etiquetas Etiquetas opcionales que, cuando se proporcionan, se pueden usar para filtrar la lista NamedValue. string[]
value Valor de NamedValue. Puede contener expresiones de directiva. No puede estar vacío ni contener solo espacios en blanco. Esta propiedad no se rellenará en las operaciones "GET". Use la solicitud POST "/listSecrets" para obtener el valor. string

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nombre Descripción Valor
identityClientId Null para SystemAssignedIdentity o Id. de cliente para UserAssignedIdentity, que se usará para acceder al secreto del almacén de claves. string
secretIdentifier Identificador de secreto del almacén de claves para capturar el secreto. Proporcionar un secreto con versiones impedirá la actualización automática. Esto requiere que API Management servicio se configure con aka.ms/apimmsi string

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Front Door Estándar/Premium con origen de API Management

Implementación en Azure		 Esta plantilla crea una instancia de Front Door Premium y una instancia de API Management, y usa un grupo de seguridad de red y una directiva de API Management global para validar que el tráfico ha llegado a través del origen de Front Door.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/namedValues se puede implementar con operaciones destinadas a:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service/namedValues, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/namedValues@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      secret = bool
      tags = [
        "string"
      ]
      value = "string"
    }
  })
}

Valores de propiedad

service/namedValues

Nombre Descripción Value
type Tipo de recurso "Microsoft.ApiManagement/service/namedValues@2023-05-01-preview"
name El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: servicio
properties Propiedades del contrato de entidad NamedValue para la operación PUT. NamedValueCreateContractPropertiesOrNamedValueContra...

NamedValueCreateContractPropertiesOrNamedValueContra...

Nombre Descripción Valor
DisplayName Nombre único de NamedValue. Puede contener solo letras, dígitos, puntos, guiones o caracteres de subrayado. string (obligatorio)
keyVault Detalles de ubicación de KeyVault del elemento namedValue. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
secret Determina si el valor es secreto y si se debe cifrar. El valor predeterminado es False. bool
etiquetas Etiquetas opcionales que, cuando se proporcionan, se pueden usar para filtrar la lista NamedValue. string[]
value Valor de NamedValue. Puede contener expresiones de directiva. No puede estar vacío ni contener solo espacios en blanco. Esta propiedad no se rellenará en las operaciones "GET". Use la solicitud POST "/listSecrets" para obtener el valor. string

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nombre Descripción Valor
identityClientId Null para SystemAssignedIdentity o Id. de cliente para UserAssignedIdentity , que se usará para acceder al secreto del almacén de claves. string
secretIdentifier Identificador de secreto del almacén de claves para capturar el secreto. Proporcionar un secreto con versiones impedirá la actualización automática. Esto requiere que API Management servicio se configure con aka.ms/apimmsi string