Partager via

Service/authorizationProviders Microsoft.ApiManagement

  • Article

Définition de ressource Bicep

Le type de ressource service/authorizationProviders peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/authorizationProviders, ajoutez le Bicep suivant à votre modèle.

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

Valeurs de propriétés

service/authorizationProviders

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : service
properties Propriétés du contrat du fournisseur d’autorisation. AuthorizationProviderContractProperties

AuthorizationProviderContractProperties

Nom Description Valeur
displayName Nom du fournisseur d’autorisation. Doit contenir de 1 à 300 caractères. string
IdentityProvider Nom du fournisseur d’identité. Doit contenir de 1 à 300 caractères. string
oauth2 Paramètres OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2Settings

Nom Description Valeur
grantTypes Paramètres OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl URL de redirection à définir dans l’application OAuth. string

AuthorizationProviderOAuth2GrantTypes

Nom Description Valeur
authorizationCode Paramètres d’octroi du code d’autorisation OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
clientCredentials Paramètres d’octroi des informations d’identification du client OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentia...

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

Nom Description Valeur
{propriété personnalisée} string

AuthorizationProviderOAuth2GrantTypesClientCredentia...

Nom Description Valeur
{propriété personnalisée} string

Définition de ressources de modèle ARM

Le type de ressource service/authorizationProviders peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/authorizationProviders, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriétés

service/authorizationProviders

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/authorizationProviders »
apiVersion Version de l’API de ressource « 2023-05-01-preview »
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.		 string (obligatoire)
properties Propriétés du contrat du fournisseur d’autorisation. AuthorizationProviderContractProperties

AuthorizationProviderContractProperties

Nom Description Valeur
displayName Nom du fournisseur d’autorisation. Doit comporter entre 1 et 300 caractères. string
IdentityProvider Nom du fournisseur d’identité. Doit comporter entre 1 et 300 caractères. string
oauth2 Paramètres OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2Settings

Nom Description Valeur
grantTypes Paramètres OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl URL de redirection à définir dans l’application OAuth. string

AuthorizationProviderOAuth2GrantTypes

Nom Description Valeur
authorizationCode Paramètres d’octroi de code d’autorisation OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
clientCredentials Paramètres d’octroi des informations d’identification du client OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentia...

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

Nom Description Valeur
{propriété personnalisée} string

AuthorizationProviderOAuth2GrantTypesClientCredentia...

Nom Description Valeur
{propriété personnalisée} string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource service/authorizationProviders peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/authorizationProviders, ajoutez le Terraform suivant à votre modèle.

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

Valeurs de propriétés

service/authorizationProviders

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/authorizationProviders@2023-05-01-preview »
name Nom de la ressource string (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : service
properties Propriétés du contrat du fournisseur d’autorisation. AuthorizationProviderContractProperties

AuthorizationProviderContractProperties

Nom Description Valeur
displayName Nom du fournisseur d’autorisation. Doit comporter entre 1 et 300 caractères. string
IdentityProvider Nom du fournisseur d’identité. Doit comporter entre 1 et 300 caractères. string
oauth2 Paramètres OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2Settings

Nom Description Valeur
grantTypes Paramètres OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl URL de redirection à définir dans l’application OAuth. string

AuthorizationProviderOAuth2GrantTypes

Nom Description Valeur
authorizationCode Paramètres d’octroi de code d’autorisation OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
clientCredentials Paramètres d’octroi des informations d’identification du client OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentia...

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

Nom Description Valeur
{propriété personnalisée} string

AuthorizationProviderOAuth2GrantTypesClientCredentia...

Nom Description Valeur
{propriété personnalisée} string