Microsoft.ApiManagement service/workspaces/apis

Artículo
07/24/2024

más reciente
2023-09-01-preview

Definición de recursos de Bicep

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

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

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis@2023-09-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/workspaces/apis

Nombre	Descripción	Valor
nombre	El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.	string (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: áreas de trabajo
Propiedades	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.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 100
apiRevisionDescription	Descripción de la revisión de API.	cuerda Restricciones: Longitud máxima = 256
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 la API de websocket * `graphql` crea GraphQL API. Se pueden agregar nuevos tipos en el futuro.	'graphql' 'grpc' '`http`' 'odata' 'soap' "websocket"
apiVersion	Indica el identificador de versión de la API si la API tiene versiones	cuerda Restricciones: Longitud máxima = 100
apiVersionDescription	Descripción de la versión de la API.	cuerda Restricciones: Longitud máxima = 256
apiVersionSet	Detalles del conjunto de versiones	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
contacto	Información de contacto de la API.	ApiContactInformation
descripción	Descripción de la API. Puede incluir etiquetas de formato HTML.	cuerda
displayName	Nombre de LA API. Debe tener entre 1 y 300 caracteres.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 300
formato	Formato del contenido en el que se va a importar la API. Se pueden agregar nuevos formatos en el futuro	'graphql-link' 'grpc' 'grpc-link' 'odata' 'odata-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
licencia	Información de licencia de la API.	apiLicenseInformation 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.	string (obligatorio) Restricciones: Longitud máxima = 400
protocolos	Describe en qué protocolos se pueden invocar las operaciones de 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.	cuerda Restricciones: Longitud máxima = 2000
sourceApiId	Identificador de API de la API de origen.	cuerda
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 del servicio para la API. DEBE estar en el formato de una dirección URL.	cuerda
translateRequiredQueryParameters	Estrategia de 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' 'grpc' '`http`' 'odata' 'soap' "websocket"
valor	Valor de contenido al importar una API.	cuerda
wsdlSelector	Criterios para limitar la importación de WSDL a un subconjunto del documento.	ApiCreateOrUpdatePropertiesWsdlSelector

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
nombre	Nombre para mostrar del conjunto de versiones de la API.	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
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.	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

ApiContactInformation

Nombre	Descripción	Valor
Correo electrónico	Dirección de correo electrónico de la persona o organización de contacto. DEBE estar en el formato de una dirección de correo electrónico.	cuerda
nombre	Nombre de identificación de la persona o organización de contacto	cuerda
URL	Dirección URL que apunta a la información de contacto. DEBE estar en el formato de una dirección URL.	cuerda

ApiLicenseInformation

Nombre	Descripción	Valor
nombre	Nombre de licencia usado para la API	cuerda
URL	Dirección URL de la licencia usada para la API. DEBE estar en el formato de una dirección URL.	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

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

Definición de recursos de plantilla de ARM

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

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

{
  "type": "Microsoft.ApiManagement/service/workspaces/apis",
  "apiVersion": "2023-09-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/workspaces/apis

Nombre	Descripción	Valor
tipo	El tipo de recurso	'Microsoft.ApiManagement/service/workspaces/apis'
apiVersion	La versión de la API de recursos	'2023-09-01-preview'
nombre	El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.	string (obligatorio)
Propiedades	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.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 100
apiRevisionDescription	Descripción de la revisión de API.	cuerda Restricciones: Longitud máxima = 256
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 la API de websocket * `graphql` crea GraphQL API. Se pueden agregar nuevos tipos en el futuro.	'graphql' 'grpc' '`http`' 'odata' 'soap' "websocket"
apiVersion	Indica el identificador de versión de la API si la API tiene versiones	cuerda Restricciones: Longitud máxima = 100
apiVersionDescription	Descripción de la versión de la API.	cuerda Restricciones: Longitud máxima = 256
apiVersionSet	Detalles del conjunto de versiones	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
contacto	Información de contacto de la API.	ApiContactInformation
descripción	Descripción de la API. Puede incluir etiquetas de formato HTML.	cuerda
displayName	Nombre de LA API. Debe tener entre 1 y 300 caracteres.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 300
formato	Formato del contenido en el que se va a importar la API. Se pueden agregar nuevos formatos en el futuro	'graphql-link' 'grpc' 'grpc-link' 'odata' 'odata-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
licencia	Información de licencia de la API.	apiLicenseInformation 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.	string (obligatorio) Restricciones: Longitud máxima = 400
protocolos	Describe en qué protocolos se pueden invocar las operaciones de 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.	cuerda Restricciones: Longitud máxima = 2000
sourceApiId	Identificador de API de la API de origen.	cuerda
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 del servicio para la API. DEBE estar en el formato de una dirección URL.	cuerda
translateRequiredQueryParameters	Estrategia de 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' 'grpc' '`http`' 'odata' 'soap' "websocket"
valor	Valor de contenido al importar una API.	cuerda
wsdlSelector	Criterios para limitar la importación de WSDL a un subconjunto del documento.	ApiCreateOrUpdatePropertiesWsdlSelector

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
nombre	Nombre para mostrar del conjunto de versiones de la API.	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
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.	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

ApiContactInformation

Nombre	Descripción	Valor
Correo electrónico	Dirección de correo electrónico de la persona o organización de contacto. DEBE estar en el formato de una dirección de correo electrónico.	cuerda
nombre	Nombre de identificación de la persona o organización de contacto	cuerda
URL	Dirección URL que apunta a la información de contacto. DEBE estar en el formato de una dirección URL.	cuerda

ApiLicenseInformation

Nombre	Descripción	Valor
nombre	Nombre de licencia usado para la API	cuerda
URL	Dirección URL de la licencia usada para la API. DEBE estar en el formato de una dirección URL.	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

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

Definición de recursos de Terraform (proveedor AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/apis@2023-09-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/workspaces/apis

Nombre	Descripción	Valor
tipo	El tipo de recurso	"Microsoft.ApiManagement/service/workspaces/apis@2023-09-01-preview"
nombre	El nombre del recurso	string (obligatorio)
parent_id	Identificador del recurso que es el elemento primario de este recurso.	Identificador del recurso de tipo: áreas de trabajo
Propiedades	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.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 100
apiRevisionDescription	Descripción de la revisión de API.	cuerda Restricciones: Longitud máxima = 256
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 la API de websocket * `graphql` crea GraphQL API. Se pueden agregar nuevos tipos en el futuro.	"graphql" "grpc" "`http`" "odata" "soap" "websocket"
apiVersion	Indica el identificador de versión de la API si la API tiene versiones	cuerda Restricciones: Longitud máxima = 100
apiVersionDescription	Descripción de la versión de la API.	cuerda Restricciones: Longitud máxima = 256
apiVersionSet	Detalles del conjunto de versiones	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
contacto	Información de contacto de la API.	ApiContactInformation
descripción	Descripción de la API. Puede incluir etiquetas de formato HTML.	cuerda
displayName	Nombre de LA API. Debe tener entre 1 y 300 caracteres.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 300
formato	Formato del contenido en el que se va a importar la API. Se pueden agregar nuevos formatos en el futuro	"graphql-link" "grpc" "grpc-link" "odata" "odata-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
licencia	Información de licencia de la API.	apiLicenseInformation 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.	string (obligatorio) Restricciones: Longitud máxima = 400
protocolos	Describe en qué protocolos se pueden invocar las operaciones de 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.	cuerda Restricciones: Longitud máxima = 2000
sourceApiId	Identificador de API de la API de origen.	cuerda
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 del servicio para la API. DEBE estar en el formato de una dirección URL.	cuerda
translateRequiredQueryParameters	Estrategia de traducir los parámetros de consulta necesarios a los de plantilla. De forma predeterminada, tiene el valor "template". Valores posibles: 'template', 'query'	"query" "plantilla"
tipo	Tipo de API.	"graphql" "grpc" "`http`" "odata" "soap" "websocket"
valor	Valor de contenido al importar una API.	cuerda
wsdlSelector	Criterios para limitar la importación de WSDL a un subconjunto del documento.	ApiCreateOrUpdatePropertiesWsdlSelector

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
nombre	Nombre para mostrar del conjunto de versiones de la API.	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" "Consulta" "Segmento"
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
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.	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

ApiContactInformation

Nombre	Descripción	Valor
Correo electrónico	Dirección de correo electrónico de la persona o organización de contacto. DEBE estar en el formato de una dirección de correo electrónico.	cuerda
nombre	Nombre de identificación de la persona o organización de contacto	cuerda
URL	Dirección URL que apunta a la información de contacto. DEBE estar en el formato de una dirección URL.	cuerda

ApiLicenseInformation

Nombre	Descripción	Valor
nombre	Nombre de licencia usado para la API	cuerda
URL	Dirección URL de la licencia usada para la API. DEBE estar en el formato de una dirección URL.	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

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

Compartir a través de

Microsoft.ApiManagement service/workspaces/apis

Definición de recursos de Bicep

Formato de recurso

Valores de propiedad

service/workspaces/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Definición de recursos de plantilla de ARM

Formato de recurso

Valores de propiedad

service/workspaces/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso

Valores de propiedad

service/workspaces/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Comentarios

Recursos adicionales