Serviço/apis Microsoft.ApiManagement 2022-08-01

Artigo
07/24/2024

Definição de recurso do Bicep

O tipo de recurso de serviço/apis pode ser implantado com operações de destino:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/apis, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2022-08-01' = {
  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 propriedade

service/apis

Nome	Descrição	Valor
nome	O nome do recurso Veja como definir nomes e tipos para recursos filho no Bicep.	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Alfanuméricos e hifens. Comece com letra e termine com alfanumérico.
pai	No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai.	Nome simbólico do recurso do tipo: de serviço
Propriedades	A entidade de API cria propriedades de atualização.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nome	Descrição	Valor
apiRevision	Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 100
apiRevisionDescription	Descrição da Revisão da API.	corda Restrições: Comprimento máximo = 256
apiType	Tipo de API a ser criada. * `http` cria uma API REST * `soap` cria uma API de passagem SOAP * `websocket` cria a API websocket * `graphql` cria a API do GraphQL.	'graphql' '`http`' 'soap' 'websocket'
apiVersion	Indica o identificador de versão da API se a API for versão	corda Restrições: Comprimento máximo = 100
apiVersionDescription	Descrição da versão da API.	corda Restrições: Comprimento máximo = 256
apiVersionSet	Detalhes do conjunto de versão	ApiVersionSetContractDetails
apiVersionSetId	Um identificador de recurso para o ApiVersionSet relacionado.	corda
authenticationSettings	Coleção de configurações de autenticação incluídas nessa API.	AuthenticationSettingsContract
contato	Informações de contato para a API.	ApiContactInformation
descrição	Descrição da API. Pode incluir marcas de formatação HTML.	corda
displayName	Nome da API. Deve ter de 1 a 300 caracteres.	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 300
formato	Formato do conteúdo no qual a API está sendo importada.	'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 se a revisão da API é a revisão de API atual.	Bool
licença	Informações de licença para a API.	ApiLicenseInformation
caminho	URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do ponto de extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API.	cadeia de caracteres (obrigatório) Restrições: Comprimento máximo = 400
Protocolos	Descreve em quais protocolos as operações nesta API podem ser invocadas.	Matriz de cadeia de caracteres que contém qualquer um dos: '`http`' '`https`' 'ws' 'wss'
serviceUrl	URL absoluta do serviço de back-end que implementa essa API. Não pode ter mais de 2.000 caracteres.	corda Restrições: Comprimento máximo = 2000
sourceApiId	Identificador de API da API de origem.	corda
subscriptionKeyParameterNames	Protocolos sobre os quais a API é disponibilizada.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Especifica se uma assinatura de API ou produto é necessária para acessar a API.	Bool
termsOfServiceUrl	Uma URL para os Termos de Serviço da API. DEVE estar no formato de uma URL.	corda
translateRequiredQueryParameters	Estratégia de traduzir parâmetros de consulta necessários para os modelos. Por padrão, tem o valor 'template'. Valores possíveis: 'template', 'query'	'consulta' 'template'
tipo	Tipo de API.	'graphql' '`http`' 'soap' 'websocket'
valor	Valor de conteúdo ao importar uma API.	corda
wsdlSelector	Critérios para limitar a importação de WSDL a um subconjunto do documento.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nome	Descrição	Valor
descrição	Descrição do Conjunto de Versões da API.	corda
id	Identificador do Conjunto de Versões da API existente. Omita esse valor para criar um novo Conjunto de Versões.	corda
nome	O nome de exibição do conjunto de versões da API.	corda
versionHeaderName	Nome do parâmetro de cabeçalho HTTP que indica a versão da API se o versioningScheme estiver definido como `header`.	corda
versioningScheme	Um valor que determina onde o identificador de versão da API estará localizado em uma solicitação HTTP.	'Cabeçalho' 'Consulta' 'Segment'
versionQueryName	Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como `query`.	corda

AuthenticationSettingsContract

Nome	Descrição	Valor
oAuth2	Configurações de Autenticação OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Coleção de configurações de autenticação OAuth2 incluídas nessa API.	OAuth2AuthenticationSettingsContract[]
openid	Configurações de autenticação do OpenID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Coleção de configurações de autenticação do Open ID Connect incluídas nessa API.	OpenIdAuthenticationSettingsContract []

OAuth2AuthenticationSettingsContract

Nome	Descrição	Valor
authorizationServerId	Identificador do servidor de autorização OAuth.	corda
âmbito	escopo de operações.	corda

