Microsoft.ApiManagement service/openidConnectProviders 2023-03-01-preview
- neueste
- 2024-06-01-Preview-
- 2024-05-01
- 2023-09-01-Preview-
- 2023-05-01-Preview-
- 2023-03-01-Preview-
- 2022-09-01-Preview-
- 2022-08-01
- 2022-04-01-Vorschau-
- 2021-12-01-Preview-
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-Preview-
- 2020-12-01
- 2020-06-01-Preview-
- 2019-12-01
- 2019-12-01-Preview-
- 2019-01-01
- 2018-06-01-Preview-
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep-Ressourcendefinition
Der Ressourcentyp "service/openidConnectProviders" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/openidConnectProviders-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.
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
}
}
Eigenschaftswerte
Microsoft.ApiManagement/service/openidConnectProviders
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Max. Länge = Pattern = ^[^*#&+:<>?]+$ (erforderlich) |
| Elternteil | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource des Typs: Dienst- |
| Eigenschaften | Vertragseigenschaften des OpenId Connect-Anbieters. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| clientId | Client-ID der Entwicklerkonsole, die die Clientanwendung ist. | Zeichenfolge (erforderlich) |
| clientSecret | Geheimer Clientschlüssel der Entwicklerkonsole, die die Clientanwendung ist. | Schnur Zwänge: Vertraulicher Wert. Übergeben Als sicherer Parameter. |
| Beschreibung | Benutzerfreundliche Beschreibung des OpenID Connect-Anbieters. | Schnur |
| displayName | Benutzerfreundlicher Name des OpenID Connect-Anbieters. | Schnur Zwänge: Max. Länge = (erforderlich) |
| metadataEndpoint | Metadatenendpunkt-URI. | Zeichenfolge (erforderlich) |
| useInApiDocumentation | Wenn true, wird der Open ID Connect-Anbieter in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird. | Bool |
| useInTestConsole | Bei "true" kann der Open ID Connect-Anbieter in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird. | Bool |
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "service/openidConnectProviders" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/openidConnectProviders-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden JSON-Code hinzu.
{
"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"
}
}
Eigenschaftswerte
Microsoft.ApiManagement/service/openidConnectProviders
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | "2023-03-01-preview" |
| Name | Der Ressourcenname | Schnur Zwänge: Max. Länge = Pattern = ^[^*#&+:<>?]+$ (erforderlich) |
| Eigenschaften | Vertragseigenschaften des OpenId Connect-Anbieters. | OpenidConnectProviderContractProperties |
| Art | Der Ressourcentyp | 'Microsoft.ApiManagement/service/openidConnectProviders' |
OpenidConnectProviderContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| clientId | Client-ID der Entwicklerkonsole, die die Clientanwendung ist. | Zeichenfolge (erforderlich) |
| clientSecret | Geheimer Clientschlüssel der Entwicklerkonsole, die die Clientanwendung ist. | Schnur Zwänge: Vertraulicher Wert. Übergeben Als sicherer Parameter. |
| Beschreibung | Benutzerfreundliche Beschreibung des OpenID Connect-Anbieters. | Schnur |
| displayName | Benutzerfreundlicher Name des OpenID Connect-Anbieters. | Schnur Zwänge: Max. Länge = (erforderlich) |
| metadataEndpoint | Metadatenendpunkt-URI. | Zeichenfolge (erforderlich) |
| useInApiDocumentation | Wenn true, wird der Open ID Connect-Anbieter in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird. | Bool |
| useInTestConsole | Bei "true" kann der Open ID Connect-Anbieter in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird. | Bool |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp "service/openidConnectProviders" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/openidConnectProviders-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
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
}
})
}
Eigenschaftswerte
Microsoft.ApiManagement/service/openidConnectProviders
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Max. Länge = Pattern = ^[^*#&+:<>?]+$ (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource des Typs: Dienst- |
| Eigenschaften | Vertragseigenschaften des OpenId Connect-Anbieters. | OpenidConnectProviderContractProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview" |
OpenidConnectProviderContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| clientId | Client-ID der Entwicklerkonsole, die die Clientanwendung ist. | Zeichenfolge (erforderlich) |
| clientSecret | Geheimer Clientschlüssel der Entwicklerkonsole, die die Clientanwendung ist. | Schnur Zwänge: Vertraulicher Wert. Übergeben Als sicherer Parameter. |
| Beschreibung | Benutzerfreundliche Beschreibung des OpenID Connect-Anbieters. | Schnur |
| displayName | Benutzerfreundlicher Name des OpenID Connect-Anbieters. | Schnur Zwänge: Max. Länge = (erforderlich) |
| metadataEndpoint | Metadatenendpunkt-URI. | Zeichenfolge (erforderlich) |
| useInApiDocumentation | Wenn true, wird der Open ID Connect-Anbieter in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird. | Bool |
| useInTestConsole | Bei "true" kann der Open ID Connect-Anbieter in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird. | Bool |