Compartir a través de

Servicio Microsoft.ApiManagement/apis 2018-01-01

  • Artículo

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.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2018-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
      subscriptionKeyRequired: bool
    }
    contentFormat: 'string'
    contentValue: 'string'
    description: 'string'
    displayName: 'string'
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    type: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Valores de propiedad

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nombre Descripción Valor
apiRevision Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión 1 predeterminada. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
apiRevisionDescription Descripción de la revisión de api. cuerda

Restricciones:
Longitud máxima =
apiType Tipo de API que se va a crear.
* http crea una API DE SOAP a REST
* soap crea una API de paso a través de SOAP.		 'http'
'soap'
apiVersion Indica el identificador de versión de la API si la API tiene versiones cuerda

Restricciones:
Longitud máxima =
apiVersionDescription Descripción de la versión de api. cuerda

Restricciones:
Longitud máxima =
apiVersionSet Un conjunto de versiones de API contiene la configuración común de un conjunto de versiones de API relacionadas. apiVersionSetContractDetails
apiVersionSetId Identificador de recurso para apiVersionSet relacionado. cuerda
authenticationSettings Colección de opciones de configuración de autenticación incluidas en esta API. AuthenticationSettingsContract
contentFormat Formato del contenido en el que se va a importar la API. "swagger-json"
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
contentValue Valor de contenido al importar una API. cuerda
descripción Descripción de la API. Puede incluir etiquetas de formato HTML. cuerda
displayName Nombre de LA API. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
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 = (obligatorio)
protocolos Describe en qué protocolos se pueden invocar las operaciones de esta API. Matriz de cadenas que contiene cualquiera de:
'http'
'https'
serviceUrl Dirección URL absoluta del servicio back-end que implementa esta API. cuerda

Restricciones:
Longitud máxima =
subscriptionKeyParameterNames Protocolos sobre los que está disponible la API. SubscriptionKeyParameterNamesContract
tipo Tipo de API. 'http'
'soap'
wsdlSelector Criterios para limitar la importación de WSDL a un subconjunto del documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

Nombre Descripción Valor
wsdlEndpointName Nombre de endpoint(port) que se va a importar desde WSDL cuerda
wsdlServiceName Nombre del servicio que se va a importar desde WSDL cuerda

ApiVersionSetContractDetails

Nombre Descripción Valor
descripción Descripción del conjunto de versiones de API. cuerda
identificación Identificador del conjunto de versiones de API existente. Omita este valor para crear un nuevo conjunto de versiones. cuerda
versionHeaderName Nombre del parámetro de encabezado HTTP que indica la versión de API si versioningScheme está establecido en header. cuerda
versioningScheme Valor que determina dónde se ubicará el identificador de la versión de LA API en una solicitud HTTP. 'Encabezado'
'Query'
'Segment'
versionQueryName Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en query. cuerda

AuthenticationSettingsContract

Nombre Descripción Valor
oAuth2 Configuración de autenticación de OAuth2 OAuth2AuthenticationSettingsContract
openid Configuración de autenticación de OpenID Connect openIdAuthenticationSettingsContract
subscriptionKeyRequired Especifica si se requiere la clave de suscripción durante la llamada a esta API, true: la API solo se incluye en productos cerrados, false: la API se incluye solo en productos abiertos, null; hay una combinación de productos. Bool

Microsoft.ApiManagement/service/apis

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
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 Creación de entidades de API de propiedades de actualización. ApiCreateOrUpdatePropertiesOrApiContractProperties

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

Nombre Descripción Valor
bearerTokenSendingMethods Cómo enviar el token al servidor. Matriz de cadenas que contiene cualquiera de:
'authorizationHeader'
'query'
openidProviderId Identificador del servidor de autorización de OAuth. 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.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2018-01-01",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      },
      "subscriptionKeyRequired": "bool"
    },
    "contentFormat": "string",
    "contentValue": "string",
    "description": "string",
    "displayName": "string",
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "type": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Valores de propiedad

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nombre Descripción Valor
apiRevision Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión 1 predeterminada. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
apiRevisionDescription Descripción de la revisión de api. cuerda

Restricciones:
Longitud máxima =
apiType Tipo de API que se va a crear.
* http crea una API DE SOAP a REST
* soap crea una API de paso a través de SOAP.		 'http'
'soap'
apiVersion Indica el identificador de versión de la API si la API tiene versiones cuerda

Restricciones:
Longitud máxima =
apiVersionDescription Descripción de la versión de api. cuerda

Restricciones:
Longitud máxima =
apiVersionSet Un conjunto de versiones de API contiene la configuración común de un conjunto de versiones de API relacionadas. apiVersionSetContractDetails
apiVersionSetId Identificador de recurso para apiVersionSet relacionado. cuerda
authenticationSettings Colección de opciones de configuración de autenticación incluidas en esta API. AuthenticationSettingsContract
contentFormat Formato del contenido en el que se va a importar la API. "swagger-json"
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
contentValue Valor de contenido al importar una API. cuerda
descripción Descripción de la API. Puede incluir etiquetas de formato HTML. cuerda
displayName Nombre de LA API. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
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 = (obligatorio)
protocolos Describe en qué protocolos se pueden invocar las operaciones de esta API. Matriz de cadenas que contiene cualquiera de:
'http'
'https'
serviceUrl Dirección URL absoluta del servicio back-end que implementa esta API. cuerda

Restricciones:
Longitud máxima =
subscriptionKeyParameterNames Protocolos sobre los que está disponible la API. SubscriptionKeyParameterNamesContract
tipo Tipo de API. 'http'
'soap'
wsdlSelector Criterios para limitar la importación de WSDL a un subconjunto del documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

