Servicio Microsoft.ApiManagement/namedValues 2023-03-01-preview
Definición de recursos de Bicep
El tipo de recurso service/namedValues se puede implementar con operaciones que tienen como destino:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de recurso
Para crear un recurso Microsoft.ApiManagement/service/namedValues, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2023-03-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Valores de propiedad
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 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. | cuerda |
| 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 el servicio API Management se configure con aka.ms/apimmsi | cuerda |
Microsoft.ApiManagement/service/namedValues
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | cuerda Restricciones: Longitud máxima = Patrón = ^[^*#&+:<>?]+$ (obligatorio) |
| padre | 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 obtener más información, consulte recurso secundario fuera del recurso primario. |
Nombre simbólico del recurso de tipo: de servicio de |
| Propiedades | Propiedades del contrato de entidad NamedValue para la operación PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| displayName | Nombre único de NamedValue. Solo puede contener letras, dígitos, punto, guion y caracteres de subrayado. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 Patrón = ^[A-Za-z0-9-._]+$ (obligatorio) |
| keyVault | Detalles de ubicación de KeyVault del elemento namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| secreto | Determina si el valor es un secreto y debe cifrarse o no. El valor predeterminado es false. | Bool |
| Etiquetas | Etiquetas opcionales que cuando se proporcionan se pueden usar para filtrar la lista NamedValue. | string[] |
| valor | Valor de NamedValue. Puede contener expresiones de directiva. Puede que no esté vacío o que solo esté formado por espacios en blanco. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor. | cuerda Restricciones: Longitud máxima = |
Ejemplos de inicio rápido
En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.
| Archivo de Bicep | Descripción |
|---|---|
| Front Door Standard/Premium con el origen de API Management | Esta plantilla crea una instancia de Front Door Premium y una instancia de API Management y usa una directiva de NSG y 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 que tienen como destino:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de recurso
Para crear un recurso Microsoft.ApiManagement/service/namedValues, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Valores de propiedad
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 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. | cuerda |
| 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 el servicio API Management se configure con aka.ms/apimmsi | cuerda |
Microsoft.ApiManagement/service/namedValues
| Nombre | Descripción | Valor |
|---|---|---|
| apiVersion | La versión de api | '2023-03-01-preview' |
| nombre | El nombre del recurso | cuerda Restricciones: Longitud máxima = Patrón = ^[^*#&+:<>?]+$ (obligatorio) |
| Propiedades | Propiedades del contrato de entidad NamedValue para la operación PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| tipo | El tipo de recurso | 'Microsoft.ApiManagement/service/namedValues' |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| displayName | Nombre único de NamedValue. Solo puede contener letras, dígitos, punto, guion y caracteres de subrayado. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 Patrón = ^[A-Za-z0-9-._]+$ (obligatorio) |
| keyVault | Detalles de ubicación de KeyVault del elemento namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| secreto | Determina si el valor es un secreto y debe cifrarse o no. El valor predeterminado es false. | Bool |
| Etiquetas | Etiquetas opcionales que cuando se proporcionan se pueden usar para filtrar la lista NamedValue. | string[] |
| valor | Valor de NamedValue. Puede contener expresiones de directiva. Puede que no esté vacío o que solo esté formado por espacios en blanco. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor. | cuerda Restricciones: Longitud máxima = |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
| Plantilla | Descripción |
|---|---|
Front Door Standard/Premium con el origen de API Management
|
Esta plantilla crea una instancia de Front Door Premium y una instancia de API Management y usa una directiva de NSG y 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 que tienen como destino:
- grupos de recursos de
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de recurso
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-03-01-preview"
name = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Valores de propiedad
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 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. | cuerda |
| 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 el servicio API Management se configure con aka.ms/apimmsi | cuerda |
Microsoft.ApiManagement/service/namedValues
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | cuerda Restricciones: Longitud máxima = Patrón = ^[^*#&+:<>?]+$ (obligatorio) |
| parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: de servicio de |
| Propiedades | Propiedades del contrato de entidad NamedValue para la operación PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/namedValues@2023-03-01-preview" |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| displayName | Nombre único de NamedValue. Solo puede contener letras, dígitos, punto, guion y caracteres de subrayado. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 Patrón = ^[A-Za-z0-9-._]+$ (obligatorio) |
| keyVault | Detalles de ubicación de KeyVault del elemento namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| secreto | Determina si el valor es un secreto y debe cifrarse o no. El valor predeterminado es false. | Bool |
| Etiquetas | Etiquetas opcionales que cuando se proporcionan se pueden usar para filtrar la lista NamedValue. | string[] |
| valor | Valor de NamedValue. Puede contener expresiones de directiva. Puede que no esté vacío o que solo esté formado por espacios en blanco. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor. | cuerda Restricciones: Longitud máxima = |