Microsoft.ApiManagement service/subscriptions 2023-09-01-preview
- más reciente
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Definición de recursos de Bicep
El tipo de recurso service/subscriptions se puede implementar con operaciones destinadas a:
- 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/subscriptions, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2023-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
allowTracing: bool
displayName: 'string'
ownerId: 'string'
primaryKey: 'string'
scope: 'string'
secondaryKey: 'string'
state: 'string'
}
}
Valores de propiedad
Microsoft.ApiManagement/service/subscriptions
| 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 suscripción. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| allowTracing | Determina si se puede habilitar el seguimiento | Bool |
| displayName | Nombre de la suscripción. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio) |
| ownerId | Usuario (ruta de acceso de identificador de usuario) para quien se crea la suscripción en forma /users/{userId} | cuerda |
| primaryKey | Clave de suscripción principal. Si no se especifica durante la clave de solicitud, se generará automáticamente. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 |
| alcance | Á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. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 |
| estado | 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 se ha denegado por un administrador, * cancelado : la suscripción la ha cancelado el desarrollador o el administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó. | 'activo' 'cancelado' 'expirado' 'rechazado' 'enviado' 'suspendido' |
Definición de recursos de plantilla de ARM
El tipo de recurso service/subscriptions se puede implementar con operaciones destinadas a:
- 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/subscriptions, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.ApiManagement/service/subscriptions",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"allowTracing": "bool",
"displayName": "string",
"ownerId": "string",
"primaryKey": "string",
"scope": "string",
"secondaryKey": "string",
"state": "string"
}
}
Valores de propiedad
Microsoft.ApiManagement/service/subscriptions
| Nombre | Descripción | Valor |
|---|---|---|
| apiVersion | La versión de api | '2023-09-01-preview' |
| nombre | El nombre del recurso | cuerda Restricciones: Longitud máxima = Patrón = ^[^*#&+:<>?]+$ (obligatorio) |
| Propiedades | Propiedades del contrato de suscripción. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/subscriptions" |
SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| allowTracing | Determina si se puede habilitar el seguimiento | Bool |
| displayName | Nombre de la suscripción. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio) |
| ownerId | Usuario (ruta de acceso de identificador de usuario) para quien se crea la suscripción en forma /users/{userId} | cuerda |
| primaryKey | Clave de suscripción principal. Si no se especifica durante la clave de solicitud, se generará automáticamente. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 |
| alcance | Á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. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 |
| estado | 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 se ha denegado por un administrador, * cancelado : la suscripción la ha cancelado el desarrollador o el administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó. | 'activo' 'cancelado' 'expirado' 'rechazado' 'enviado' 'suspendido' |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso service/subscriptions se puede implementar con operaciones destinadas a:
- 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/subscriptions, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/subscriptions@2023-09-01-preview"
name = "string"
body = jsonencode({
properties = {
allowTracing = bool
displayName = "string"
ownerId = "string"
primaryKey = "string"
scope = "string"
secondaryKey = "string"
state = "string"
}
})
}
Valores de propiedad
Microsoft.ApiManagement/service/subscriptions
| 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 suscripción. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/subscriptions@2023-09-01-preview" |
SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| allowTracing | Determina si se puede habilitar el seguimiento | Bool |
| displayName | Nombre de la suscripción. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio) |
| ownerId | Usuario (ruta de acceso de identificador de usuario) para quien se crea la suscripción en forma /users/{userId} | cuerda |
| primaryKey | Clave de suscripción principal. Si no se especifica durante la clave de solicitud, se generará automáticamente. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 |
| alcance | Á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. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 |
| estado | 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 se ha denegado por un administrador, * cancelado : la suscripción la ha cancelado el desarrollador o el administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó. | 'activo' 'cancelado' 'expirado' 'rechazado' 'enviado' 'suspendido' |