Servicio Microsoft.ApiManagement/suscripciones 2021-12-01-preview
Definición de recursos de Bicep
El tipo de recurso service/subscriptions se puede implementar con operaciones que tienen como destino:
- Grupos de recursos: consulte los comandos de implementación del grupo 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/subscriptions, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2021-12-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
allowTracing: bool
displayName: 'string'
ownerId: 'string'
primaryKey: 'string'
scope: 'string'
secondaryKey: 'string'
state: 'string'
}
}
Valores de propiedad
service/subscriptions
| Nombre | Descripción | Value |
|---|---|---|
| name | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep. |
string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. |
| 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 suscripción. | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
| Nombre | Descripción | Valor |
|---|---|---|
| allowTracing | Determina si se puede habilitar el seguimiento | bool |
| DisplayName | el nombre de la suscripción. | string (obligatorio) |
| ownerId | Usuario (ruta de acceso de identificador de usuario) para la que se crea la suscripción en el formulario /users/{userId} | string |
| primaryKey | Clave de suscripción principal. Si no se especifica durante la clave de solicitud, se generará automáticamente. | string |
| scope | Ámbito como /products/{productId} o /apis o /apis/{apiId}. | string (obligatorio) |
| secondaryKey | Clave de suscripción secundaria. Si no se especifica durante la clave de solicitud, se generará automáticamente. | string |
| state | Estado inicial de la suscripción. Si no se especifica ningún valor, la suscripción se crea con el estado Enviado. Los estados posibles son * activos : la suscripción está activa, * suspendida , la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada , la solicitud de suscripción ha sido realizada por el desarrollador, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción ha sido denegada por un administrador, * cancelado – la suscripción ha sido cancelada por el desarrollador o el administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó. | 'activo' 'cancelado' 'expirado' 'rechazado' 'enviado' 'suspendido' |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
| Plantilla | Descripción |
|---|---|
Creación de una instancia de API Management y todos los subrecursos mediante la plantilla |
En esta plantilla se muestra cómo crear un servicio API Management y configurar subentidades. |
Definición de recursos de plantilla de ARM
El tipo de recurso service/subscriptions se puede implementar con operaciones que tienen como destino:
- Grupos de recursos: consulte los comandos de implementación del grupo 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/subscriptions, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.ApiManagement/service/subscriptions",
"apiVersion": "2021-12-01-preview",
"name": "string",
"properties": {
"allowTracing": "bool",
"displayName": "string",
"ownerId": "string",
"primaryKey": "string",
"scope": "string",
"secondaryKey": "string",
"state": "string"
}
}
Valores de propiedad
service/subscriptions
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.ApiManagement/service/subscriptions" |
| apiVersion | La versión de la API de recursos | "2021-12-01-preview" |
| name | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM JSON. |
string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. |
| properties | Propiedades del contrato de suscripción. | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
| Nombre | Descripción | Valor |
|---|---|---|
| allowTracing | Determina si se puede habilitar el seguimiento | bool |
| DisplayName | el nombre de la suscripción. | string (obligatorio) |
| ownerId | Usuario (ruta de acceso de identificador de usuario) para el que se crea la suscripción con el formato /users/{userId} | string |
| primaryKey | Clave de suscripción principal. Si no se especifica durante la clave de solicitud, se generará automáticamente. | string |
| scope | Ámbito como /products/{productId} o /apis o /apis/{apiId}. | string (obligatorio) |
| secondaryKey | Clave de suscripción secundaria. Si no se especifica durante la clave de solicitud, se generará automáticamente. | string |
| state | Estado inicial de la suscripción. Si no se especifica ningún valor, la suscripción se crea con el estado Enviado. Los estados posibles son * activos: la suscripción está activa, * suspendida: la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada : el desarrollador ha realizado la solicitud de suscripción, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción ha sido denegada por un administrador, * cancelado– la suscripción ha sido cancelada por el desarrollador o administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó. | 'activo' 'cancelado' 'expirado' 'rechazado' 'enviado' 'suspendido' |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
| Plantilla | Descripción |
|---|---|
| Creación de una instancia de API Management y todos los subrecursos mediante la plantilla |
Esta plantilla muestra cómo crear un servicio API Management y configurar subentidades |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso service/subscriptions 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/subscriptions, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/subscriptions@2021-12-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
allowTracing = bool
displayName = "string"
ownerId = "string"
primaryKey = "string"
scope = "string"
secondaryKey = "string"
state = "string"
}
})
}
Valores de propiedad
service/subscriptions
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.ApiManagement/service/subscriptions@2021-12-01-preview" |
| name | El nombre del recurso | string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. |
| parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: servicio |
| properties | Propiedades del contrato de suscripción. | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
| Nombre | Descripción | Valor |
|---|---|---|
| allowTracing | Determina si se puede habilitar el seguimiento | bool |
| DisplayName | el nombre de la suscripción. | string (obligatorio) |
| ownerId | Usuario (ruta de acceso de identificador de usuario) para el que se crea la suscripción con el formato /users/{userId} | string |
| primaryKey | Clave de suscripción principal. Si no se especifica durante la clave de solicitud, se generará automáticamente. | string |
| scope | Ámbito como /products/{productId} o /apis o /apis/{apiId}. | string (obligatorio) |
| secondaryKey | Clave de suscripción secundaria. Si no se especifica durante la clave de solicitud, se generará automáticamente. | string |
| state | Estado inicial de la suscripción. Si no se especifica ningún valor, la suscripción se crea con el estado Enviado. Los estados posibles son * activos : la suscripción está activa, * suspendida , la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada , la solicitud de suscripción ha sido realizada por el desarrollador, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción ha sido denegada por un administrador, * cancelado – la suscripción ha sido cancelada por el desarrollador o el administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó. | "activo" "cancelado" "expirado" "rechazado" "enviado" "suspendido" |