OpenIdAuthenticationSettingsContract

Nome	Descrição	Valor
bearerTokenSendingMethods	Como enviar token para o servidor.	Matriz de cadeia de caracteres que contém qualquer um dos: 'authorizationHeader' 'consulta'
openidProviderId	Identificador do servidor de autorização OAuth.	corda

ApiContactInformation

Nome	Descrição	Valor
Email	O endereço de email da pessoa de contato/organização. DEVE estar no formato de um endereço de email	corda
nome	O nome de identificação da pessoa/organização do contato	corda
url	A URL que aponta para as informações de contato. DEVE estar no formato de uma URL	corda

ApiLicenseInformation

Nome	Descrição	Valor
nome	O nome da licença usado para a API	corda
url	Uma URL para a licença usada para a API. DEVE estar no formato de uma URL	corda

SubscriptionKeyParameterNamesContract

Nome	Descrição	Valor
cabeçalho	Nome do cabeçalho da chave de assinatura.	corda
consulta	Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura.	corda

ApiCreateOrUpdatePropertiesWsdlSelector

Nome	Descrição	Valor
wsdlEndpointName	Nome do ponto de extremidade(porta) a ser importado do WSDL	corda
wsdlServiceName	Nome do serviço a ser importado do WSDL	corda

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
Criar uma instância de Gerenciamento de API e todos os sub-recursos usando de modelo	Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar sub entidades
criar o Azure Front Door em frente ao Gerenciamento de API do Azure	Este exemplo demonstra como usar o Azure Front Door como um balanceador de carga global na frente do Gerenciamento de API do Azure.

Definição de recurso de modelo do ARM

O tipo de recurso de serviço/apis pode ser implantado com operações de destino:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/apis, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2022-08-01",
  "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 propriedade

service/apis

Nome	Descrição	Valor
tipo	O tipo de recurso	'Microsoft.ApiManagement/service/apis'
apiVersion	A versão da API do recurso	'2022-08-01'
nome	O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Alfanuméricos e hifens. Comece com letra e termine com alfanumérico.
Propriedades	A entidade de API cria propriedades de atualização.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nome	Descrição	Valor
apiRevision	Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 100
apiRevisionDescription	Descrição da Revisão da API.	corda Restrições: Comprimento máximo = 256
apiType	Tipo de API a ser criada. * `http` cria uma API REST * `soap` cria uma API de passagem SOAP * `websocket` cria a API websocket * `graphql` cria a API do GraphQL.	'graphql' '`http`' 'soap' 'websocket'
apiVersion	Indica o identificador de versão da API se a API for versão	corda Restrições: Comprimento máximo = 100
apiVersionDescription	Descrição da versão da API.	corda Restrições: Comprimento máximo = 256
apiVersionSet	Detalhes do conjunto de versão	ApiVersionSetContractDetails
apiVersionSetId	Um identificador de recurso para o ApiVersionSet relacionado.	corda
authenticationSettings	Coleção de configurações de autenticação incluídas nessa API.	AuthenticationSettingsContract
contato	Informações de contato para a API.	ApiContactInformation
descrição	Descrição da API. Pode incluir marcas de formatação HTML.	corda
displayName	Nome da API. Deve ter de 1 a 300 caracteres.	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 300
formato	Formato do conteúdo no qual a API está sendo importada.	'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 se a revisão da API é a revisão de API atual.	Bool
licença	Informações de licença para a API.	ApiLicenseInformation
caminho	URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do ponto de extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API.	cadeia de caracteres (obrigatório) Restrições: Comprimento máximo = 400
Protocolos	Descreve em quais protocolos as operações nesta API podem ser invocadas.	Matriz de cadeia de caracteres que contém qualquer um dos: '`http`' '`https`' 'ws' 'wss'
serviceUrl	URL absoluta do serviço de back-end que implementa essa API. Não pode ter mais de 2.000 caracteres.	corda Restrições: Comprimento máximo = 2000
sourceApiId	Identificador de API da API de origem.	corda
subscriptionKeyParameterNames	Protocolos sobre os quais a API é disponibilizada.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Especifica se uma assinatura de API ou produto é necessária para acessar a API.	Bool
termsOfServiceUrl	Uma URL para os Termos de Serviço da API. DEVE estar no formato de uma URL.	corda
translateRequiredQueryParameters	Estratégia de traduzir parâmetros de consulta necessários para os modelos. Por padrão, tem o valor 'template'. Valores possíveis: 'template', 'query'	'consulta' 'template'
tipo	Tipo de API.	'graphql' '`http`' 'soap' 'websocket'
valor	Valor de conteúdo ao importar uma API.	corda
wsdlSelector	Critérios para limitar a importação de WSDL a um subconjunto do documento.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nome	Descrição	Valor
descrição	Descrição do Conjunto de Versões da API.	corda
id	Identificador do Conjunto de Versões da API existente. Omita esse valor para criar um novo Conjunto de Versões.	corda
nome	O nome de exibição do conjunto de versões da API.	corda
versionHeaderName	Nome do parâmetro de cabeçalho HTTP que indica a versão da API se o versioningScheme estiver definido como `header`.	corda
versioningScheme	Um valor que determina onde o identificador de versão da API estará localizado em uma solicitação HTTP.	'Cabeçalho' 'Consulta' 'Segment'
versionQueryName	Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como `query`.	corda