Nombre Descripción Valor
wsdlEndpointName Nombre de endpoint(port) que se va a importar desde WSDL cuerda
wsdlServiceName Nombre del servicio que se va a importar desde WSDL cuerda

ApiVersionSetContractDetails

Nombre Descripción Valor
descripción Descripción del conjunto de versiones de API. cuerda
identificación Identificador del conjunto de versiones de API existente. Omita este valor para crear un nuevo conjunto de versiones. cuerda
versionHeaderName Nombre del parámetro de encabezado HTTP que indica la versión de API si versioningScheme está establecido en header. cuerda
versioningScheme Valor que determina dónde se ubicará el identificador de la versión de LA API en una solicitud HTTP. 'Encabezado'
'Query'
'Segment'
versionQueryName Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en query. cuerda

AuthenticationSettingsContract

Nombre Descripción Valor
oAuth2 Configuración de autenticación de OAuth2 OAuth2AuthenticationSettingsContract
openid Configuración de autenticación de OpenID Connect openIdAuthenticationSettingsContract
subscriptionKeyRequired Especifica si se requiere la clave de suscripción durante la llamada a esta API, true: la API solo se incluye en productos cerrados, false: la API se incluye solo en productos abiertos, null; hay una combinación de productos. Bool

Microsoft.ApiManagement/service/apis

Nombre Descripción Valor
apiVersion La versión de api '2018-01-01'
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = ^[^*#&+:<>?]+$ (obligatorio)
Propiedades Creación de entidades de API de propiedades de actualización. ApiCreateOrUpdatePropertiesOrApiContractProperties
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

OpenIdAuthenticationSettingsContract

Nombre Descripción Valor
bearerTokenSendingMethods Cómo enviar el token al servidor. Matriz de cadenas que contiene cualquiera de:
'authorizationHeader'
'query'
openidProviderId Identificador del servidor de autorización de OAuth. 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 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.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2018-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
        subscriptionKeyRequired = bool
      }
      contentFormat = "string"
      contentValue = "string"
      description = "string"
      displayName = "string"
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      type = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Valores de propiedad

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nombre Descripción Valor
apiRevision Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión 1 predeterminada. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
apiRevisionDescription Descripción de la revisión de api. cuerda

Restricciones:
Longitud máxima =
apiType Tipo de API que se va a crear.
* http crea una API DE SOAP a REST
* soap crea una API de paso a través de SOAP.		 'http'
'soap'
apiVersion Indica el identificador de versión de la API si la API tiene versiones cuerda

Restricciones:
Longitud máxima =
apiVersionDescription Descripción de la versión de api. cuerda

Restricciones:
Longitud máxima =
apiVersionSet Un conjunto de versiones de API contiene la configuración común de un conjunto de versiones de API relacionadas. apiVersionSetContractDetails
apiVersionSetId Identificador de recurso para apiVersionSet relacionado. cuerda
authenticationSettings Colección de opciones de configuración de autenticación incluidas en esta API. AuthenticationSettingsContract
contentFormat Formato del contenido en el que se va a importar la API. "swagger-json"
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
contentValue Valor de contenido al importar una API. cuerda
descripción Descripción de la API. Puede incluir etiquetas de formato HTML. cuerda
displayName Nombre de LA API. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
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 = (obligatorio)
protocolos Describe en qué protocolos se pueden invocar las operaciones de esta API. Matriz de cadenas que contiene cualquiera de:
'http'
'https'
serviceUrl Dirección URL absoluta del servicio back-end que implementa esta API. cuerda

Restricciones:
Longitud máxima =
subscriptionKeyParameterNames Protocolos sobre los que está disponible la API. SubscriptionKeyParameterNamesContract
tipo Tipo de API. 'http'
'soap'
wsdlSelector Criterios para limitar la importación de WSDL a un subconjunto del documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

Nombre Descripción Valor
wsdlEndpointName Nombre de endpoint(port) que se va a importar desde WSDL cuerda
wsdlServiceName Nombre del servicio que se va a importar desde WSDL cuerda

ApiVersionSetContractDetails

Nombre Descripción Valor
descripción Descripción del conjunto de versiones de API. cuerda
identificación Identificador del conjunto de versiones de API existente. Omita este valor para crear un nuevo conjunto de versiones. cuerda
versionHeaderName Nombre del parámetro de encabezado HTTP que indica la versión de API si versioningScheme está establecido en header. cuerda
versioningScheme Valor que determina dónde se ubicará el identificador de la versión de LA API en una solicitud HTTP. 'Encabezado'
'Query'
'Segment'
versionQueryName Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en query. cuerda

AuthenticationSettingsContract

Nombre Descripción Valor
oAuth2 Configuración de autenticación de OAuth2 OAuth2AuthenticationSettingsContract
openid Configuración de autenticación de OpenID Connect openIdAuthenticationSettingsContract
subscriptionKeyRequired Especifica si se requiere la clave de suscripción durante la llamada a esta API, true: la API solo se incluye en productos cerrados, false: la API se incluye solo en productos abiertos, null; hay una combinación de productos. Bool

Microsoft.ApiManagement/service/apis

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
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 Creación de entidades de API de propiedades de actualización. ApiCreateOrUpdatePropertiesOrApiContractProperties
tipo El tipo de recurso "Microsoft.ApiManagement/service/apis@2018-01-01"

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

Nombre Descripción Valor
bearerTokenSendingMethods Cómo enviar el token al servidor. Matriz de cadenas que contiene cualquiera de:
'authorizationHeader'
'query'
openidProviderId Identificador del servidor de autorización de OAuth. 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