Partager via

Service Microsoft.ApiManagement/openidConnectProviders 2023-03-01-preview

  • Article

Définition de ressource Bicep

Le type de ressource service/openidConnectProviders 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 de ressource

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

resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    description: 'string'
    displayName: 'string'
    metadataEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

Valeurs de propriété

Microsoft.ApiManagement/service/openidConnectProviders

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur maximale =
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’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
Propriétés Propriétés du contrat du fournisseur OpenId Connect. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Nom Description Valeur
clientId ID client de la console développeur qui est l’application cliente. chaîne (obligatoire)
clientSecret Clé secrète client de la console du développeur, qui est l’application cliente. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
description Description conviviale du fournisseur OpenID Connect. corde
displayName Nom du fournisseur OpenID Connect convivial. corde

Contraintes:
Longueur maximale = (obligatoire)
metadataEndpoint URI du point de terminaison de métadonnées. chaîne (obligatoire)
useInApiDocumentation Si la valeur est true, le fournisseur Open ID Connect est utilisé dans la documentation de l’API dans le portail des développeurs. False par défaut si aucune valeur n’est fournie. Bool
useInTestConsole Si la valeur est true, le fournisseur Open ID Connect peut être utilisé dans la console de test du portail des développeurs. True par défaut si aucune valeur n’est fournie. Bool

Définition de ressource de modèle ARM

Le type de ressource service/openidConnectProviders 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 de ressource

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

{
  "type": "Microsoft.ApiManagement/service/openidConnectProviders",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "displayName": "string",
    "metadataEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

Valeurs de propriété

Microsoft.ApiManagement/service/openidConnectProviders

Nom Description Valeur
apiVersion Version de l’API '2023-03-01-preview'
nom Nom de la ressource corde

Contraintes:
Longueur maximale =
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
Propriétés Propriétés du contrat du fournisseur OpenId Connect. OpenidConnectProviderContractProperties
type Type de ressource 'Microsoft.ApiManagement/service/openidConnectProviders'

OpenidConnectProviderContractProperties

Nom Description Valeur
clientId ID client de la console développeur qui est l’application cliente. chaîne (obligatoire)
clientSecret Clé secrète client de la console du développeur, qui est l’application cliente. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
description Description conviviale du fournisseur OpenID Connect. corde
displayName Nom du fournisseur OpenID Connect convivial. corde

Contraintes:
Longueur maximale = (obligatoire)
metadataEndpoint URI du point de terminaison de métadonnées. chaîne (obligatoire)
useInApiDocumentation Si la valeur est true, le fournisseur Open ID Connect est utilisé dans la documentation de l’API dans le portail des développeurs. False par défaut si aucune valeur n’est fournie. Bool
useInTestConsole Si la valeur est true, le fournisseur Open ID Connect peut être utilisé dans la console de test du portail des développeurs. True par défaut si aucune valeur n’est fournie. Bool

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource service/openidConnectProviders 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 de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ApiManagement/service/openidConnectProviders, ajoutez terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      clientId = "string"
      clientSecret = "string"
      description = "string"
      displayName = "string"
      metadataEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

Valeurs de propriété

Microsoft.ApiManagement/service/openidConnectProviders

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur maximale =
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : de service
Propriétés Propriétés du contrat du fournisseur OpenId Connect. OpenidConnectProviderContractProperties
type Type de ressource « Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview »

OpenidConnectProviderContractProperties

Nom Description Valeur
clientId ID client de la console développeur qui est l’application cliente. chaîne (obligatoire)
clientSecret Clé secrète client de la console du développeur, qui est l’application cliente. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
description Description conviviale du fournisseur OpenID Connect. corde
displayName Nom du fournisseur OpenID Connect convivial. corde

Contraintes:
Longueur maximale = (obligatoire)
metadataEndpoint URI du point de terminaison de métadonnées. chaîne (obligatoire)
useInApiDocumentation Si la valeur est true, le fournisseur Open ID Connect est utilisé dans la documentation de l’API dans le portail des développeurs. False par défaut si aucune valeur n’est fournie. Bool
useInTestConsole Si la valeur est true, le fournisseur Open ID Connect peut être utilisé dans la console de test du portail des développeurs. True par défaut si aucune valeur n’est fournie. Bool