Freigeben über

Microsoft.ApiManagement service/authorizationServers 2024-05-01

  • Artikel

Bicep-Ressourcendefinition

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 unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/authorizationServers-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2024-05-01' = {
  parent: resourceSymbolicName
  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

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 eine der folgenden Elemente enthält:
"DELETE"
'GET'
"HEAD"
'OPTIONS'
"PATCH"
'POST'
"PUT"
"TRACE"
bearerTokenSendingMethods Gibt den Mechanismus an, mit dem zugriffstoken an die API übergeben wird. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"authorizationHeader"
'Abfrage'
clientAuthenticationMethod Vom Tokenendpunkt dieses Autorisierungsservers unterstützte Authentifizierungsmethode. Mögliche Werte sind "Basic" und/oder "Body". Wenn "Body" angegeben wird, werden Clientanmeldeinformationen und andere Parameter im Anforderungstext im Anwendungs-/x-www-form-urlencoded-Format übergeben. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"Einfach"
"Body"
clientId Client- oder App-ID, die bei diesem Autorisierungsserver registriert ist. Zeichenfolge (erforderlich)
clientRegistrationEndpoint Optionaler Verweis auf eine Seite, auf der Client- oder App-Registrierung für diesen Autorisierungsserver ausgeführt wird. Enthält absolute URL zu Entität, auf die verwiesen wird. Zeichenfolge (erforderlich)
clientSecret Client- oder App-Geheimschlüssel, der bei diesem Autorisierungsserver registriert ist. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
defaultScope Zugriffstokenbereich, der standardmäßig angefordert wird. Kann auf API-Ebene überschrieben werden. Sollte in Form einer Zeichenfolge bereitgestellt werden, die durch Leerzeichen getrennte Werte enthält. Schnur
Beschreibung Beschreibung des Autorisierungsservers. Kann HTML-Formatierungstags enthalten. Schnur
displayName Benutzerfreundlicher Autorisierungsservername. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
grantTypes Form einer Autorisierungserteilung, die der Client zum Anfordern des Zugriffstokens verwendet. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"authorizationCode"
"clientCredentials"
"implizit"
"resourceOwnerPassword" (erforderlich)
resourceOwnerPassword Kann optional angegeben werden, wenn der Typ der Kennworterteilung des Ressourcenbesitzers von diesem Autorisierungsserver unterstützt wird. Standardkennwort des Ressourcenbesitzers. Schnur
resourceOwnerUsername Kann optional angegeben werden, wenn der Typ der Kennworterteilung des Ressourcenbesitzers von diesem Autorisierungsserver unterstützt wird. Standardbenutzerbenutzername der Ressource. Schnur
supportState Bei "true" enthält der Autorisierungsserver zustandsparameter aus der Autorisierungsanforderung an seine Antwort. Der Client kann zustandsparameter verwenden, um die Protokollsicherheit auszuheben. Bool
tokenBodyParameters Zusätzliche Parameter, die vom Tokenendpunkt dieses Autorisierungsservers als Array von JSON-Objekten mit Namen- und Wertzeichenfolgeneigenschaften dargestellt werden, d. h. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint OAuth-Tokenendpunkt. Enthält einen absoluten URI für die Entität, auf die verwiesen wird. Schnur
useInApiDocumentation Bei "true" wird der Autorisierungsserver in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird. Bool
useInTestConsole Bei "true" kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird. Bool

Microsoft.ApiManagement/service/authorizationServers

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
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 Eigenschaften des Externen OAuth-Autorisierungsserververtrags. AuthorizationServerContractProperties

TokenBodyParameterContract

Name Beschreibung Wert
Name name des body-Parameters. Zeichenfolge (erforderlich)
Wert body-Parameterwert. Zeichenfolge (erforderlich)

ARM-Vorlagenressourcendefinition

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 unter Ä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": "2024-05-01",
  "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

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 eine der folgenden Elemente enthält:
"DELETE"
'GET'
"HEAD"
'OPTIONS'
"PATCH"
'POST'
"PUT"
"TRACE"
bearerTokenSendingMethods Gibt den Mechanismus an, mit dem zugriffstoken an die API übergeben wird. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"authorizationHeader"
'Abfrage'
clientAuthenticationMethod Vom Tokenendpunkt dieses Autorisierungsservers unterstützte Authentifizierungsmethode. Mögliche Werte sind "Basic" und/oder "Body". Wenn "Body" angegeben wird, werden Clientanmeldeinformationen und andere Parameter im Anforderungstext im Anwendungs-/x-www-form-urlencoded-Format übergeben. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"Einfach"
"Body"
clientId Client- oder App-ID, die bei diesem Autorisierungsserver registriert ist. Zeichenfolge (erforderlich)
clientRegistrationEndpoint Optionaler Verweis auf eine Seite, auf der Client- oder App-Registrierung für diesen Autorisierungsserver ausgeführt wird. Enthält absolute URL zu Entität, auf die verwiesen wird. Zeichenfolge (erforderlich)
clientSecret Client- oder App-Geheimschlüssel, der bei diesem Autorisierungsserver registriert ist. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
defaultScope Zugriffstokenbereich, der standardmäßig angefordert wird. Kann auf API-Ebene überschrieben werden. Sollte in Form einer Zeichenfolge bereitgestellt werden, die durch Leerzeichen getrennte Werte enthält. Schnur
Beschreibung Beschreibung des Autorisierungsservers. Kann HTML-Formatierungstags enthalten. Schnur
displayName Benutzerfreundlicher Autorisierungsservername. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
grantTypes Form einer Autorisierungserteilung, die der Client zum Anfordern des Zugriffstokens verwendet. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"authorizationCode"
"clientCredentials"
"implizit"
"resourceOwnerPassword" (erforderlich)
resourceOwnerPassword Kann optional angegeben werden, wenn der Typ der Kennworterteilung des Ressourcenbesitzers von diesem Autorisierungsserver unterstützt wird. Standardkennwort des Ressourcenbesitzers. Schnur
resourceOwnerUsername Kann optional angegeben werden, wenn der Typ der Kennworterteilung des Ressourcenbesitzers von diesem Autorisierungsserver unterstützt wird. Standardbenutzerbenutzername der Ressource. Schnur
supportState Bei "true" enthält der Autorisierungsserver zustandsparameter aus der Autorisierungsanforderung an seine Antwort. Der Client kann zustandsparameter verwenden, um die Protokollsicherheit auszuheben. Bool
tokenBodyParameters Zusätzliche Parameter, die vom Tokenendpunkt dieses Autorisierungsservers als Array von JSON-Objekten mit Namen- und Wertzeichenfolgeneigenschaften dargestellt werden, d. h. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint OAuth-Tokenendpunkt. Enthält einen absoluten URI für die Entität, auf die verwiesen wird. Schnur
useInApiDocumentation Bei "true" wird der Autorisierungsserver in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird. Bool
useInTestConsole Bei "true" kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird. Bool

