Servicio Microsoft.ApiManagement/apis 2022-04-01-preview

Artículo
01/18/2024

Definición de recursos de Bicep

El tipo de recurso service/apis se puede implementar con operaciones destinadas a:

Grupos de recursos: consulte los comandos de implementación del grupo 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/apis, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2022-04-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      name: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      oAuth2AuthenticationSettings: [
        {
          authorizationServerId: 'string'
          scope: 'string'
        }
      ]
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
      openidAuthenticationSettings: [
        {
          bearerTokenSendingMethods: [
            'string'
          ]
          openidProviderId: 'string'
        }
      ]
    }
    contact: {
      email: 'string'
      name: 'string'
      url: 'string'
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    license: {
      name: 'string'
      url: 'string'
    }
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    termsOfServiceUrl: 'string'
    translateRequiredQueryParameters: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Valores de propiedad

service/apis

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	Creación de entidades de API de propiedades de actualización.	ApiCreateOrUpdatePropertiesOrApiContractProperties

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.	string
apiRevisionDescription	Descripción de la revisión de la API.	string
apiType	Tipo de API que se va a crear. * `http` crea una API REST * `soap` crea una API de paso a través de SOAP * `websocket` crea websocket API * `graphql` crea GraphQL API.	'graphql' 'http' 'soap' 'websocket'
apiVersion	Indica el identificador de versión de la API si la API tiene versiones	string
apiVersionDescription	Descripción de la versión de la API.	string
apiVersionSet	Detalles del conjunto de versiones	ApiVersionSetContractDetails
apiVersionSetId	Identificador de recurso para apiVersionSet relacionado.	string
authenticationSettings	Colección de opciones de configuración de autenticación incluidas en esta API.	AuthenticationSettingsContract
contact	Información de contacto de la API.	ApiContactInformation
description	Descripción de la API. Puede incluir etiquetas de formato HTML.	string
DisplayName	Nombre de la API. Debe tener entre 1 y 300 caracteres.	string
format	Formato del contenido en el que se importa la API.	'graphql-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	Indica si la revisión de la API es la revisión de api actual.	bool
license	Información de licencia de la API.	ApiLicenseInformation
path	Dirección URL relativa que identifica de forma única esta API y todas las rutas de acceso a sus recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API que se especificó durante la creación de la instancia de servicio para formar una dirección URL pública para esta API.	string (obligatorio)
protocols	Describe en qué protocolos se pueden invocar las operaciones en esta API.	Matriz de cadenas que contiene cualquiera de: 'http' 'https' 'ws' 'wss'
serviceUrl	Dirección URL absoluta del servicio back-end que implementa esta API. No puede tener más de 2000 caracteres.	string
sourceApiId	Identificador de API de la API de origen.	string
subscriptionKeyParameterNames	Protocolos sobre los que está disponible la API.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Especifica si se requiere una suscripción de API o Producto para acceder a la API.	bool
termsOfServiceUrl	Una dirección URL a los Términos de servicio de la API. DEBE tener el formato de una dirección URL.	string
translateRequiredQueryParameters	Estrategia para traducir los parámetros de consulta necesarios a los de plantilla. De forma predeterminada, tiene el valor "template". Valores posibles: 'template', 'query'	'query' 'template'
tipo	Tipo de API.	'graphql' 'http' 'soap' 'websocket'
value	Valor de contenido al importar una API.	string
wsdlSelector	Criterios para limitar la importación de WSDL a un subconjunto del documento.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nombre	Descripción	Valor
description	Descripción del conjunto de versiones de API.	string
id	Identificador del conjunto de versiones de API existente. Omita este valor para crear un nuevo conjunto de versiones.	string
name	Nombre para mostrar del conjunto de versiones de la API.	string
versionHeaderName	Nombre del parámetro de encabezado HTTP que indica la versión de la API si versioningScheme está establecido `header`en .	string
control de versionesScheme	Valor que determina dónde se ubicará el identificador de la versión de API en una solicitud HTTP.	'Encabezado' 'Consulta' 'Segment'
versionQueryName	Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en `query`.	string

AuthenticationSettingsContract

Nombre	Descripción	Valor
oAuth2	Configuración de autenticación de OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Colección de la configuración de autenticación de OAuth2 incluida en esta API.	OAuth2AuthenticationSettingsContract[]
openid	Configuración de autenticación de OpenID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Colección de la configuración de autenticación de Open ID Connect incluida en esta API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

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

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.	string

ApiContactInformation

Nombre	Descripción	Valor
email	Dirección de correo electrónico de la persona o organización de contacto. DEBE tener el formato de una dirección de correo electrónico.	string
name	El nombre de identificación de la persona o organización de contacto	string
url	Dirección URL que apunta a la información de contacto. DEBE tener el formato de una dirección URL.	string

ApiLicenseInformation

Nombre	Descripción	Value
name	Nombre de licencia usado para la API	string
url	Dirección URL de la licencia usada para la API. DEBE tener el formato de una dirección URL.	string

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

Nombre	Descripción	Valor
wsdlEndpointName	Nombre del punto de conexión (puerto) que se va a importar desde WSDL	string
wsdlServiceName	Nombre del servicio que se va a importar desde WSDL	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	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	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/apis se puede implementar con operaciones destinadas a:

Grupos de recursos: consulte los comandos de implementación del grupo 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/apis, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2022-04-01-preview",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "name": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "string",
          "scope": "string"
        }
      ],
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      },
      "openidAuthenticationSettings": [
        {
          "bearerTokenSendingMethods": [ "string" ],
          "openidProviderId": "string"
        }
      ]
    },
    "contact": {
      "email": "string",
      "name": "string",
      "url": "string"
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "license": {
      "name": "string",
      "url": "string"
    },
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "termsOfServiceUrl": "string",
    "translateRequiredQueryParameters": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Valores de propiedad

service/apis

Nombre	Descripción	Value
type	Tipo de recurso	"Microsoft.ApiManagement/service/apis"
apiVersion	La versión de la API de recursos	"2022-04-01-preview"
name	El nombre del recurso Consulte 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	Creación de entidades de API de propiedades de actualización.	ApiCreateOrUpdatePropertiesOrApiContractProperties

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.	string
apiRevisionDescription	Descripción de la revisión de la API.	string
apiType	Tipo de API que se va a crear. * `http` crea una API REST * `soap` crea una API de paso a través de SOAP * `websocket` crea websocket API * `graphql` crea GraphQL API.	'graphql' 'http' 'soap' 'websocket'
apiVersion	Indica el identificador de versión de la API si la API tiene versiones	string
apiVersionDescription	Descripción de la versión de la API.	string
apiVersionSet	Detalles del conjunto de versiones	ApiVersionSetContractDetails
apiVersionSetId	Identificador de recurso para apiVersionSet relacionado.	string
authenticationSettings	Colección de opciones de configuración de autenticación incluidas en esta API.	AuthenticationSettingsContract
contact	Información de contacto de la API.	ApiContactInformation
description	Descripción de la API. Puede incluir etiquetas de formato HTML.	string
DisplayName	Nombre de la API. Debe tener entre 1 y 300 caracteres.	string
format	Formato del contenido en el que se importa la API.	'graphql-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	Indica si la revisión de la API es la revisión de api actual.	bool
license	Información de licencia de la API.	ApiLicenseInformation
path	Dirección URL relativa que identifica de forma única esta API y todas las rutas de acceso a sus recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API que se especificó durante la creación de la instancia de servicio para formar una dirección URL pública para esta API.	string (obligatorio)
protocols	Describe en qué protocolos se pueden invocar las operaciones en esta API.	Matriz de cadenas que contiene cualquiera de: 'http' 'https' 'ws' 'wss'
serviceUrl	Dirección URL absoluta del servicio back-end que implementa esta API. No puede tener más de 2000 caracteres.	string
sourceApiId	Identificador de API de la API de origen.	string
subscriptionKeyParameterNames	Protocolos sobre los que está disponible la API.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Especifica si se requiere una suscripción de API o Producto para acceder a la API.	bool
termsOfServiceUrl	Una dirección URL a los Términos de servicio de la API. DEBE tener el formato de una dirección URL.	string
translateRequiredQueryParameters	Estrategia para traducir los parámetros de consulta necesarios a los de plantilla. De forma predeterminada, tiene el valor "template". Valores posibles: 'template', 'query'	'query' 'template'
tipo	Tipo de API.	'graphql' 'http' 'soap' 'websocket'
value	Valor de contenido al importar una API.	string
wsdlSelector	Criterios para limitar la importación de WSDL a un subconjunto del documento.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nombre	Descripción	Valor
description	Descripción del conjunto de versiones de API.	string
id	Identificador del conjunto de versiones de API existente. Omita este valor para crear un nuevo conjunto de versiones.	string
name	Nombre para mostrar del conjunto de versiones de la API.	string
versionHeaderName	Nombre del parámetro de encabezado HTTP que indica la versión de la API si versioningScheme está establecido `header`en .	string
control de versionesScheme	Valor que determina dónde se ubicará el identificador de la versión de API en una solicitud HTTP.	'Encabezado' 'Consulta' 'Segment'
versionQueryName	Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en `query`.	string

AuthenticationSettingsContract

Nombre	Descripción	Valor
oAuth2	Configuración de autenticación de OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Colección de la configuración de autenticación de OAuth2 incluida en esta API.	OAuth2AuthenticationSettingsContract[]
openid	Configuración de autenticación de OpenID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Colección de la configuración de autenticación de Open ID Connect incluida en esta API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

Nombre	Descripción	Valor
bearerTokenSendingMethods	Cómo enviar un token al servidor.	Matriz de cadenas que contiene cualquiera de: 'authorizationHeader' 'query'
openidProviderId	Identificador del servidor de autorización de OAuth.	string

ApiContactInformation

Nombre	Descripción	Valor
email	Dirección de correo electrónico de la persona o organización de contacto. DEBE tener el formato de una dirección de correo electrónico.	string
name	Nombre de identificación de la persona o organización de contacto	string
url	Dirección URL que apunta a la información de contacto. DEBE estar en el formato de una dirección URL.	string

ApiLicenseInformation

Nombre	Descripción	Value
name	Nombre de licencia usado para la API	string
url	Dirección URL de la licencia usada para la API. DEBE estar en el formato de una dirección URL.	string

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

Nombre	Descripción	Valor
wsdlEndpointName	Nombre del punto de conexión (puerto) que se va a importar desde WSDL	string
wsdlServiceName	Nombre del servicio que se va a importar desde WSDL	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	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	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/apis 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/apis, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2022-04-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        name = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        oAuth2AuthenticationSettings = [
          {
            authorizationServerId = "string"
            scope = "string"
          }
        ]
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
        openidAuthenticationSettings = [
          {
            bearerTokenSendingMethods = [
              "string"
            ]
            openidProviderId = "string"
          }
        ]
      }
      contact = {
        email = "string"
        name = "string"
        url = "string"
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      license = {
        name = "string"
        url = "string"
      }
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      termsOfServiceUrl = "string"
      translateRequiredQueryParameters = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Valores de propiedad

service/apis

Nombre	Descripción	Value
type	Tipo de recurso	"Microsoft.ApiManagement/service/apis@2022-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	Creación de entidades de API de propiedades de actualización.	ApiCreateOrUpdatePropertiesOrApiContractProperties

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 predeterminada 1.	string
apiRevisionDescription	Descripción de la revisión de la API.	string
apiType	Tipo de API que se va a crear. * `http` crea una API REST * `soap` crea una API de paso a través de SOAP * `websocket` crea websocket API * `graphql` crea GraphQL API.	"graphql" "http" "soap" "websocket"
apiVersion	Indica el identificador de versión de la API si la API tiene versiones	string
apiVersionDescription	Descripción de la versión de la API.	string
apiVersionSet	Detalles del conjunto de versiones	ApiVersionSetContractDetails
apiVersionSetId	Identificador de recurso para apiVersionSet relacionado.	string
authenticationSettings	Recopilación de la configuración de autenticación incluida en esta API.	AuthenticationSettingsContract
contact	Información de contacto de la API.	ApiContactInformation
description	Descripción de la API. Puede incluir etiquetas de formato HTML.	string
DisplayName	Nombre de la API. Debe tener entre 1 y 300 caracteres.	string
format	Formato del contenido en el que se importa la API.	"graphql-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link"
isCurrent	Indica si la revisión de API es la revisión de API actual.	bool
license	Información de licencia de la API.	ApiLicenseInformation
path	Dirección URL relativa que identifica de forma única esta API y todas las rutas de acceso a sus recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API que se especificó durante la creación de la instancia de servicio para formar una dirección URL pública para esta API.	string (obligatorio)
protocols	Describe en qué protocolos se pueden invocar las operaciones en esta API.	Matriz de cadenas que contiene cualquiera de: "http" "https" "ws" "wss"
serviceUrl	Dirección URL absoluta del servicio back-end que implementa esta API. No puede tener más de 2000 caracteres de longitud.	string
sourceApiId	Identificador de API de la API de origen.	string
subscriptionKeyParameterNames	Protocolos sobre los que está disponible la API.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Especifica si se requiere una api o una suscripción de producto para acceder a la API.	bool
termsOfServiceUrl	Dirección URL a los Términos de servicio de la API. DEBE tener el formato de una dirección URL.	string
translateRequiredQueryParameters	Estrategia para traducir los parámetros de consulta necesarios a los de plantilla. De forma predeterminada, tiene el valor "template". Valores posibles: 'template', 'query'	"query" "template"
tipo	Tipo de API.	"graphql" "http" "soap" "websocket"
value	Valor de contenido al importar una API.	string
wsdlSelector	Criterios para limitar la importación de WSDL a un subconjunto del documento.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nombre	Descripción	Valor
description	Descripción del conjunto de versiones de API.	string
id	Identificador del conjunto de versiones de API existente. Omita este valor para crear un nuevo conjunto de versiones.	string
name	Nombre para mostrar del conjunto de versiones de la API.	string
versionHeaderName	Nombre del parámetro de encabezado HTTP que indica la versión de la API si versioningScheme está establecido `header`en .	string
versioningScheme	Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP.	"Header" "Consulta" "Segmento"
versionQueryName	Nombre del parámetro de consulta que indica la versión de la API si versioningScheme está establecido `query`en .	string

AuthenticationSettingsContract

Nombre	Descripción	Valor
oAuth2	Configuración de autenticación de OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Colección de la configuración de autenticación de OAuth2 incluida en esta API.	OAuth2AuthenticationSettingsContract[]
openid	Configuración de autenticación de OpenID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Colección de la configuración de autenticación de Open ID Connect incluida en esta API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

Nombre	Descripción	Valor
bearerTokenSendingMethods	Cómo enviar un token al servidor.	Matriz de cadenas que contiene cualquiera de: "authorizationHeader" "query"
openidProviderId	Identificador del servidor de autorización de OAuth.	string

ApiContactInformation

Nombre	Descripción	Valor
email	Dirección de correo electrónico de la persona o organización de contacto. DEBE tener el formato de una dirección de correo electrónico.	string
name	Nombre de identificación de la persona o organización de contacto	string
url	Dirección URL que apunta a la información de contacto. DEBE estar en el formato de una dirección URL.	string

ApiLicenseInformation

Nombre	Descripción	Value
name	Nombre de licencia usado para la API	string
url	Dirección URL de la licencia usada para la API. DEBE estar en el formato de una dirección URL.	string

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

Nombre	Descripción	Valor
wsdlEndpointName	Nombre del punto de conexión (puerto) que se va a importar desde WSDL	string
wsdlServiceName	Nombre del servicio que se va a importar desde WSDL	string

Compartir a través de

Servicio Microsoft.ApiManagement/apis 2022-04-01-preview

Definición de recursos de Bicep

Formato de los recursos

Valores de propiedad

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Plantillas de inicio rápido

Definición de recursos de plantilla de ARM

Formato de los recursos

Valores de propiedad

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Plantillas de inicio rápido

Definición de recursos de Terraform (proveedor AzAPI)

Formato de los recursos

Valores de propiedad

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Recursos adicionales