Irakurri ingelesez

Partekatu honen bidez:

Servicio Microsoft.ApiManagement/apis 2016-07-07

  • Artikulua
Elección de un idioma de implementación

Definición de recursos de Bicep

El tipo de recurso service/apis se puede implementar con operaciones que tienen como destino:

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/apis, agregue lo siguiente a la plantilla de Bicep.

Bicep 
resource symbolicname 'Microsoft.ApiManagement/service/apis@2016-07-07' = {
  parent: resourceSymbolicName
  authenticationSettings: {
    oAuth2: {
      authorizationServerId: 'string'
      scope: 'string'
    }
  }
  description: 'string'
  name: 'string'
  path: 'string'
  protocols: [
    'string'
  ]
  serviceUrl: 'string'
  subscriptionKeyParameterNames: {
    header: 'string'
    query: 'string'
  }
}

Valores de propiedad

AuthenticationSettingsContract

Nombre Descripción Valor
oAuth2 Detalles de la configuración de autenticación de OAuth2 de API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nombre Descripción Valor
authenticationSettings Colección de opciones de configuración de autenticación incluidas en esta API. AuthenticationSettingsContract
descripción Descripción de la API. Puede incluir etiquetas de formato HTML. cuerda
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 256
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
camino Dirección URL relativa que identifica de forma única esta API y todas sus rutas de acceso de recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API especificada durante la creación de la instancia de servicio para formar una dirección URL pública para esta API. cuerda

Restricciones:
Longitud máxima = 400 (obligatorio)
protocolos Describe en qué protocolos se pueden invocar las operaciones de esta API. Matriz de cadenas que contiene cualquiera de:
'Http'
'Https' (obligatorio)
serviceUrl Dirección URL absoluta del servicio back-end que implementa esta API. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 2000 (obligatorio)
subscriptionKeyParameterNames Protocolos sobre los que está disponible la API. SubscriptionKeyParameterNamesContract

OAuth2AuthenticationSettingsContract

Nombre Descripción Valor
authorizationServerId Identificador del servidor de autorización de OAuth. cuerda
alcance ámbito de operaciones. cuerda

SubscriptionKeyParameterNamesContract

Nombre Descripción Valor
encabezado Nombre del encabezado de clave de suscripción. cuerda
consulta Nombre del parámetro de la cadena de consulta de clave de suscripción. cuerda

Definición de recursos de plantilla de ARM

El tipo de recurso service/apis se puede implementar con operaciones que tienen como destino:

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

JSON 
{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2016-07-07",
  "name": "string",
  "authenticationSettings": {
    "oAuth2": {
      "authorizationServerId": "string",
      "scope": "string"
    }
  },
  "description": "string",
  "path": "string",
  "protocols": [ "string" ],
  "serviceUrl": "string",
  "subscriptionKeyParameterNames": {
    "header": "string",
    "query": "string"
  }
}

Valores de propiedad

AuthenticationSettingsContract

Nombre Descripción Valor
oAuth2 Detalles de la configuración de autenticación de OAuth2 de API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nombre Descripción Valor
apiVersion La versión de api '2016-07-07'
authenticationSettings Colección de opciones de configuración de autenticación incluidas en esta API. AuthenticationSettingsContract
descripción Descripción de la API. Puede incluir etiquetas de formato HTML. cuerda
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 256
Patrón = ^[^*#&+:<>?]+$ (obligatorio)
camino Dirección URL relativa que identifica de forma única esta API y todas sus rutas de acceso de recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API especificada durante la creación de la instancia de servicio para formar una dirección URL pública para esta API. cuerda

Restricciones:
Longitud máxima = 400 (obligatorio)
protocolos Describe en qué protocolos se pueden invocar las operaciones de esta API. Matriz de cadenas que contiene cualquiera de:
'Http'
'Https' (obligatorio)
serviceUrl Dirección URL absoluta del servicio back-end que implementa esta API. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 2000 (obligatorio)
subscriptionKeyParameterNames Protocolos sobre los que está disponible la API. SubscriptionKeyParameterNamesContract
tipo El tipo de recurso "Microsoft.ApiManagement/service/apis"

OAuth2AuthenticationSettingsContract

Nombre Descripción Valor
authorizationServerId Identificador del servidor de autorización de OAuth. cuerda
alcance ámbito de operaciones. cuerda

SubscriptionKeyParameterNamesContract

Nombre Descripción Valor
encabezado Nombre del encabezado de clave de suscripción. cuerda
consulta Nombre del parámetro de la cadena de consulta de clave de suscripción. cuerda

Ejemplos de uso

Definición de recursos de Terraform (proveedor AzAPI)

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

Terraform 
resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2016-07-07"
  name = "string"
  authenticationSettings = {
    oAuth2 = {
      authorizationServerId = "string"
      scope = "string"
    }
  }
  description = "string"
  path = "string"
  protocols = [
    "string"
  ]
  serviceUrl = "string"
  subscriptionKeyParameterNames = {
    header = "string"
    query = "string"
  }
}

Valores de propiedad

AuthenticationSettingsContract

Nombre Descripción Valor
oAuth2 Detalles de la configuración de autenticación de OAuth2 de API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nombre Descripción Valor
authenticationSettings Colección de opciones de configuración de autenticación incluidas en esta API. AuthenticationSettingsContract
descripción Descripción de la API. Puede incluir etiquetas de formato HTML. cuerda
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 256
Patrón = ^[^*#&+:<>?]+$ (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: de servicio de
camino Dirección URL relativa que identifica de forma única esta API y todas sus rutas de acceso de recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API especificada durante la creación de la instancia de servicio para formar una dirección URL pública para esta API. cuerda

Restricciones:
Longitud máxima = 400 (obligatorio)
protocolos Describe en qué protocolos se pueden invocar las operaciones de esta API. Matriz de cadenas que contiene cualquiera de:
'Http'
'Https' (obligatorio)
serviceUrl Dirección URL absoluta del servicio back-end que implementa esta API. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 2000 (obligatorio)
subscriptionKeyParameterNames Protocolos sobre los que está disponible la API. SubscriptionKeyParameterNamesContract
tipo El tipo de recurso "Microsoft.ApiManagement/service/apis@2016-07-07"

OAuth2AuthenticationSettingsContract

Nombre Descripción Valor
authorizationServerId Identificador del servidor de autorización de OAuth. cuerda
alcance ámbito de operaciones. cuerda

SubscriptionKeyParameterNamesContract

Nombre Descripción Valor
encabezado Nombre del encabezado de clave de suscripción. cuerda
consulta Nombre del parámetro de la cadena de consulta de clave de suscripción. cuerda