Service Microsoft.ApiManagement/openidConnectProviders 2023-09-01-preview
Définition de ressource Bicep
Le type de ressource service/openidConnectProviders peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de 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 le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
clientId: 'string'
clientSecret: 'string'
description: 'string'
displayName: 'string'
metadataEndpoint: 'string'
useInApiDocumentation: bool
useInTestConsole: bool
}
}
Valeurs de propriété
service/openidConnectProviders
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep. |
chaîne (obligatoire) Limite de caractères : 1 à 80 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique. |
| 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. | chaîne (obligatoire) Contraintes: Longueur maximale = 50 |
| 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 |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
Créer une instance Gestion des API et toutes les sous-ressources à l’aide d’un modèle
|
Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités |
Définition de ressource de modèle ARM
Le type de ressource service/openidConnectProviders peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de 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 le code JSON suivant à votre modèle.
{
"type": "Microsoft.ApiManagement/service/openidConnectProviders",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"clientId": "string",
"clientSecret": "string",
"description": "string",
"displayName": "string",
"metadataEndpoint": "string",
"useInApiDocumentation": "bool",
"useInTestConsole": "bool"
}
}
Valeurs de propriété
service/openidConnectProviders
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | 'Microsoft.ApiManagement/service/openidConnectProviders' |
| apiVersion | Version de l’API de ressource | '2023-09-01-preview' |
| nom | Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON. |
chaîne (obligatoire) Limite de caractères : 1 à 80 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique. |
| 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. | chaîne (obligatoire) Contraintes: Longueur maximale = 50 |
| 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 |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
|
Créer une instance Gestion des API et toutes les sous-ressources à l’aide d’un modèle
|
Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités |
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-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
clientId = "string"
clientSecret = "string"
description = "string"
displayName = "string"
metadataEndpoint = "string"
useInApiDocumentation = bool
useInTestConsole = bool
}
})
}
Valeurs de propriété
service/openidConnectProviders
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview » |
| nom | Nom de la ressource | chaîne (obligatoire) Limite de caractères : 1 à 80 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique. |
| 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 |
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. | chaîne (obligatoire) Contraintes: Longueur maximale = 50 |
| 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 |