Microsoft.ApiManagement serviço/authorizationServers 2016-10-10
- Últimas
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Definição de recursos do bíceps
O tipo de recurso service/authorizationServers pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.ApiManagement/service/authorizationServers, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2016-10-10' = {
parent: resourceSymbolicName
authorizationEndpoint: 'string'
authorizationMethods: [
'string'
]
bearerTokenSendingMethods: [
'string'
]
clientAuthenticationMethod: [
'string'
]
clientId: 'string'
clientRegistrationEndpoint: 'string'
clientSecret: 'string'
defaultScope: 'string'
description: 'string'
grantTypes: [
'string'
]
name: 'string'
resourceOwnerPassword: 'string'
resourceOwnerUsername: 'string'
supportState: bool
tokenBodyParameters: [
{
name: 'string'
value: 'string'
}
]
tokenEndpoint: 'string'
}
Valores de propriedade
Microsoft.ApiManagement/service/authorizationServers
Designação | Descrição | Valor |
---|---|---|
authorizationEndpoint | Ponto de extremidade de autorização OAuth. Ver http://tools.ietf.org/html/rfc6749#section-3.2. | string (obrigatório) |
authorizationMétodos | Verbos HTTP suportados pelo ponto de extremidade de autorização. O GET deve estar sempre presente. O POST é opcional. | Matriz de cadeia de caracteres contendo qualquer uma das: 'ELIMINAR' 'OBTER' 'CABEÇA' 'OPÇÕES' 'REMENDO' 'CORREIO' 'COLOCAR' 'VESTÍGIO' |
bearerTokenSendingMethods | Especifica o mecanismo pelo qual o token de acesso é passado para a API. | Matriz de cadeia de caracteres contendo qualquer uma das: 'authorizationHeader' 'consulta' |
clientAuthenticationMethod | Método de autenticação suportado pelo ponto de extremidade de token deste servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando Body é especificado, as credenciais do cliente e outros parâmetros são passados dentro do corpo da solicitação no formato application/x-www-form-urlencoded. | Matriz de cadeia de caracteres contendo qualquer uma das: 'Básico' 'Corpo' |
ID do cliente | ID do cliente ou aplicativo registrado com este servidor de autorização. | string (obrigatório) |
clientRegistrationEndpoint | Referência opcional a uma página onde o registro de cliente ou aplicativo para este servidor de autorização é executado. Contém URL absoluta para a entidade que está sendo referenciada. | string (obrigatório) |
clientSecret | Segredo do cliente ou aplicativo registrado neste servidor de autorização. | string |
defaultScope | Escopo do token de acesso que será solicitado por padrão. Pode ser substituído no nível da API. Deve ser fornecido na forma de uma cadeia de caracteres contendo valores delimitados por espaço. | string |
Descrição | Descrição do servidor de autorização. Pode conter tags de formatação HTML. | string |
Tipos de subvenções | Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso. | Matriz de cadeia de caracteres contendo qualquer uma das: «Código de autorização» 'clientCredentials' 'implícito' 'resourceOwnerPassword' (obrigatório) |
Designação | O nome do recurso | string Restrições: Comprimento máximo = 256 Padrão = ^[^*#&+:<>?]+$ (obrigatório) |
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 recurso do tipo: serviço |
resourceOwnerPassword | Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário do recurso é suportado por este servidor de autorização. Senha padrão do proprietário do recurso. | string |
resourceOwnerUsername | Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário do recurso é suportado por este servidor de autorização. Nome de usuário padrão do proprietário do recurso. | string |
Estado de apoio | Se verdadeiro, o servidor de autorização incluirá o parâmetro state da solicitação de autorização para sua resposta. O cliente pode usar o parâmetro state para aumentar a segurança do protocolo. | Bool |
tokenBodyParameters | Parâmetros adicionais exigidos pelo ponto de extremidade de token deste servidor de autorização representado como uma matriz de objetos JSON com propriedades de cadeia de caracteres de nome e valor, ou seja, {"name" : "name value", "value": "a value"}. | TokenBodyParameterContract [] |
tokenEndpoint | Ponto de extremidade do token OAuth. Contém URI absoluto para entidade que está sendo referenciada. | string |
TokenBodyParameterContract
Designação | Descrição | Valor |
---|---|---|
Designação | nome do parâmetro body. | string (obrigatório) |
valor | valor do parâmetro body. | string (obrigatório) |
Definição de recurso de modelo ARM
O tipo de recurso service/authorizationServers pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.ApiManagement/service/authorizationServers, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.ApiManagement/service/authorizationServers",
"apiVersion": "2016-10-10",
"name": "string",
"authorizationEndpoint": "string",
"authorizationMethods": [ "string" ],
"bearerTokenSendingMethods": [ "string" ],
"clientAuthenticationMethod": [ "string" ],
"clientId": "string",
"clientRegistrationEndpoint": "string",
"clientSecret": "string",
"defaultScope": "string",
"description": "string",
"grantTypes": [ "string" ],
"resourceOwnerPassword": "string",
"resourceOwnerUsername": "string",
"supportState": "bool",
"tokenBodyParameters": [
{
"name": "string",
"value": "string"
}
],
"tokenEndpoint": "string"
}
Valores de propriedade
Microsoft.ApiManagement/service/authorizationServers
Designação | Descrição | Valor |
---|---|---|
apiVersion | A versão api | '2016-10-10' |
authorizationEndpoint | Ponto de extremidade de autorização OAuth. Ver http://tools.ietf.org/html/rfc6749#section-3.2. | string (obrigatório) |
authorizationMétodos | Verbos HTTP suportados pelo ponto de extremidade de autorização. O GET deve estar sempre presente. O POST é opcional. | Matriz de cadeia de caracteres contendo qualquer uma das: 'ELIMINAR' 'OBTER' 'CABEÇA' 'OPÇÕES' 'REMENDO' 'CORREIO' 'COLOCAR' 'VESTÍGIO' |
bearerTokenSendingMethods | Especifica o mecanismo pelo qual o token de acesso é passado para a API. | Matriz de cadeia de caracteres contendo qualquer uma das: 'authorizationHeader' 'consulta' |
clientAuthenticationMethod | Método de autenticação suportado pelo ponto de extremidade de token deste servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando Body é especificado, as credenciais do cliente e outros parâmetros são passados dentro do corpo da solicitação no formato application/x-www-form-urlencoded. | Matriz de cadeia de caracteres contendo qualquer uma das: 'Básico' 'Corpo' |
ID do cliente | ID do cliente ou aplicativo registrado com este servidor de autorização. | string (obrigatório) |
clientRegistrationEndpoint | Referência opcional a uma página onde o registro de cliente ou aplicativo para este servidor de autorização é executado. Contém URL absoluta para a entidade que está sendo referenciada. | string (obrigatório) |
clientSecret | Segredo do cliente ou aplicativo registrado neste servidor de autorização. | string |
defaultScope | Escopo do token de acesso que será solicitado por padrão. Pode ser substituído no nível da API. Deve ser fornecido na forma de uma cadeia de caracteres contendo valores delimitados por espaço. | string |
Descrição | Descrição do servidor de autorização. Pode conter tags de formatação HTML. | string |
Tipos de subvenções | Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso. | Matriz de cadeia de caracteres contendo qualquer uma das: «Código de autorização» 'clientCredentials' 'implícito' 'resourceOwnerPassword' (obrigatório) |
Designação | O nome do recurso | string Restrições: Comprimento máximo = 256 Padrão = ^[^*#&+:<>?]+$ (obrigatório) |
resourceOwnerPassword | Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário do recurso é suportado por este servidor de autorização. Senha padrão do proprietário do recurso. | string |
resourceOwnerUsername | Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário do recurso é suportado por este servidor de autorização. Nome de usuário padrão do proprietário do recurso. | string |
Estado de apoio | Se verdadeiro, o servidor de autorização incluirá o parâmetro state da solicitação de autorização para sua resposta. O cliente pode usar o parâmetro state para aumentar a segurança do protocolo. | Bool |
tokenBodyParameters | Parâmetros adicionais exigidos pelo ponto de extremidade de token deste servidor de autorização representado como uma matriz de objetos JSON com propriedades de cadeia de caracteres de nome e valor, ou seja, {"name" : "name value", "value": "a value"}. | TokenBodyParameterContract [] |
tokenEndpoint | Ponto de extremidade do token OAuth. Contém URI absoluto para entidade que está sendo referenciada. | string |
tipo | O tipo de recurso | 'Microsoft.ApiManagement/service/authorizationServers' |
TokenBodyParameterContract
Designação | Descrição | Valor |
---|---|---|
Designação | nome do parâmetro body. | string (obrigatório) |
valor | valor do parâmetro body. | string (obrigatório) |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso service/authorizationServers pode ser implantado com operações direcionadas:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.ApiManagement/service/authorizationServers, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/authorizationServers@2016-10-10"
name = "string"
authorizationEndpoint = "string"
authorizationMethods = [
"string"
]
bearerTokenSendingMethods = [
"string"
]
clientAuthenticationMethod = [
"string"
]
clientId = "string"
clientRegistrationEndpoint = "string"
clientSecret = "string"
defaultScope = "string"
description = "string"
grantTypes = [
"string"
]
resourceOwnerPassword = "string"
resourceOwnerUsername = "string"
supportState = bool
tokenBodyParameters = [
{
name = "string"
value = "string"
}
]
tokenEndpoint = "string"
}
Valores de propriedade
Microsoft.ApiManagement/service/authorizationServers
Designação | Descrição | Valor |
---|---|---|
authorizationEndpoint | Ponto de extremidade de autorização OAuth. Ver http://tools.ietf.org/html/rfc6749#section-3.2. | string (obrigatório) |
authorizationMétodos | Verbos HTTP suportados pelo ponto de extremidade de autorização. O GET deve estar sempre presente. O POST é opcional. | Matriz de cadeia de caracteres contendo qualquer uma das: 'ELIMINAR' 'OBTER' 'CABEÇA' 'OPÇÕES' 'REMENDO' 'CORREIO' 'COLOCAR' 'VESTÍGIO' |
bearerTokenSendingMethods | Especifica o mecanismo pelo qual o token de acesso é passado para a API. | Matriz de cadeia de caracteres contendo qualquer uma das: 'authorizationHeader' 'consulta' |
clientAuthenticationMethod | Método de autenticação suportado pelo ponto de extremidade de token deste servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando Body é especificado, as credenciais do cliente e outros parâmetros são passados dentro do corpo da solicitação no formato application/x-www-form-urlencoded. | Matriz de cadeia de caracteres contendo qualquer uma das: 'Básico' 'Corpo' |
ID do cliente | ID do cliente ou aplicativo registrado com este servidor de autorização. | string (obrigatório) |
clientRegistrationEndpoint | Referência opcional a uma página onde o registro de cliente ou aplicativo para este servidor de autorização é executado. Contém URL absoluta para a entidade que está sendo referenciada. | string (obrigatório) |
clientSecret | Segredo do cliente ou aplicativo registrado neste servidor de autorização. | string |
defaultScope | Escopo do token de acesso que será solicitado por padrão. Pode ser substituído no nível da API. Deve ser fornecido na forma de uma cadeia de caracteres contendo valores delimitados por espaço. | string |
Descrição | Descrição do servidor de autorização. Pode conter tags de formatação HTML. | string |
Tipos de subvenções | Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso. | Matriz de cadeia de caracteres contendo qualquer uma das: «Código de autorização» 'clientCredentials' 'implícito' 'resourceOwnerPassword' (obrigatório) |
Designação | O nome do recurso | string Restrições: Comprimento máximo = 256 Padrão = ^[^*#&+:<>?]+$ (obrigatório) |
parent_id | A ID do recurso que é o pai para este recurso. | ID do recurso do tipo: serviço |
resourceOwnerPassword | Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário do recurso é suportado por este servidor de autorização. Senha padrão do proprietário do recurso. | string |
resourceOwnerUsername | Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário do recurso é suportado por este servidor de autorização. Nome de usuário padrão do proprietário do recurso. | string |
Estado de apoio | Se verdadeiro, o servidor de autorização incluirá o parâmetro state da solicitação de autorização para sua resposta. O cliente pode usar o parâmetro state para aumentar a segurança do protocolo. | Bool |
tokenBodyParameters | Parâmetros adicionais exigidos pelo ponto de extremidade de token deste servidor de autorização representado como uma matriz de objetos JSON com propriedades de cadeia de caracteres de nome e valor, ou seja, {"name" : "name value", "value": "a value"}. | TokenBodyParameterContract [] |
tokenEndpoint | Ponto de extremidade do token OAuth. Contém URI absoluto para entidade que está sendo referenciada. | string |
tipo | O tipo de recurso | "Microsoft.ApiManagement/service/authorizationServers@2016-10-10" |
TokenBodyParameterContract
Designação | Descrição | Valor |
---|---|---|
Designação | nome do parâmetro body. | string (obrigatório) |
valor | valor do parâmetro body. | string (obrigatório) |