Freigeben über

Microsoft.ApiManagement service/authorizationServers 2023-05-01-preview

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp service/authorizationServers kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/authorizationServers-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    authorizationEndpoint: 'string'
    authorizationMethods: [
      'string'
    ]
    bearerTokenSendingMethods: [
      'string'
    ]
    clientAuthenticationMethod: [
      'string'
    ]
    clientId: 'string'
    clientRegistrationEndpoint: 'string'
    clientSecret: 'string'
    defaultScope: 'string'
    description: 'string'
    displayName: 'string'
    grantTypes: [
      'string'
    ]
    resourceOwnerPassword: 'string'
    resourceOwnerUsername: 'string'
    supportState: bool
    tokenBodyParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    tokenEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

Eigenschaftswerte

service/authorizationServers

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 Vertrags des externen OAuth-Autorisierungsservers. AuthorizationServerContractProperties

AuthorizationServerContractProperties

Name BESCHREIBUNG Wert
authorizationEndpoint OAuth-Autorisierungsendpunkt. Siehe http://tools.ietf.org/html/rfc6749#section-3.2.. Zeichenfolge (erforderlich)
authorizationMethods HTTP-Verben, die vom Autorisierungsendpunkt unterstützt werden. GET muss immer vorhanden sein. POST ist optional. Zeichenfolgenarray, das folgendes enthält:
'DELETE'
"GET"
"HEAD"
"OPTIONEN"
"PATCH"
‚POST‘
"PUT"
"TRACE"
bearerTokenSendingMethods Gibt den Mechanismus an, mit dessen Hilfe das Zugriffstoken an die API übergeben wird. Zeichenfolgenarray, das folgendes enthält:
'authorizationHeader'
"Abfrage"
clientAuthenticationMethod Methode zur Authentifizierung, die vom Tokenendpunkt dieses Autorisierungsservers unterstützt wird. Mögliche Werte sind Basic und/oder Body. Wenn Body angegeben ist, werden Clientanmeldeinformationen und andere Parameter im Format application/x-www-form-urlencoded innerhalb des Anforderungstexts übergeben. Zeichenfolgenarray, das folgendes enthält:
"Basic"
"Body"
clientId Bei diesem Autorisierungsserver registrierte Client- oder App-ID. Zeichenfolge (erforderlich)
clientRegistrationEndpoint Optionaler Verweis auf eine Seite, auf der die Client- oder App-Registrierung für diesen Autorisierungsserver ausgeführt wird. Enthält eine absolute URL zu der Entität, auf die verwiesen wird. Zeichenfolge (erforderlich)
clientSecret Bei diesem Autorisierungsserver registrierter geheimer Schlüssel des Clients oder der App. Diese Eigenschaft wird bei "GET"-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. Zeichenfolge
defaultScope Zugriffstokenbereich, der standardmäßig angefordert wird. Kann auf API-Ebene überschrieben werden. Sollte in Form einer Zeichenfolge mit durch Leerzeichen getrennten Werten bereitgestellt werden. Zeichenfolge
description Die Beschreibung des Autorisierungsservers. Darf HTML-Formatierungstags enthalten. Zeichenfolge
displayName Benutzerfreundlicher Autorisierungsservername. Zeichenfolge (erforderlich)
grantTypes Form einer Autorisierungszuweisung, die der Client verwendet, um das Zugriffstoken anzufordern. Zeichenfolgenarray, das folgendes enthält:
"authorizationCode"
"clientCredentials"
Implizit
"resourceOwnerPassword" (erforderlich)
resourceOwnerPassword Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Das Kennwort des Standardressourcenbesitzers. Zeichenfolge
resourceOwnerUsername Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Der Benutzername des Standardressourcenbesitzers. Zeichenfolge
supportState Wenn true, schließt der Autorisierungsserver den Zustandsparameter aus der Autorisierungsanforderung in seine Antwort ein. Der Client kann mithilfe des Zustandsparameters die Protokollsicherheit erhöhen. bool
tokenBodyParameters Zusätzliche Parameter, die vom Tokenendpunkt dieses Autorisierungsservers benötigt werden, die als Array von JSON-Objekten mit eigenschaften für Name und Wertzeichenfolge dargestellt werden, d. h. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint OAuth-Tokenendpunkt. Enthält einen absoluten URI zu der Entität, auf die verwiesen wird. Zeichenfolge
useInApiDocumentation Wenn true, wird der Autorisierungsserver in der API-Dokumentation im Entwicklerportal verwendet. Standardmäßig false, wenn kein Wert angegeben wird. bool
useInTestConsole Wenn true, kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. Standardmäßig true, wenn kein Wert angegeben wird. bool

TokenBodyParameterContract

Name BESCHREIBUNG Wert
name body-Parametername. Zeichenfolge (erforderlich)
value body-Parameterwert. Zeichenfolge (erforderlich)

