Compartir a través de

Servicio Microsoft.ApiManagement/products 2021-04-01-preview

  • Artículo

Definición de recursos de Bicep

El tipo de recurso service/products 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/products, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.ApiManagement/service/products@2021-04-01-preview' = {
  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 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 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 para que el desarrollador pueda cualquiera de las API del producto. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor de false. bool
description Descripción del producto. Puede incluir etiquetas de formato HTML. string
DisplayName Nombre de producto. string (obligatorio)
state 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 Si el número de suscripciones que un usuario puede tener en este producto al mismo tiempo. Establézcalo en null omita para permitir suscripciones ilimitadas por usuario. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor de false. int
terms Términos de uso del producto. Los desarrolladores que traten de suscribirse al producto verán y deberán aceptar estos términos para poder completar el proceso de suscripción. string

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

Implementación en Azure		 En esta plantilla se muestra cómo crear un servicio API Management y configurar subentidades.
Creación de Azure Front Door delante de Azure API Management

Implementación en Azure		 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:

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/products, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2021-04-01-preview",
  "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 Value
type Tipo de recurso "Microsoft.ApiManagement/service/products"
apiVersion La versión de la API de recursos "2021-04-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 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 para que el desarrollador pueda cualquiera de las API del producto. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor de false. bool
description Descripción del producto. Puede incluir etiquetas de formato HTML. string
DisplayName Nombre de producto. string (obligatorio)
state 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 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 de false. int
terms Términos de uso del producto. Los desarrolladores que traten de suscribirse al producto verán y deberán aceptar estos términos para poder completar el proceso de suscripción. string

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

Implementación en Azure		 Esta plantilla muestra cómo crear un servicio API Management y configurar subentidades
Creación de Azure Front Door delante de Azure API Management

Implementación en Azure		 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

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/products, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2021-04-01-preview"
  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 Value
type Tipo de recurso "Microsoft.ApiManagement/service/products@2021-04-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 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 para que el desarrollador pueda cualquiera de las API del producto. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor de false. bool
description Descripción del producto. Puede incluir etiquetas de formato HTML. string
DisplayName Nombre de producto. string (obligatorio)
state 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 Si el número de suscripciones que un usuario puede tener en este producto al mismo tiempo. Establézcalo en null omita para permitir suscripciones ilimitadas por usuario. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor de false. int
terms Términos de uso del producto. Los desarrolladores que traten de suscribirse al producto verán y deberán aceptar estos términos para poder completar el proceso de suscripción. string