Compartir a través de


Servicio Microsoft.ApiManagement/authorizationProviders 2022-08-01

Definición de recursos de Bicep

El tipo de recurso service/authorizationProviders se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/authorizationProviders, agregue el siguiente bicep a la plantilla.

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

Valores de propiedad

service/authorizationProviders

Nombre Descripción Valor
nombre El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.
string (obligatorio)
padre En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.
Nombre simbólico del recurso de tipo: de servicio de
Propiedades Propiedades del contrato de proveedor de autorización. AuthorizationProviderContractProperties

AuthorizationProviderContractProperties

Nombre Descripción Valor
displayName Nombre del proveedor de autorización. Debe tener entre 1 y 300 caracteres. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 300
identityProvider Nombre del proveedor de identidades. Debe tener entre 1 y 300 caracteres. cuerda
oauth2 Configuración de OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2Settings

Nombre Descripción Valor
grantTypes Configuración de OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl Dirección URL de redirección que se va a establecer en la aplicación OAuth. cuerda

AuthorizationProviderOAuth2GrantTypes

Nombre Descripción Valor
authorizationCode Parámetros de concesión de código de autorización de OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
clientCredentials Parámetros de concesión de credenciales de cliente de OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentia...

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

Nombre Descripción Valor
{propiedad personalizada} cuerda

AuthorizationProviderOAuth2GrantTypesClientCredentia...

Nombre Descripción Valor
{propiedad personalizada} cuerda

Definición de recursos de plantilla de ARM

El tipo de recurso service/authorizationProviders se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/authorizationProviders, agregue el siguiente JSON a la plantilla.

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

Valores de propiedad

service/authorizationProviders

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.ApiManagement/service/authorizationProviders"
apiVersion La versión de la API de recursos '2022-08-01'
nombre El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.
string (obligatorio)
Propiedades Propiedades del contrato de proveedor de autorización. AuthorizationProviderContractProperties

AuthorizationProviderContractProperties

Nombre Descripción Valor
displayName Nombre del proveedor de autorización. Debe tener entre 1 y 300 caracteres. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 300
identityProvider Nombre del proveedor de identidades. Debe tener entre 1 y 300 caracteres. cuerda
oauth2 Configuración de OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2Settings

Nombre Descripción Valor
grantTypes Configuración de OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl Dirección URL de redirección que se va a establecer en la aplicación OAuth. cuerda

AuthorizationProviderOAuth2GrantTypes

Nombre Descripción Valor
authorizationCode Parámetros de concesión de código de autorización de OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
clientCredentials Parámetros de concesión de credenciales de cliente de OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentia...

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

Nombre Descripción Valor
{propiedad personalizada} cuerda

AuthorizationProviderOAuth2GrantTypesClientCredentia...

Nombre Descripción Valor
{propiedad personalizada} cuerda

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/authorizationProviders se puede implementar con operaciones destinadas a:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/authorizationProviders, agregue el siguiente terraform a la plantilla.

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

Valores de propiedad

service/authorizationProviders

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.ApiManagement/service/authorizationProviders@2022-08-01"
nombre El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: de servicio de
Propiedades Propiedades del contrato de proveedor de autorización. AuthorizationProviderContractProperties

AuthorizationProviderContractProperties

Nombre Descripción Valor
displayName Nombre del proveedor de autorización. Debe tener entre 1 y 300 caracteres. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 300
identityProvider Nombre del proveedor de identidades. Debe tener entre 1 y 300 caracteres. cuerda
oauth2 Configuración de OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2Settings

Nombre Descripción Valor
grantTypes Configuración de OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl Dirección URL de redirección que se va a establecer en la aplicación OAuth. cuerda

AuthorizationProviderOAuth2GrantTypes

Nombre Descripción Valor
authorizationCode Parámetros de concesión de código de autorización de OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
clientCredentials Parámetros de concesión de credenciales de cliente de OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentia...

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

Nombre Descripción Valor
{propiedad personalizada} cuerda

AuthorizationProviderOAuth2GrantTypesClientCredentia...

Nombre Descripción Valor
{propiedad personalizada} cuerda