Ressourcendefinition mit einer ARM-Vorlage

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

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/authorizationServers-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "authorizationEndpoint": "string",
    "authorizationMethods": [ "string" ],
    "bearerTokenSendingMethods": [ "string" ],
    "clientAuthenticationMethod": [ "string" ],
    "clientId": "string",
    "clientRegistrationEndpoint": "string",
    "clientSecret": "string",
    "defaultScope": "string",
    "description": "string",
    "displayName": "string",
    "grantTypes": [ "string" ],
    "resourceOwnerPassword": "string",
    "resourceOwnerUsername": "string",
    "supportState": "bool",
    "tokenBodyParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "tokenEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

Eigenschaftswerte

service/authorizationServers

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.ApiManagement/service/authorizationServers"
apiVersion Die Version der Ressourcen-API "2023-05-01-preview"
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 Eigenschaften des Vertrags für den externen OAuth-Autorisierungsserver. AuthorizationServerContractProperties

AuthorizationServerContractProperties

Name BESCHREIBUNG Wert
authorizationEndpoint OAuth-Autorisierungsendpunkt. Siehe http://tools.ietf.org/html/rfc6749#section-3.2.. Zeichenfolge (erforderlich)
authorizationMethods HTTP-Verben, die vom Autorisierungsendpunkt unterstützt werden. GET muss immer vorhanden sein. POST ist optional. Zeichenfolgenarray, das eines der folgenden Elemente enthält:
"DELETE"
"GET"
"HEAD"
"OPTIONEN"
"PATCH"
‚POST‘
"PUT"
"TRACE"
bearerTokenSendingMethods Gibt den Mechanismus an, mit dessen Hilfe das Zugriffstoken an die API übergeben wird. Zeichenfolgenarray, das eines der folgenden Elemente enthält:
"authorizationHeader"
"Abfrage"
clientAuthenticationMethod Methode zur Authentifizierung, die vom Tokenendpunkt dieses Autorisierungsservers unterstützt wird. Mögliche Werte sind Basic und/oder Body. Wenn Body angegeben ist, werden Clientanmeldeinformationen und andere Parameter innerhalb des Anforderungstexts im Format application/x-www-form-urlencoded übergeben. Zeichenfolgenarray, das eines der folgenden Elemente enthält:
"Basic"
"Body"
clientId Bei diesem Autorisierungsserver registrierte Client- oder App-ID. Zeichenfolge (erforderlich)
clientRegistrationEndpoint Optionaler Verweis auf eine Seite, auf der die Client- oder App-Registrierung für diesen Autorisierungsserver ausgeführt wird. Enthält eine absolute URL zu der Entität, auf die verwiesen wird. Zeichenfolge (erforderlich)
clientSecret Bei diesem Autorisierungsserver registrierter geheimer Schlüssel des Clients oder der App. Diese Eigenschaft wird bei "GET"-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. Zeichenfolge
defaultScope Zugriffstokenbereich, der standardmäßig angefordert wird. Kann auf API-Ebene überschrieben werden. Sollte in Form einer Zeichenfolge mit durch Leerzeichen getrennten Werten bereitgestellt werden. Zeichenfolge
description Die Beschreibung des Autorisierungsservers. Darf HTML-Formatierungstags enthalten. Zeichenfolge
displayName Benutzerfreundlicher Autorisierungsservername. Zeichenfolge (erforderlich)
grantTypes Form einer Autorisierungszuweisung, die der Client verwendet, um das Zugriffstoken anzufordern. Zeichenfolgenarray, das folgendes enthält:
"authorizationCode"
"clientCredentials"
"implizit"
"resourceOwnerPassword" (erforderlich)
resourceOwnerPassword Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Das Kennwort des Standardressourcenbesitzers. Zeichenfolge
resourceOwnerUsername Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Der Benutzername des Standardressourcenbesitzers. Zeichenfolge
supportState Wenn true, schließt der Autorisierungsserver den Zustandsparameter aus der Autorisierungsanforderung in seine Antwort ein. Der Client kann mithilfe des Zustandsparameters die Protokollsicherheit erhöhen. bool
tokenBodyParameters Zusätzliche Parameter, die vom Tokenendpunkt dieses Autorisierungsservers benötigt werden, werden als Array von JSON-Objekten mit den Eigenschaften name und Value string dargestellt, d. h. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint OAuth-Tokenendpunkt. Enthält einen absoluten URI zu der Entität, auf die verwiesen wird. Zeichenfolge
useInApiDocumentation Wenn true, wird der Autorisierungsserver in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird. bool
useInTestConsole Wenn true, kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird. bool

TokenBodyParameterContract

