Partilhar via

Microsoft.ApiManagement service/authorizationProviders 2023-09-01-preview

  • Artigo

Definição de recursos do bíceps

O tipo de recurso service/authorizationProviders pode ser implantado com operações que visam:

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/authorizationProviders, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationProviders@2023-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    displayName: 'string'
    identityProvider: 'string'
    oauth2: {
      grantTypes: {
        authorizationCode: {
          {customized property}: 'string'
        }
        clientCredentials: {
          {customized property}: 'string'
        }
      }
      redirectUrl: 'string'
    }
  }
}

Valores de propriedade

AuthorizationProviderContractProperties

Designação Descrição Valor
displayName Nome do provedor de autorização. Deve ter de 1 a 300 caracteres. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 300
identityProvider Nome do provedor de identidade. Deve ter de 1 a 300 caracteres. string
OAuth2 Configurações do OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Designação Descrição Valor
authorizationCode Parâmetros de concessão do código de autorização OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCode
clientCredenciais Parâmetros de concessão de credenciais do cliente OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Designação Descrição Valor

AuthorizationProviderOAuth2GrantTypesClientCredentials

Designação Descrição Valor

AuthorizationProviderOAuth2Settings

Designação Descrição Valor
Tipos de subvenções Configurações do OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl URL de redirecionamento a ser definido no aplicativo OAuth. string

Microsoft.ApiManagement/service/authorizationProviders

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
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
propriedades Propriedades do Contrato do Provedor de Autorização. AuthorizationProviderContractProperties

Definição de recurso de modelo ARM

O tipo de recurso service/authorizationProviders pode ser implantado com operações que visam:

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/authorizationProviders, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.ApiManagement/service/authorizationProviders",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "displayName": "string",
    "identityProvider": "string",
    "oauth2": {
      "grantTypes": {
        "authorizationCode": {
          "{customized property}": "string"
        },
        "clientCredentials": {
          "{customized property}": "string"
        }
      },
      "redirectUrl": "string"
    }
  }
}

Valores de propriedade

AuthorizationProviderContractProperties

Designação Descrição Valor
displayName Nome do provedor de autorização. Deve ter de 1 a 300 caracteres. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 300
identityProvider Nome do provedor de identidade. Deve ter de 1 a 300 caracteres. string
OAuth2 Configurações do OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Designação Descrição Valor
authorizationCode Parâmetros de concessão do código de autorização OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCode
clientCredenciais Parâmetros de concessão de credenciais do cliente OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Designação Descrição Valor

AuthorizationProviderOAuth2GrantTypesClientCredentials

Designação Descrição Valor

AuthorizationProviderOAuth2Settings

Designação Descrição Valor
Tipos de subvenções Configurações do OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl URL de redirecionamento a ser definido no aplicativo OAuth. string

Microsoft.ApiManagement/service/authorizationProviders

Designação Descrição Valor
apiVersion A versão api '2023-09-01-pré-visualização'
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 256
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
propriedades Propriedades do Contrato do Provedor de Autorização. AuthorizationProviderContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/authorizationProviders'

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso service/authorizationProviders pode ser implantado com operações que visam:

  • 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/authorizationProviders, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationProviders@2023-09-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      identityProvider = "string"
      oauth2 = {
        grantTypes = {
          authorizationCode = {
            {customized property} = "string"
          }
          clientCredentials = {
            {customized property} = "string"
          }
        }
        redirectUrl = "string"
      }
    }
  })
}

Valores de propriedade

AuthorizationProviderContractProperties

Designação Descrição Valor
displayName Nome do provedor de autorização. Deve ter de 1 a 300 caracteres. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 300
identityProvider Nome do provedor de identidade. Deve ter de 1 a 300 caracteres. string
OAuth2 Configurações do OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Designação Descrição Valor
authorizationCode Parâmetros de concessão do código de autorização OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCode
clientCredenciais Parâmetros de concessão de credenciais do cliente OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Designação Descrição Valor

AuthorizationProviderOAuth2GrantTypesClientCredentials

Designação Descrição Valor

AuthorizationProviderOAuth2Settings

Designação Descrição Valor
Tipos de subvenções Configurações do OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl URL de redirecionamento a ser definido no aplicativo OAuth. string

Microsoft.ApiManagement/service/authorizationProviders

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
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
propriedades Propriedades do Contrato do Provedor de Autorização. AuthorizationProviderContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/authorizationProviders@2023-09-01-preview"