Servicio Microsoft.ApiManagement/products 2022-08-01
- más reciente
- 2023-09-01-preview
- 2022-08-01
- 2021-08-01
Definición de recursos de Bicep
El tipo de recurso service/products 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/products, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/products@2022-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
Valores de propiedad
service/products
Nombre | Descripción | Valor |
---|---|---|
nombre | 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 la letra y termine con alfanumérico. |
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 del producto. | productContractProperties |
ProductContractProperties
Nombre | Descripción | Valor |
---|---|---|
approvalRequired | si se requiere la aprobación de la suscripción. Si es false, las nuevas suscripciones se aprobarán automáticamente, lo que permitirá a los desarrolladores llamar a las API del producto inmediatamente después de suscribirse. Si es true, los administradores deben aprobar manualmente la suscripción antes de que el desarrollador pueda cualquiera de las API del producto. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false. | Bool |
descripción | Descripción del producto. Puede incluir etiquetas de formato HTML. | cuerda Restricciones: Longitud máxima = 1000 |
displayName | Nombre del producto. | string (obligatorio) Restricciones: Longitud mínima = 1 Longitud máxima = 300 |
estado | si el producto se publica o no. Los usuarios del portal para desarrolladores pueden detectar los productos publicados. Los productos no publicados solo son visibles para los administradores. El estado predeterminado de Product no esPublished. | 'notPublished' 'published' |
subscriptionRequired | Si se requiere una suscripción de producto para acceder a las API incluidas en este producto. Si es true, el producto se conoce como "protegido" y se requiere una clave de suscripción válida para que una solicitud a una API incluida en el producto se realice correctamente. Si es false, el producto se conoce como "abierto" y se pueden realizar solicitudes a una API incluida en el producto sin una clave de suscripción. Si se omite la propiedad al crear un nuevo producto, se supone que el valor es true. | Bool |
subscriptionsLimit | Indica si el número de suscripciones que un usuario puede tener en este producto al mismo tiempo. Establezca en NULL o omita para permitir suscripciones ilimitadas por usuario. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false. | Int |
letra chica | Términos de uso del producto. Los desarrolladores que intentan suscribirse al producto se mostrarán y tendrán que aceptar estos términos para poder completar el proceso de suscripción. | cuerda |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
Plantilla | Descripción |
---|---|
Crear una instancia de API Management y todos los subrecursos mediante de plantilla |
Esta plantilla muestra cómo crear un servicio API Management y configurar subentidades |
Creación de Azure Front Door delante de Azure API Management |
En este ejemplo se muestra cómo usar Azure Front Door como equilibrador de carga global delante de Azure API Management. |
Definición de recursos de plantilla de ARM
El tipo de recurso service/products 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/products, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.ApiManagement/service/products",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
Valores de propiedad
service/products
Nombre | Descripción | Valor |
---|---|---|
tipo | El tipo de recurso | "Microsoft.ApiManagement/service/products" |
apiVersion | La versión de la API de recursos | '2022-08-01' |
nombre | 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 la letra y termine con alfanumérico. |
Propiedades | Propiedades del contrato de entidad del producto. | productContractProperties |
ProductContractProperties
Nombre | Descripción | Valor |
---|---|---|
approvalRequired | si se requiere la aprobación de la suscripción. Si es false, las nuevas suscripciones se aprobarán automáticamente, lo que permitirá a los desarrolladores llamar a las API del producto inmediatamente después de suscribirse. Si es true, los administradores deben aprobar manualmente la suscripción antes de que el desarrollador pueda cualquiera de las API del producto. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false. | Bool |
descripción | Descripción del producto. Puede incluir etiquetas de formato HTML. | cuerda Restricciones: Longitud máxima = 1000 |
displayName | Nombre del producto. | string (obligatorio) Restricciones: Longitud mínima = 1 Longitud máxima = 300 |
estado | si el producto se publica o no. Los usuarios del portal para desarrolladores pueden detectar los productos publicados. Los productos no publicados solo son visibles para los administradores. El estado predeterminado de Product no esPublished. | 'notPublished' 'published' |
subscriptionRequired | Si se requiere una suscripción de producto para acceder a las API incluidas en este producto. Si es true, el producto se conoce como "protegido" y se requiere una clave de suscripción válida para que una solicitud a una API incluida en el producto se realice correctamente. Si es false, el producto se conoce como "abierto" y se pueden realizar solicitudes a una API incluida en el producto sin una clave de suscripción. Si se omite la propiedad al crear un nuevo producto, se supone que el valor es true. | Bool |
subscriptionsLimit | Indica si el número de suscripciones que un usuario puede tener en este producto al mismo tiempo. Establezca en NULL o omita para permitir suscripciones ilimitadas por usuario. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false. | Int |
letra chica | Términos de uso del producto. Los desarrolladores que intentan suscribirse al producto se mostrarán y tendrán que aceptar estos términos para poder completar el proceso de suscripción. | cuerda |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
Plantilla | Descripción |
---|---|
Crear una instancia de API Management y todos los subrecursos mediante de plantilla |
Esta plantilla muestra cómo crear un servicio API Management y configurar subentidades |
Creación de Azure Front Door delante de Azure API Management |
En este ejemplo se muestra cómo usar Azure Front Door como equilibrador de carga global delante de Azure API Management. |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso service/products 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/products, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/products@2022-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
Valores de propiedad
service/products
Nombre | Descripción | Valor |
---|---|---|
tipo | El tipo de recurso | "Microsoft.ApiManagement/service/products@2022-08-01" |
nombre | El nombre del recurso | string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con la letra y termine con alfanumérico. |
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 del producto. | productContractProperties |
ProductContractProperties
Nombre | Descripción | Valor |
---|---|---|
approvalRequired | si se requiere la aprobación de la suscripción. Si es false, las nuevas suscripciones se aprobarán automáticamente, lo que permitirá a los desarrolladores llamar a las API del producto inmediatamente después de suscribirse. Si es true, los administradores deben aprobar manualmente la suscripción antes de que el desarrollador pueda cualquiera de las API del producto. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false. | Bool |
descripción | Descripción del producto. Puede incluir etiquetas de formato HTML. | cuerda Restricciones: Longitud máxima = 1000 |
displayName | Nombre del producto. | string (obligatorio) Restricciones: Longitud mínima = 1 Longitud máxima = 300 |
estado | si el producto se publica o no. Los usuarios del portal para desarrolladores pueden detectar los productos publicados. Los productos no publicados solo son visibles para los administradores. El estado predeterminado de Product no esPublished. | "notPublished" "publicado" |
subscriptionRequired | Si se requiere una suscripción de producto para acceder a las API incluidas en este producto. Si es true, el producto se conoce como "protegido" y se requiere una clave de suscripción válida para que una solicitud a una API incluida en el producto se realice correctamente. Si es false, el producto se conoce como "abierto" y se pueden realizar solicitudes a una API incluida en el producto sin una clave de suscripción. Si se omite la propiedad al crear un nuevo producto, se supone que el valor es true. | Bool |
subscriptionsLimit | Indica si el número de suscripciones que un usuario puede tener en este producto al mismo tiempo. Establezca en NULL o omita para permitir suscripciones ilimitadas por usuario. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false. | Int |
letra chica | Términos de uso del producto. Los desarrolladores que intentan suscribirse al producto se mostrarán y tendrán que aceptar estos términos para poder completar el proceso de suscripción. | cuerda |