Name BESCHREIBUNG Wert
name Name des Body-Parameters. Zeichenfolge (erforderlich)
value body-Parameterwert. Zeichenfolge (erforderlich)

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp service/authorizationServers 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/authorizationServers-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authorizationEndpoint = "string"
      authorizationMethods = [
        "string"
      ]
      bearerTokenSendingMethods = [
        "string"
      ]
      clientAuthenticationMethod = [
        "string"
      ]
      clientId = "string"
      clientRegistrationEndpoint = "string"
      clientSecret = "string"
      defaultScope = "string"
      description = "string"
      displayName = "string"
      grantTypes = [
        "string"
      ]
      resourceOwnerPassword = "string"
      resourceOwnerUsername = "string"
      supportState = bool
      tokenBodyParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      tokenEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

Eigenschaftswerte

service/authorizationServers

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.ApiManagement/service/authorizationServers@2023-05-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 Vertrags des externen OAuth-Autorisierungsservers. AuthorizationServerContractProperties

AuthorizationServerContractProperties

Name BESCHREIBUNG Wert
authorizationEndpoint OAuth-Autorisierungsendpunkt. Siehe http://tools.ietf.org/html/rfc6749#section-3.2.. Zeichenfolge (erforderlich)
authorizationMethods HTTP-Verben, die vom Autorisierungsendpunkt unterstützt werden. GET muss immer vorhanden sein. POST ist optional. Zeichenfolgenarray, das eines der folgenden Elemente enthält:
„DELETE“
„GET“
„HEAD“
"OPTIONEN"
„PATCH“
„POST“
„PUT“
"TRACE"
bearerTokenSendingMethods Gibt den Mechanismus an, mit dessen Hilfe das Zugriffstoken an die API übergeben wird. Zeichenfolgenarray, das eines der folgenden Elemente enthält:
"authorizationHeader"
„query“
clientAuthenticationMethod Methode zur Authentifizierung, die vom Tokenendpunkt dieses Autorisierungsservers unterstützt wird. Mögliche Werte sind Basic und/oder Body. Wenn Body angegeben ist, werden Clientanmeldeinformationen und andere Parameter innerhalb des Anforderungstexts im Format application/x-www-form-urlencoded übergeben. Zeichenfolgenarray, das eines der folgenden Elemente enthält:
„Basic“
„Textkörper“
clientId Bei diesem Autorisierungsserver registrierte Client- oder App-ID. Zeichenfolge (erforderlich)
clientRegistrationEndpoint Optionaler Verweis auf eine Seite, auf der die Client- oder App-Registrierung für diesen Autorisierungsserver ausgeführt wird. Enthält eine absolute URL zu der Entität, auf die verwiesen wird. Zeichenfolge (erforderlich)
clientSecret Bei diesem Autorisierungsserver registrierter geheimer Schlüssel des Clients oder der App. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. Zeichenfolge
defaultScope Zugriffstokenbereich, der standardmäßig angefordert wird. Kann auf API-Ebene überschrieben werden. Sollte in Form einer Zeichenfolge mit durch Leerzeichen getrennten Werten bereitgestellt werden. Zeichenfolge
description Die Beschreibung des Autorisierungsservers. Darf HTML-Formatierungstags enthalten. Zeichenfolge
displayName Benutzerfreundlicher Autorisierungsservername. Zeichenfolge (erforderlich)
grantTypes Form einer Autorisierungszuweisung, die der Client verwendet, um das Zugriffstoken anzufordern. Zeichenfolgenarray, das eines der folgenden Elemente enthält:
"authorizationCode"
"clientCredentials"
"implizit"
"resourceOwnerPassword" (erforderlich)
resourceOwnerPassword Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Das Kennwort des Standardressourcenbesitzers. Zeichenfolge
resourceOwnerUsername Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Der Benutzername des Standardressourcenbesitzers. Zeichenfolge
supportState Wenn true, schließt der Autorisierungsserver den Zustandsparameter aus der Autorisierungsanforderung in seine Antwort ein. Der Client kann mithilfe des Zustandsparameters die Protokollsicherheit erhöhen. bool
tokenBodyParameters Zusätzliche Parameter, die vom Tokenendpunkt dieses Autorisierungsservers benötigt werden, die als Array von JSON-Objekten mit eigenschaften für Name und Wertzeichenfolge dargestellt werden, d. h. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint OAuth-Tokenendpunkt. Enthält einen absoluten URI zu der Entität, auf die verwiesen wird. Zeichenfolge
useInApiDocumentation Wenn true, wird der Autorisierungsserver in der API-Dokumentation im Entwicklerportal verwendet. Standardmäßig false, wenn kein Wert angegeben wird. bool
useInTestConsole Wenn true, kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. Standardmäßig true, wenn kein Wert angegeben wird. bool

TokenBodyParameterContract

Name BESCHREIBUNG Wert
name body-Parametername. Zeichenfolge (erforderlich)
value body-Parameterwert. Zeichenfolge (erforderlich)