Microsoft.ApiManagement/service/authorizationServers

Name Beschreibung Wert
apiVersion Die API-Version '2024-05-01'
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[^*#&+:<>?]+$ (erforderlich)
Eigenschaften Eigenschaften des Externen OAuth-Autorisierungsserververtrags. AuthorizationServerContractProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/authorizationServers"

TokenBodyParameterContract

Name Beschreibung Wert
Name name des body-Parameters. Zeichenfolge (erforderlich)
Wert body-Parameterwert. Zeichenfolge (erforderlich)

Terraform -Ressourcendefinition (AzAPI-Anbieter)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2024-05-01"
  name = "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

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 eine der folgenden Elemente enthält:
"DELETE"
'GET'
"HEAD"
'OPTIONS'
"PATCH"
'POST'
"PUT"
"TRACE"
bearerTokenSendingMethods Gibt den Mechanismus an, mit dem zugriffstoken an die API übergeben wird. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"authorizationHeader"
'Abfrage'
clientAuthenticationMethod Vom Tokenendpunkt dieses Autorisierungsservers unterstützte Authentifizierungsmethode. Mögliche Werte sind "Basic" und/oder "Body". Wenn "Body" angegeben wird, werden Clientanmeldeinformationen und andere Parameter im Anforderungstext im Anwendungs-/x-www-form-urlencoded-Format übergeben. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"Einfach"
"Body"
clientId Client- oder App-ID, die bei diesem Autorisierungsserver registriert ist. Zeichenfolge (erforderlich)
clientRegistrationEndpoint Optionaler Verweis auf eine Seite, auf der Client- oder App-Registrierung für diesen Autorisierungsserver ausgeführt wird. Enthält absolute URL zu Entität, auf die verwiesen wird. Zeichenfolge (erforderlich)
clientSecret Client- oder App-Geheimschlüssel, der bei diesem Autorisierungsserver registriert ist. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
defaultScope Zugriffstokenbereich, der standardmäßig angefordert wird. Kann auf API-Ebene überschrieben werden. Sollte in Form einer Zeichenfolge bereitgestellt werden, die durch Leerzeichen getrennte Werte enthält. Schnur
Beschreibung Beschreibung des Autorisierungsservers. Kann HTML-Formatierungstags enthalten. Schnur
displayName Benutzerfreundlicher Autorisierungsservername. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
grantTypes Form einer Autorisierungserteilung, die der Client zum Anfordern des Zugriffstokens verwendet. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"authorizationCode"
"clientCredentials"
"implizit"
"resourceOwnerPassword" (erforderlich)
resourceOwnerPassword Kann optional angegeben werden, wenn der Typ der Kennworterteilung des Ressourcenbesitzers von diesem Autorisierungsserver unterstützt wird. Standardkennwort des Ressourcenbesitzers. Schnur
resourceOwnerUsername Kann optional angegeben werden, wenn der Typ der Kennworterteilung des Ressourcenbesitzers von diesem Autorisierungsserver unterstützt wird. Standardbenutzerbenutzername der Ressource. Schnur
supportState Bei "true" enthält der Autorisierungsserver zustandsparameter aus der Autorisierungsanforderung an seine Antwort. Der Client kann zustandsparameter verwenden, um die Protokollsicherheit auszuheben. Bool
tokenBodyParameters Zusätzliche Parameter, die vom Tokenendpunkt dieses Autorisierungsservers als Array von JSON-Objekten mit Namen- und Wertzeichenfolgeneigenschaften dargestellt werden, d. h. {"name" : "name value", "value": "a value"}. TokenBodyParameterContract[]
tokenEndpoint OAuth-Tokenendpunkt. Enthält einen absoluten URI für die Entität, auf die verwiesen wird. Schnur
useInApiDocumentation Bei "true" wird der Autorisierungsserver in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird. Bool
useInTestConsole Bei "true" kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird. Bool

Microsoft.ApiManagement/service/authorizationServers

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
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 Eigenschaften des Externen OAuth-Autorisierungsserververtrags. AuthorizationServerContractProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/authorizationServers@2024-05-01"

TokenBodyParameterContract

Name Beschreibung Wert
Name name des body-Parameters. Zeichenfolge (erforderlich)
Wert body-Parameterwert. Zeichenfolge (erforderlich)