AuthenticationSettingsContract

Nome	Descrição	Valor
oAuth2	Configurações de Autenticação OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Coleção de configurações de autenticação OAuth2 incluídas nessa API.	OAuth2AuthenticationSettingsContract[]
openid	Configurações de autenticação do OpenID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Coleção de configurações de autenticação do Open ID Connect incluídas nessa API.	OpenIdAuthenticationSettingsContract []

OAuth2AuthenticationSettingsContract

Nome	Descrição	Valor
authorizationServerId	Identificador do servidor de autorização OAuth.	corda
âmbito	escopo de operações.	corda

OpenIdAuthenticationSettingsContract

Nome	Descrição	Valor
bearerTokenSendingMethods	Como enviar token para o servidor.	Matriz de cadeia de caracteres que contém qualquer um dos: 'authorizationHeader' 'consulta'
openidProviderId	Identificador do servidor de autorização OAuth.	corda

ApiContactInformation

Nome	Descrição	Valor
Email	O endereço de email da pessoa de contato/organização. DEVE estar no formato de um endereço de email	corda
nome	O nome de identificação da pessoa/organização do contato	corda
url	A URL que aponta para as informações de contato. DEVE estar no formato de uma URL	corda

ApiLicenseInformation

Nome	Descrição	Valor
nome	O nome da licença usado para a API	corda
url	Uma URL para a licença usada para a API. DEVE estar no formato de uma URL	corda

SubscriptionKeyParameterNamesContract

Nome	Descrição	Valor
cabeçalho	Nome do cabeçalho da chave de assinatura.	corda
consulta	Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura.	corda

ApiCreateOrUpdatePropertiesWsdlSelector

Nome	Descrição	Valor
wsdlEndpointName	Nome do ponto de extremidade(porta) a ser importado do WSDL	corda
wsdlServiceName	Nome do serviço a ser importado do WSDL	corda

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
Criar uma instância de Gerenciamento de API e todos os sub-recursos usando de modelo	Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar sub entidades
criar o Azure Front Door em frente ao Gerenciamento de API do Azure	Este exemplo demonstra como usar o Azure Front Door como um balanceador de carga global na frente do Gerenciamento de API do Azure.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso de serviço/apis pode ser implantado com operações de destino:

grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/apis, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2022-08-01"
  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 propriedade

