Microsoft.ApiManagement service/openidConnectProviders 2022-09-01-preview
Bicep-Ressourcendefinition
Der Ressourcentyp service/openidConnectProviders kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- 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 Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2022-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
clientId: 'string'
clientSecret: 'string'
description: 'string'
displayName: 'string'
metadataEndpoint: 'string'
useInApiDocumentation: bool
useInTestConsole: bool
}
}
Eigenschaftswerte
service/openidConnectProviders
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen. |
Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
| parent | 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 vom Typ: Dienst |
| properties | Eigenschaften des OpenId Connect-Anbietervertrags. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| clientId | Client-ID der Entwicklerkonsole, bei der es sich um die Clientanwendung handelt. | Zeichenfolge (erforderlich) |
| clientSecret | Geheimer Clientschlüssel der Entwicklerkonsole, bei der es sich um die Clientanwendung handelt. | Zeichenfolge |
| description | Benutzerfreundliche Beschreibung des OpenID Connect-Anbieters. | Zeichenfolge |
| displayName | Benutzerfreundlicher Name des OpenID Connect-Anbieters. | Zeichenfolge (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 | Wenn true, kann der Open ID Connect-Anbieter in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird. | bool |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage |
Diese Vorlage veranschaulicht, wie Sie einen API Management Dienst erstellen und Unterentitäten konfigurieren. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp service/openidConnectProviders kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- 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": "2022-09-01-preview",
"name": "string",
"properties": {
"clientId": "string",
"clientSecret": "string",
"description": "string",
"displayName": "string",
"metadataEndpoint": "string",
"useInApiDocumentation": "bool",
"useInTestConsole": "bool"
}
}
Eigenschaftswerte
service/openidConnectProviders
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.ApiManagement/service/openidConnectProviders" |
| apiVersion | Die Ressourcen-API-Version | '2022-09-01-preview' |
| name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen. |
Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
| properties | Eigenschaften des OpenId Connect-Anbietervertrags. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| clientId | Client-ID der Entwicklerkonsole, bei der es sich um die Clientanwendung handelt. | Zeichenfolge (erforderlich) |
| clientSecret | Geheimer Clientschlüssel der Entwicklerkonsole, bei der es sich um die Clientanwendung handelt. | Zeichenfolge |
| description | Benutzerfreundliche Beschreibung des OpenID Connect-Anbieters. | Zeichenfolge |
| displayName | Benutzerfreundlicher Name des OpenID Connect-Anbieters. | Zeichenfolge (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 | Wenn true, kann der Open ID Connect-Anbieter in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird. | bool |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
| Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage |
Diese Vorlage veranschaulicht, wie Sie einen API Management Dienst erstellen und Unterentitäten konfigurieren. |
Terraform (AzAPI-Anbieter) Ressourcendefinition
Der Ressourcentyp service/openidConnectProviders kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- 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 der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/openidConnectProviders@2022-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
}
})
}
Eigenschaftswerte
service/openidConnectProviders
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.ApiManagement/service/openidConnectProviders@2022-09-01-preview" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
| parent_id | Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. | ID für Ressource vom Typ: Dienst |
| properties | Eigenschaften des OpenId Connect-Anbietervertrags. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| clientId | Client-ID der Entwicklerkonsole, bei der es sich um die Clientanwendung handelt. | Zeichenfolge (erforderlich) |
| clientSecret | Geheimer Clientschlüssel der Entwicklerkonsole, bei der es sich um die Clientanwendung handelt. | Zeichenfolge |
| description | Benutzerfreundliche Beschreibung des OpenID Connect-Anbieters. | Zeichenfolge |
| displayName | Benutzerfreundlicher Name des OpenID Connect-Anbieters. | Zeichenfolge (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 | Wenn true, kann der Open ID Connect-Anbieter in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird. | bool |