Serviço/apis Microsoft.ApiManagement
Definição de recurso do Bicep
O tipo de recurso de serviço/apis pode ser implementado com operações que visam:
- Grupos de recursos – veja os comandos de implementação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.ApiManagement/service/apis, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/apis@2023-03-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
serviço/apis
Nome | Descrição | Valor |
---|---|---|
name | O nome do recurso Veja como definir nomes e tipos para recursos subordinados no Bicep. |
cadeia (obrigatório) Limite de carateres: 1-80 Carateres válidos: Alfanuméricos e hífenes. Comece com letra e termine com alfanumérico. |
principal | No Bicep, pode especificar o recurso principal de um recurso subordinado. Só tem de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal. Para obter mais informações, veja Recurso subordinado fora do recurso principal. |
Nome simbólico para recurso do tipo: serviço |
propriedades | Criação de propriedades de atualização da entidade de API. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
ApiCreateOrUpdatePropertiesOrApiContractProperties
Nome | Descrição | Valor |
---|---|---|
apiRevision | Descreve a revisão da API. Se não for fornecido nenhum valor, é criada a revisão predefinida 1 | string |
apiRevisionDescription | Descrição da Revisão da API. | string |
apiType | Tipo de API a criar. * http cria uma API REST* soap cria uma API pass-through SOAP* websocket cria a API websocket* graphql cria a API do GraphQL. Podem ser adicionados novos tipos no futuro. |
'graphql' "http" 'odata' 'soap' 'websocket' |
apiVersion | Indica o identificador de versão da API se a API tiver uma 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 definições de autenticação incluídas nesta API. | AuthenticationSettingsContract |
contacto | Informações de contacto da API. | ApiContactInformation |
descrição | Descrição da API. Pode incluir etiquetas de formatação HTML. | string |
displayName | Nome da API. Tem de ter entre 1 e 300 carateres. | string |
formato | Formato do Conteúdo no qual a API está a ser importada. Podem ser adicionados novos formatos no futuro | "graphql-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 atual da API. | bool |
license | Informações de licença para a API. | ApiLicenseInformation |
caminho | O URL relativo identifica exclusivamente esta API e todos os respetivos caminhos de recursos na instância do serviço Gestão de API. É anexado ao URL base do ponto final da API especificado durante a criação da instância de serviço para formar um URL público para esta API. | cadeia (obrigatório) |
protocolos | Descreve os protocolos que as operações nesta API podem ser invocadas. | Matriz de cadeias que contém qualquer um dos seguintes: "http" 'https' 'ws' 'wss' |
serviceUrl | URL absoluto do serviço de back-end que implementa esta API. Não pode ter mais de 2000 carateres. | string |
sourceApiId | Identificador de API da API de origem. | string |
subscriptionKeyParameterNames | Protocolos sobre os quais a API é disponibilizada. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | Especifica se é necessária uma subscrição de API ou Produto para aceder à API. | bool |
termsOfServiceUrl | Um URL para os Termos de Serviço da API. TEM de estar no formato de um URL. | string |
translateRequiredQueryParameters | Estratégia de tradução dos parâmetros de consulta necessários para os modelos. Por predefinição, tem o valor "modelo". Valores possíveis: "modelo", "consulta" | "consulta" "modelo" |
tipo | Tipo de API. | 'graphql' "http" 'odata' 'soap' 'websocket' |
valor | Valor do conteúdo ao Importar uma API. | string |
wsdlSelector | Critérios para limitar a importação de WSDL para 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 este valor para criar um novo Conjunto de Versões. | string |
name | O Nome a apresentar 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 da Versão da API estará localizado num pedido HTTP. | 'Cabeçalho' "Consulta" "Segmento" |
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 | Definições de Autenticação OAuth2 | OAuth2AuthenticationSettingsContract |
oAuth2AuthenticationSettings | Coleção de definições de autenticação OAuth2 incluídas nesta API. | OAuth2AuthenticationSettingsContract[] |
openid | Definições de Autenticação do OpenID Connect | OpenIdAuthenticationSettingsContract |
openidAuthenticationSettings | Coleção de definições de autenticação Open ID Connect incluídas nesta API. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
Nome | Descrição | Valor |
---|---|---|
authorizationServerId | Identificador do servidor de autorização OAuth. | string |
scope | âmbito de operações. | string |
OpenIdAuthenticationSettingsContract
Nome | Descrição | Valor |
---|---|---|
bearerTokenSendingMethods | Como enviar o token para o servidor. | Matriz de cadeias que contém qualquer um dos seguintes: "authorizationHeader" "consulta" |
openidProviderId | Identificador do servidor de autorização OAuth. | string |
ApiContactInformation
Nome | Descrição | Valor |
---|---|---|
O endereço de e-mail da pessoa/organização do contacto. TEM de estar no formato de um endereço de e-mail | string | |
name | O nome de identificação da pessoa/organização do contacto | string |
url | O URL que aponta para as informações de contacto. TEM de estar no formato de um URL | string |
ApiLicenseInformation
Nome | Descrição | Valor |
---|---|---|
name | O nome da licença utilizado para a API | string |
url | Um URL para a licença utilizada para a API. TEM de estar no formato de um URL | string |
SubscriptionKeyParameterNamesContract
Nome | Descrição | Valor |
---|---|---|
cabeçalho | Nome do cabeçalho da chave de subscrição. | string |
query | Nome do parâmetro da cadeia de consulta da chave de subscrição. | string |
ApiCreateOrUpdatePropertiesWsdlSelector
Nome | Descrição | Valor |
---|---|---|
wsdlEndpointName | Nome do ponto final(porta) a importar do WSDL | string |
wsdlServiceName | Nome do serviço a importar do WSDL | string |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
Modelo | Description |
---|---|
Criar uma instância da Gestão de API e todos os sub-recursos com modelo |
Este modelo demonstra como criar um serviço de Gestão de API e configurar sub entidades |
Criar o Azure Front Door em frente ao Azure Gestão de API |
Este exemplo demonstra como utilizar o Azure Front Door como um balanceador de carga global em frente ao Azure Gestão de API. |
Definição de recurso de modelo do ARM
O tipo de recurso de serviço/apis pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.ApiManagement/service/apis, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2023-03-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
serviço/apis
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de recurso | "Microsoft.ApiManagement/service/apis" |
apiVersion | A versão da API de recursos | "2023-03-01-preview" |
name | O nome do recurso Veja como definir nomes e tipos para recursos subordinados em modelos do ARM JSON. |
cadeia (obrigatório) Limite de carateres: 1-80 Carateres válidos: Alfanuméricos e hífenes. Comece com letra e termine com alfanumérico. |
propriedades | Criação de propriedades de atualização da entidade da API. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
ApiCreateOrUpdatePropertiesOrApiContractProperties
Nome | Descrição | Valor |
---|---|---|
apiRevision | Descreve a revisão da API. Se não for fornecido nenhum valor, é criada a revisão predefinida 1 | string |
apiRevisionDescription | Descrição da Revisão da API. | string |
apiType | Tipo de API a criar. * http cria uma API REST* soap cria uma API pass-through SOAP* websocket cria a API websocket* graphql cria a API GraphQL. Podem ser adicionados novos tipos no futuro. |
'graphql' "http" 'odata' 'soap' 'websocket' |
apiVersion | Indica o identificador de versão da API se a API tiver uma versão | string |
apiVersionDescription | Descrição da Versão da API. | string |
apiVersionSet | Detalhes do conjunto de versões | ApiVersionSetContractDetails |
apiVersionSetId | Um identificador de recursos para o ApiVersionSet relacionado. | string |
authenticationSettings | Coleção de definições de autenticação incluídas nesta API. | AuthenticationSettingsContract |
contacto | Informações de contacto da API. | ApiContactInformation |
descrição | Descrição da API. Pode incluir etiquetas de formatação HTML. | string |
displayName | Nome da API. Tem de ter entre 1 e 300 carateres. | string |
formato | Formato do Conteúdo no qual a API está a ser importada. Podem ser adicionados novos formatos no futuro | "graphql-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 atual da API. | bool |
license | Informações de licença para a API. | ApiLicenseInformation |
caminho | O URL relativo identifica exclusivamente esta API e todos os respetivos caminhos de recursos na instância do serviço Gestão de API. É anexado ao URL base do ponto final da API especificado durante a criação da instância de serviço para formar um URL público para esta API. | cadeia (obrigatório) |
protocolos | Descreve os protocolos que as operações nesta API podem ser invocadas. | Matriz de cadeias que contém qualquer um dos seguintes: "http" 'https' 'ws' 'wss' |
serviceUrl | URL absoluto do serviço de back-end que implementa esta API. Não pode ter mais de 2000 carateres. | string |
sourceApiId | Identificador de API da API de origem. | string |
subscriptionKeyParameterNames | Protocolos sobre os quais a API é disponibilizada. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | Especifica se é necessária uma subscrição de API ou Produto para aceder à API. | bool |
termsOfServiceUrl | Um URL para os Termos de Serviço da API. TEM de estar no formato de um URL. | string |
translateRequiredQueryParameters | Estratégia de tradução dos parâmetros de consulta necessários para os modelos. Por predefinição, tem o valor "modelo". Valores possíveis: "modelo", "consulta" | "consulta" 'modelo' |
tipo | Tipo de API. | 'graphql' "http" 'odata' 'soap' 'websocket' |
valor | Valor de conteúdo ao Importar uma API. | string |
wsdlSelector | Critérios para limitar a importação de WSDL para 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 este valor para criar um novo Conjunto de Versões. | string |
name | O Nome a apresentar 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 da Versão da API estará localizado num pedido HTTP. | 'Cabeçalho' "Consulta" "Segmento" |
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 | Definições de Autenticação OAuth2 | OAuth2AuthenticationSettingsContract |
oAuth2AuthenticationSettings | Coleção de definições de autenticação OAuth2 incluídas nesta API. | OAuth2AuthenticationSettingsContract[] |
openid | Definições de Autenticação do OpenID Connect | OpenIdAuthenticationSettingsContract |
openidAuthenticationSettings | Coleção de definições de autenticação Open ID Connect incluídas nesta API. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
Nome | Descrição | Valor |
---|---|---|
authorizationServerId | Identificador do servidor de autorização OAuth. | string |
scope | âmbito de operações. | string |
OpenIdAuthenticationSettingsContract
Nome | Descrição | Valor |
---|---|---|
bearerTokenSendingMethods | Como enviar o token para o servidor. | Matriz de cadeia que contém qualquer um dos seguintes: "authorizationHeader" "consulta" |
openidProviderId | Identificador do servidor de autorização OAuth. | string |
ApiContactInformation
Nome | Descrição | Valor |
---|---|---|
O endereço de e-mail da pessoa/organização do contacto. TEM de estar no formato de um endereço de e-mail | string | |
name | O nome de identificação da pessoa/organização do contacto | string |
url | O URL que aponta para as informações de contacto. TEM de estar no formato de um URL | string |
ApiLicenseInformation
Nome | Descrição | Valor |
---|---|---|
name | O nome da licença utilizado para a API | string |
url | Um URL para a licença utilizada para a API. TEM de estar no formato de um URL | string |
SubscriptionKeyParameterNamesContract
Nome | Descrição | Valor |
---|---|---|
cabeçalho | Nome do cabeçalho da chave de subscrição. | string |
query | Nome do parâmetro da cadeia de consulta da chave de subscrição. | string |
ApiCreateOrUpdatePropertiesWsdlSelector
Nome | Descrição | Valor |
---|---|---|
wsdlEndpointName | Nome do ponto final(porta) a importar do WSDL | string |
wsdlServiceName | Nome do serviço a importar do WSDL | string |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
Modelo | Description |
---|---|
Criar uma instância da Gestão de API e todos os sub-recursos com modelo |
Este modelo demonstra como criar um serviço de Gestão de API e configurar sub entidades |
Criar o Azure Front Door em frente ao Azure Gestão de API |
Este exemplo demonstra como utilizar o Azure Front Door como um balanceador de carga global em frente ao Azure Gestão de API. |
Definição de recurso do Terraform (fornecedor AzAPI)
O tipo de recurso de serviço/apis pode ser implementado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.ApiManagement/service/apis, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis@2023-03-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
serviço/apis
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de recurso | "Microsoft.ApiManagement/service/apis@2023-03-01-preview" |
name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 1-80 Carateres válidos: Alfanuméricos e hífenes. Comece com letra e termine com alfanumérico. |
parent_id | O ID do recurso que é o principal para este recurso. | ID para recurso do tipo: serviço |
propriedades | Criação de propriedades de atualização da entidade da API. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
ApiCreateOrUpdatePropertiesOrApiContractProperties
Nome | Descrição | Valor |
---|---|---|
apiRevision | Descreve a revisão da API. Se não for fornecido nenhum valor, é criada a revisão predefinida 1 | string |
apiRevisionDescription | Descrição da Revisão da API. | string |
apiType | Tipo de API a criar. * http cria uma API REST* soap cria uma API pass-through SOAP* websocket cria a API websocket* graphql cria a API GraphQL. Podem ser adicionados novos tipos no futuro. |
"graphql" "http" "odata" "soap" "websocket" |
apiVersion | Indica o identificador de versão da API se a API tiver uma 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 definições de autenticação incluídas nesta API. | AuthenticationSettingsContract |
contacto | Informações de contacto da API. | ApiContactInformation |
descrição | Descrição da API. Pode incluir etiquetas de formatação HTML. | string |
displayName | Nome da API. Tem de ter entre 1 e 300 carateres. | string |
formato | Formato do Conteúdo no qual a API está a ser importada. Podem ser adicionados novos formatos no futuro | "graphql-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 atual da API. | bool |
license | Informações de licença para a API. | ApiLicenseInformation |
caminho | URL relativo que identifica exclusivamente esta API e todos os respetivos caminhos de recursos na instância do serviço Gestão de API. É anexado ao URL base do ponto final da API especificado durante a criação da instância de serviço para formar um URL público para esta API. | cadeia (obrigatório) |
protocolos | Descreve em que protocolos as operações nesta API podem ser invocadas. | Matriz de cadeia que contém qualquer um dos seguintes: "http" "https" "ws" "wss" |
serviceUrl | URL absoluto do serviço de back-end que implementa esta API. Não pode ter mais de 2000 carateres. | string |
sourceApiId | Identificador de API da API de origem. | string |
subscriptionKeyParameterNames | Protocolos sobre os quais a API é disponibilizada. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | Especifica se é necessária uma subscrição de API ou Produto para aceder à API. | bool |
termsOfServiceUrl | Um URL para os Termos de Serviço da API. TEM de estar no formato de um URL. | string |
translateRequiredQueryParameters | Estratégia de tradução dos parâmetros de consulta necessários para os modelos. Por predefinição, tem o valor "modelo". Valores possíveis: "modelo", "consulta" | "consulta" "modelo" |
tipo | Tipo de API. | "graphql" "http" "odata" "soap" "websocket" |
valor | Valor de conteúdo ao Importar uma API. | string |
wsdlSelector | Critérios para limitar a importação de WSDL para 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 este valor para criar um novo Conjunto de Versões. | string |
name | O Nome a apresentar 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 da Versão da API estará localizado num pedido HTTP. | "Header" (“Cabeçalho”) "Consulta" "Segmento" |
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 | Definições de Autenticação OAuth2 | OAuth2AuthenticationSettingsContract |
oAuth2AuthenticationSettings | Coleção de definições de autenticação OAuth2 incluídas nesta API. | OAuth2AuthenticationSettingsContract[] |
openid | Definições de Autenticação do OpenID Connect | OpenIdAuthenticationSettingsContract |
openidAuthenticationSettings | Coleção de definições de autenticação Open ID Connect incluídas nesta API. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
Nome | Descrição | Valor |
---|---|---|
authorizationServerId | Identificador do servidor de autorização OAuth. | string |
scope | âmbito de operações. | string |
OpenIdAuthenticationSettingsContract
Nome | Descrição | Valor |
---|---|---|
bearerTokenSendingMethods | Como enviar o token para o servidor. | Matriz de cadeias que contém qualquer um dos seguintes: "authorizationHeader" "consulta" |
openidProviderId | Identificador do servidor de autorização OAuth. | string |
ApiContactInformation
Nome | Descrição | Valor |
---|---|---|
O endereço de e-mail da pessoa/organização do contacto. TEM de estar no formato de um endereço de e-mail | string | |
name | O nome de identificação da pessoa/organização do contacto | string |
url | O URL que aponta para as informações de contacto. TEM de estar no formato de um URL | string |
ApiLicenseInformation
Nome | Descrição | Valor |
---|---|---|
name | O nome da licença utilizado para a API | string |
url | Um URL para a licença utilizada para a API. TEM de estar no formato de um URL | string |
SubscriptionKeyParameterNamesContract
Nome | Descrição | Valor |
---|---|---|
cabeçalho | Nome do cabeçalho da chave de subscrição. | string |
query | Nome do parâmetro da cadeia de consulta da chave de subscrição. | string |
ApiCreateOrUpdatePropertiesWsdlSelector
Nome | Descrição | Valor |
---|---|---|
wsdlEndpointName | Nome do ponto final(porta) a importar do WSDL | string |
wsdlServiceName | Nome do serviço a importar do WSDL | string |