service/apis

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.ApiManagement/service/apis@2022-08-01"
nome	O nome do recurso	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Alfanuméricos e hifens. Comece com letra e termine com alfanumérico.
parent_id	A ID do recurso que é o pai desse recurso.	ID do recurso do tipo: serviço
Propriedades	A entidade de API cria propriedades de atualização.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nome	Descrição	Valor
apiRevision	Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 100
apiRevisionDescription	Descrição da Revisão da API.	corda Restrições: Comprimento máximo = 256
apiType	Tipo de API a ser criada. * `http` cria uma API REST * `soap` cria uma API de passagem SOAP * `websocket` cria a API websocket * `graphql` cria a API do GraphQL.	"graphql" "`http`" "soap" "websocket"
apiVersion	Indica o identificador de versão da API se a API for versão	corda Restrições: Comprimento máximo = 100
apiVersionDescription	Descrição da versão da API.	corda Restrições: Comprimento máximo = 256
apiVersionSet	Detalhes do conjunto de versão	ApiVersionSetContractDetails
apiVersionSetId	Um identificador de recurso para o ApiVersionSet relacionado.	corda
authenticationSettings	Coleção de configurações de autenticação incluídas nessa API.	AuthenticationSettingsContract
contato	Informações de contato para a API.	ApiContactInformation
descrição	Descrição da API. Pode incluir marcas de formatação HTML.	corda
displayName	Nome da API. Deve ter de 1 a 300 caracteres.	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 300
formato	Formato do conteúdo no qual a API está sendo importada.	"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 se a revisão da API é a revisão de API atual.	Bool
licença	Informações de licença para a API.	ApiLicenseInformation
caminho	URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do ponto de extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API.	cadeia de caracteres (obrigatório) Restrições: Comprimento máximo = 400
Protocolos	Descreve em quais protocolos as operações nesta API podem ser invocadas.	Matriz de cadeia de caracteres que contém qualquer um dos: "`http`" "`https`" "ws" "wss"
serviceUrl	URL absoluta do serviço de back-end que implementa essa API. Não pode ter mais de 2.000 caracteres.	corda Restrições: Comprimento máximo = 2000
sourceApiId	Identificador de API da API de origem.	corda
subscriptionKeyParameterNames	Protocolos sobre os quais a API é disponibilizada.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Especifica se uma assinatura de API ou produto é necessária para acessar a API.	Bool
termsOfServiceUrl	Uma URL para os Termos de Serviço da API. DEVE estar no formato de uma URL.	corda
translateRequiredQueryParameters	Estratégia de traduzir parâmetros de consulta necessários para os modelos. Por padrão, tem o valor 'template'. Valores possíveis: 'template', 'query'	"consulta" "modelo"
tipo	Tipo de API.	"graphql" "`http`" "soap" "websocket"
valor	Valor de conteúdo ao importar uma API.	corda
wsdlSelector	Critérios para limitar a importação de WSDL a um subconjunto do documento.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nome	Descrição	Valor
descrição	Descrição do Conjunto de Versões da API.	corda
id	Identificador do Conjunto de Versões da API existente. Omita esse valor para criar um novo Conjunto de Versões.	corda
nome	O nome de exibição do conjunto de versões da API.	corda
versionHeaderName	Nome do parâmetro de cabeçalho HTTP que indica a versão da API se o versioningScheme estiver definido como `header`.	corda
versioningScheme	Um valor que determina onde o identificador de versão da API estará localizado em uma solicitação HTTP.	"Cabeçalho" "Consulta" "Segmentação"
versionQueryName	Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como `query`.	corda

AuthenticationSettingsContract

Nome	Descrição	Valor
oAuth2	Configurações de Autenticação OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Coleção de configurações de autenticação OAuth2 incluídas nessa API.	OAuth2AuthenticationSettingsContract[]
openid	Configurações de autenticação do OpenID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Coleção de configurações de autenticação do Open ID Connect incluídas nessa API.	OpenIdAuthenticationSettingsContract []

OAuth2AuthenticationSettingsContract

Nome	Descrição	Valor
authorizationServerId	Identificador do servidor de autorização OAuth.	corda
âmbito	escopo de operações.	corda

OpenIdAuthenticationSettingsContract

Nome	Descrição	Valor
bearerTokenSendingMethods	Como enviar token para o servidor.	Matriz de cadeia de caracteres que contém qualquer um dos: "authorizationHeader" "consulta"
openidProviderId	Identificador do servidor de autorização OAuth.	corda

ApiContactInformation

Nome	Descrição	Valor
Email	O endereço de email da pessoa de contato/organização. DEVE estar no formato de um endereço de email	corda
nome	O nome de identificação da pessoa/organização do contato	corda
url	A URL que aponta para as informações de contato. DEVE estar no formato de uma URL	corda

ApiLicenseInformation

Nome	Descrição	Valor
nome	O nome da licença usado para a API	corda
url	Uma URL para a licença usada para a API. DEVE estar no formato de uma URL	corda

SubscriptionKeyParameterNamesContract

Nome	Descrição	Valor
cabeçalho	Nome do cabeçalho da chave de assinatura.	corda
consulta	Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura.	corda

ApiCreateOrUpdatePropertiesWsdlSelector

Nome	Descrição	Valor
wsdlEndpointName	Nome do ponto de extremidade(porta) a ser importado do WSDL	corda
wsdlServiceName	Nome do serviço a ser importado do WSDL	corda

Compartilhar via

Serviço/apis Microsoft.ApiManagement 2022-08-01

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Modelos de início rápido

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Modelos de início rápido

Definição de recurso do Terraform (provedor de AzAPI)

Formato de recurso

Valores de propriedade

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Comentários

Recursos adicionais