Compartilhar via

Serviço/apis Microsoft.ApiManagement

  • Artigo

Definição de recurso do Bicep

O tipo de recurso service/apis pode ser implantado com operações direcionadas:

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

Formato de recurso

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

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

service/apis

Nome Descrição Valor
name 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:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere 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 para o recurso do tipo: serviço
properties Criação de entidade de API de 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 string
apiRevisionDescription Descrição da Revisão da API. string
apiType Tipo de API a ser criada.
* http cria uma API REST
* soap cria uma API de passagem SOAP
* websocket cria a API websocket
* graphqlcria GraphQL API.
Novos tipos podem ser adicionados no futuro.		 'graphql'
'grpc'
'http'
'odata'
'soap'
'websocket'
apiVersion Indica o identificador de versão da API se a API tiver controle de versão string
apiVersionDescription Descrição da versão da API. string
apiVersionSet Detalhes do conjunto de versões ApiVersionSetContractDetails
apiVersionSetId Um identificador de recurso para o ApiVersionSet relacionado. string
authenticationSettings Coleção de configurações de autenticação incluídas nessa API. AuthenticationSettingsContract
contact Informações de contato para a API. ApiContactInformation
descrição A descrição da API. Pode incluir marcas de formatação HTML. string
displayName Nome da API. Deve ter de 1 a 300 caracteres. string
format Formato do Conteúdo no qual a API está sendo importada. Novos formatos podem ser adicionados no 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 se a revisão de API é a revisão de API atual. bool
license Informações de licença para a API. ApiLicenseInformation
caminho A URL relativa que identifica exclusivamente esta 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)
protocols Descreve em quais protocolos as operações nessa API podem ser invocadas. Matriz de cadeia de caracteres que contém qualquer um dos:
'http'
'https'
'ws'
'wss'
serviceUrl A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2.000 caracteres. string
sourceApiId Identificador de API da API de origem. string
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. string
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' 'query'
'template'
tipo Tipo de API. 'graphql'
'grpc'
'http'
'odata'
'soap'
'websocket'
value Valor do conteúdo ao importar uma API. string
wsdlSelector Critérios para limitar a importação do WSDL a um subconjunto do documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

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

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. string
scope escopo de operações. string

OpenIdAuthenticationSettingsContract

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

ApiContactInformation

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

ApiLicenseInformation

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

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

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

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 um modelo

Implantar no Azure		 Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar subentidades
Criar o Azure Front Door na frente do Azure Gerenciamento de API

Implantar no Azure		 Este exemplo demonstra como usar o Azure Front Door como um balanceador de carga global na frente do Azure Gerenciamento de API.

Definição de recurso de modelo do ARM

O tipo de recurso service/apis pode ser implantado com operações direcionadas:

Para obter uma lista das propriedades alteradas em cada versão da API, consulte 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": "2023-05-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 propriedade

service/apis

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.ApiManagement/service/apis'
apiVersion A versão da API do recurso '2023-05-01-preview'
name 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:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
properties Criação de entidade de API de 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 string
apiRevisionDescription Descrição da Revisão de API. string
apiType Tipo de API a ser criada.
* http cria uma API REST
* soap cria uma API de passagem SOAP
* websocket cria a API websocket
* graphqlcria GraphQL API.
Novos tipos podem ser adicionados no futuro.		 'graphql'
'grpc'
'http'
'odata'
'soap'
'websocket'
apiVersion Indica o identificador de versão da API se a API for versão string
apiVersionDescription Descrição da versão da API. string
apiVersionSet Detalhes do conjunto de versões ApiVersionSetContractDetails
apiVersionSetId Um identificador de recurso para o ApiVersionSet relacionado. string
authenticationSettings Coleção de configurações de autenticação incluídas nessa API. AuthenticationSettingsContract
contact Informações de contato para a API. ApiContactInformation
descrição A descrição da API. Pode incluir marcas de formatação HTML. string
displayName Nome da API. Deve ter de 1 a 300 caracteres. string
format Formato do Conteúdo no qual a API está sendo importada. Novos formatos podem ser adicionados no 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 se a revisão da API é a revisão de API atual. bool
license Informações de licença para a API. ApiLicenseInformation
caminho A URL relativa que identifica exclusivamente esta 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)
protocols Descreve em quais protocolos as operações nessa API podem ser invocadas. Matriz de cadeia de caracteres que contém qualquer um dos:
'http'
'https'
'ws'
'wss'
serviceUrl A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2.000 caracteres. string
sourceApiId Identificador de API da API de origem. string
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. string
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' 'query'
'template'
tipo Tipo de API. 'graphql'
'grpc'
'http'
'odata'
'soap'
'websocket'
value Valor de conteúdo ao importar uma API. string
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. string
id Identificador do Conjunto de Versões da API existente. Omita esse valor para criar um novo Conjunto de Versões. string
name O nome de exibição do conjunto de versões da API. string
versionHeaderName Nome do parâmetro de cabeçalho HTTP que indica a versão da API se versioningScheme estiver definido como header. string
versioningScheme Um valor que determina onde o identificador de Versão da API estará localizado em uma solicitação HTTP. 'Header'
'Query'
'Segment'
versionQueryName Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como query. string

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. string
scope escopo de operações. string

