Microsoft.ApiManagement service/openidConnectProviders 2021-08-01

• Neueste
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 01.08.2022
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview

Bicep-Ressourcendefinition

Der Ressourcentyp service/openidConnectProviders kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Ä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@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    description: 'string'
    displayName: 'string'
    metadataEndpoint: 'string'
  }
}

Eigenschaftswerte

service/openidConnectProviders

Name	BESCHREIBUNG	Wert
name	Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.	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	OpenId Connect Provider-Vertragseigenschaften.	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 OpenID Connect-Anbietername.	Zeichenfolge (erforderlich)
metadataEndpoint	Metadatenendpunkt-URI.	Zeichenfolge (erforderlich)

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp 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 Untergeordnetetitäten konfigurieren.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp service/openidConnectProviders kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Ä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": "2021-08-01",
  "name": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "displayName": "string",
    "metadataEndpoint": "string"
  }
}

Eigenschaftswerte

service/openidConnectProviders

Name	BESCHREIBUNG	Wert
type	Der Ressourcentyp	"Microsoft.ApiManagement/service/openidConnectProviders"
apiVersion	Die Version der Ressourcen-API	'2021-08-01'
name	Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.	Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
properties	OpenId Connect Provider-Vertragseigenschaften.	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)

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@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      clientId = "string"
      clientSecret = "string"
      description = "string"
      displayName = "string"
      metadataEndpoint = "string"
    }
  })
}

Eigenschaftswerte

service/openidConnectProviders

Name	BESCHREIBUNG	Wert
type	Ressourcentyp	"Microsoft.ApiManagement/service/openidConnectProviders@2021-08-01"
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)