OpenIdAuthenticationSettingsContract

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

ApiContactInformation

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

ApiLicenseInformation

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

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

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

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 um modelo

Implantar no Azure		 Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar subentidades
Criar o Azure Front Door na frente do Azure Gerenciamento de API

Implantar no Azure		 Este exemplo demonstra como usar o Azure Front Door como um balanceador de carga global na frente do Azure Gerenciamento de API.

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

O tipo de recurso service/apis pode ser implantado com operações direcionadas:

  • Grupos de recursos

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

Formato de recurso

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

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

service/apis

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.ApiManagement/service/apis@2023-05-01-preview"
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: serviço
properties Criação de entidade de API de 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 string
apiRevisionDescription Descrição da Revisão da API. string
apiType Tipo de API a ser criada.
* http cria uma API REST
* soap cria uma API de passagem SOAP
* websocket cria a API websocket
* graphqlcria GraphQL API.
Novos tipos podem ser adicionados no futuro.		 "graphql"
"grpc"
"http"
"odata"
"soap"
"websocket"
apiVersion Indica o identificador de versão da API se a API for versão string
apiVersionDescription Descrição da versão da API. string
apiVersionSet Detalhes do conjunto de versões ApiVersionSetContractDetails
apiVersionSetId Um identificador de recurso para o ApiVersionSet relacionado. string
authenticationSettings Coleção de configurações de autenticação incluídas nessa API. AuthenticationSettingsContract
contact Informações de contato para a API. ApiContactInformation
descrição A descrição da API. Pode incluir marcas de formatação HTML. string
displayName Nome da API. Deve ter de 1 a 300 caracteres. string
format Formato do Conteúdo no qual a API está sendo importada. Novos formatos podem ser adicionados no 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 se a revisão da API é a revisão de API atual. bool
license Informações de licença para a API. ApiLicenseInformation
caminho A URL relativa que identifica exclusivamente esta 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)
protocols Descreve em quais protocolos as operações nessa API podem ser invocadas. Matriz de cadeia de caracteres que contém qualquer um dos:
"http"
"https"
"ws"
"wss"
serviceUrl A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2.000 caracteres. string
sourceApiId Identificador de API da API de origem. string
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. string
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' "query"
"template"
tipo Tipo de API. "graphql"
"grpc"
"http"
"odata"
"soap"
"websocket"
value Valor de conteúdo ao importar uma API. string
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. string
id Identificador do Conjunto de Versões da API existente. Omita esse valor para criar um novo Conjunto de Versões. string
name O nome de exibição do conjunto de versões da API. string
versionHeaderName Nome do parâmetro de cabeçalho HTTP que indica a Versão da API se versioningScheme estiver definido como header. string
versioningScheme Um valor que determina onde o identificador de Versão da API estará localizado em uma solicitação HTTP. “Cabeçalho”
"Consulta"
"Segmento"
versionQueryName Nome do parâmetro de consulta que indica a Versão da API se versioningScheme estiver definido querycomo . string

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. string
scope escopo de operações. string

OpenIdAuthenticationSettingsContract

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

ApiContactInformation

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

ApiLicenseInformation

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

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

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