Authorization Server - Create Or Update

Service:

API Management

API Version:

2022-08-01

Erstellt einen neuen Autorisierungsserver oder aktualisiert Details eines bereits vorhandenen Autorisierungsservers

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}?api-version=2022-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
authsid	path	True	string	Bezeichner des Autorisierungsservers. Regex pattern: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string	Der Name des API Management-Diensts. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	ETag der Entität. Nicht erforderlich beim Erstellen einer Entität, aber erforderlich beim Aktualisieren einer Entität.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.authorizationEndpoint	True	string	OAuth-Autorisierungsendpunkt. Siehe http://tools.ietf.org/html/rfc6749#section-3.2.
properties.clientId	True	string	Bei diesem Autorisierungsserver registrierte Client- oder App-ID.
properties.clientRegistrationEndpoint	True	string	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.
properties.displayName	True	string	Benutzerfreundlicher Autorisierungsservername.
properties.grantTypes	True	GrantType[]	Form einer Autorisierungszuweisung, die der Client verwendet, um das Zugriffstoken anzufordern.
properties.authorizationMethods		AuthorizationMethod[]	HTTP-Verben, die vom Autorisierungsendpunkt unterstützt werden. GET muss immer vorhanden sein. POST ist optional.
properties.bearerTokenSendingMethods		BearerTokenSendingMethod[]	Gibt den Mechanismus an, mit dessen Hilfe das Zugriffstoken an die API übergeben wird.
properties.clientAuthenticationMethod		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.
properties.clientSecret		string	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.
properties.defaultScope		string	Zugriffstokenbereich, der standardmäßig angefordert wird. Kann auf API-Ebene überschrieben werden. Sollte in Form einer Zeichenfolge mit durch Leerzeichen getrennten Werten bereitgestellt werden.
properties.description		string	Die Beschreibung des Autorisierungsservers. Darf HTML-Formatierungstags enthalten.
properties.resourceOwnerPassword		string	Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Das Kennwort des Standardressourcenbesitzers.
properties.resourceOwnerUsername		string	Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Der Benutzername des Standardressourcenbesitzers.
properties.supportState		boolean	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.
properties.tokenBodyParameters		TokenBodyParameterContract[]	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"}.
properties.tokenEndpoint		string	OAuth-Tokenendpunkt. Enthält einen absoluten URI zu der Entität, auf die verwiesen wird.
properties.useInApiDocumentation		boolean	Wenn true, wird der Autorisierungsserver in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird.
properties.useInTestConsole		boolean	Wenn true, kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird.

Antworten

Name	Typ	Beschreibung
200 OK	AuthorizationServerContract	Der Autorisierungsserver ist bereits registriert. Headers ETag: string
201 Created	AuthorizationServerContract	Der Autorisierungsserver wurde erfolgreich registriert. Headers ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementCreateAuthorizationServer

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer?api-version=2022-08-01

{
  "properties": {
    "displayName": "test2",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "clientSecret": "2",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.AuthorizationMethod;
import com.azure.resourcemanager.apimanagement.models.BearerTokenSendingMethod;
import com.azure.resourcemanager.apimanagement.models.GrantType;
import java.util.Arrays;

/** Samples for AuthorizationServer CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateAuthorizationServer.json
     */
    /**
     * Sample code: ApiManagementCreateAuthorizationServer.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateAuthorizationServer(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .authorizationServers()
            .define("newauthServer")
            .withExistingService("rg1", "apimService1")
            .withDisplayName("test2")
            .withUseInTestConsole(false)
            .withUseInApiDocumentation(true)
            .withClientRegistrationEndpoint("https://www.contoso.com/apps")
            .withAuthorizationEndpoint("https://www.contoso.com/oauth2/auth")
            .withGrantTypes(Arrays.asList(GrantType.AUTHORIZATION_CODE, GrantType.IMPLICIT))
            .withClientId("1")
            .withClientSecret("2")
            .withDescription("test server")
            .withAuthorizationMethods(Arrays.asList(AuthorizationMethod.GET))
            .withTokenEndpoint("https://www.contoso.com/oauth2/token")
            .withSupportState(true)
            .withDefaultScope("read write")
            .withBearerTokenSendingMethods(Arrays.asList(BearerTokenSendingMethod.AUTHORIZATION_HEADER))
            .withResourceOwnerUsername("un")
            .withResourceOwnerPassword("pwd")
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_authorization_server.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.authorization_server.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        authsid="newauthServer",
        parameters={
            "properties": {
                "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
                "authorizationMethods": ["GET"],
                "bearerTokenSendingMethods": ["authorizationHeader"],
                "clientId": "1",
                "clientRegistrationEndpoint": "https://www.contoso.com/apps",
                "clientSecret": "2",
                "defaultScope": "read write",
                "description": "test server",
                "displayName": "test2",
                "grantTypes": ["authorizationCode", "implicit"],
                "resourceOwnerPassword": "pwd",
                "resourceOwnerUsername": "un",
                "supportState": True,
                "tokenEndpoint": "https://www.contoso.com/oauth2/token",
                "useInApiDocumentation": True,
                "useInTestConsole": False,
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateAuthorizationServer.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateAuthorizationServer.json
func ExampleAuthorizationServerClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAuthorizationServerClient().CreateOrUpdate(ctx, "rg1", "apimService1", "newauthServer", armapimanagement.AuthorizationServerContract{
		Properties: &armapimanagement.AuthorizationServerContractProperties{
			Description: to.Ptr("test server"),
			AuthorizationMethods: []*armapimanagement.AuthorizationMethod{
				to.Ptr(armapimanagement.AuthorizationMethodGET)},
			BearerTokenSendingMethods: []*armapimanagement.BearerTokenSendingMethod{
				to.Ptr(armapimanagement.BearerTokenSendingMethodAuthorizationHeader)},
			DefaultScope:               to.Ptr("read write"),
			ResourceOwnerPassword:      to.Ptr("pwd"),
			ResourceOwnerUsername:      to.Ptr("un"),
			SupportState:               to.Ptr(true),
			TokenEndpoint:              to.Ptr("https://www.contoso.com/oauth2/token"),
			AuthorizationEndpoint:      to.Ptr("https://www.contoso.com/oauth2/auth"),
			ClientID:                   to.Ptr("1"),
			ClientRegistrationEndpoint: to.Ptr("https://www.contoso.com/apps"),
			ClientSecret:               to.Ptr("2"),
			DisplayName:                to.Ptr("test2"),
			GrantTypes: []*armapimanagement.GrantType{
				to.Ptr(armapimanagement.GrantTypeAuthorizationCode),
				to.Ptr(armapimanagement.GrantTypeImplicit)},
			UseInAPIDocumentation: to.Ptr(true),
			UseInTestConsole:      to.Ptr(false),
		},
	}, &armapimanagement.AuthorizationServerClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AuthorizationServerContract = armapimanagement.AuthorizationServerContract{
	// 	Name: to.Ptr("newauthServer"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/authorizationServers"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer"),
	// 	Properties: &armapimanagement.AuthorizationServerContractProperties{
	// 		Description: to.Ptr("test server"),
	// 		AuthorizationMethods: []*armapimanagement.AuthorizationMethod{
	// 			to.Ptr(armapimanagement.AuthorizationMethodGET)},
	// 			BearerTokenSendingMethods: []*armapimanagement.BearerTokenSendingMethod{
	// 				to.Ptr(armapimanagement.BearerTokenSendingMethodAuthorizationHeader)},
	// 				DefaultScope: to.Ptr("read write"),
	// 				ResourceOwnerPassword: to.Ptr("pwd"),
	// 				ResourceOwnerUsername: to.Ptr("un"),
	// 				SupportState: to.Ptr(true),
	// 				TokenEndpoint: to.Ptr("https://www.contoso.com/oauth2/token"),
	// 				AuthorizationEndpoint: to.Ptr("https://www.contoso.com/oauth2/auth"),
	// 				ClientID: to.Ptr("1"),
	// 				ClientRegistrationEndpoint: to.Ptr("https://www.contoso.com/apps"),
	// 				DisplayName: to.Ptr("test2"),
	// 				GrantTypes: []*armapimanagement.GrantType{
	// 					to.Ptr(armapimanagement.GrantTypeAuthorizationCode),
	// 					to.Ptr(armapimanagement.GrantTypeImplicit)},
	// 					UseInAPIDocumentation: to.Ptr(true),
	// 					UseInTestConsole: to.Ptr(false),
	// 				},
	// 			}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates new authorization server or updates an existing authorization server.
 *
 * @summary Creates new authorization server or updates an existing authorization server.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateAuthorizationServer.json
 */
async function apiManagementCreateAuthorizationServer() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const authsid = "newauthServer";
  const parameters = {
    description: "test server",
    authorizationEndpoint: "https://www.contoso.com/oauth2/auth",
    authorizationMethods: ["GET"],
    bearerTokenSendingMethods: ["authorizationHeader"],
    clientId: "1",
    clientRegistrationEndpoint: "https://www.contoso.com/apps",
    clientSecret: "2",
    defaultScope: "read write",
    displayName: "test2",
    grantTypes: ["authorizationCode", "implicit"],
    resourceOwnerPassword: "pwd",
    resourceOwnerUsername: "un",
    supportState: true,
    tokenEndpoint: "https://www.contoso.com/oauth2/token",
    useInApiDocumentation: true,
    useInTestConsole: false,
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.authorizationServer.createOrUpdate(
    resourceGroupName,
    serviceName,
    authsid,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test2",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test2",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

Definitionen

Name	Beschreibung
AuthorizationMethod	HTTP-Verben, die vom Autorisierungsendpunkt unterstützt werden. GET muss immer vorhanden sein. POST ist optional.
AuthorizationServerContract	Externe OAuth-Autorisierungsservereinstellungen.
BearerTokenSendingMethod	Gibt den Mechanismus an, mit dessen Hilfe das Zugriffstoken an die API übergeben wird.
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.
ErrorFieldContract	Fehlerfeldvertrag.
ErrorResponse	Fehlerantwort.
GrantType	Form einer Autorisierungszuweisung, die der Client verwendet, um das Zugriffstoken anzufordern.
TokenBodyParameterContract	OAuth acquire token request body parameter (www-url-form-codiert).

AuthorizationMethod

HTTP-Verben, die vom Autorisierungsendpunkt unterstützt werden. GET muss immer vorhanden sein. POST ist optional.

Name	Typ	Beschreibung
DELETE	string
GET	string
HEAD	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

AuthorizationServerContract

Externe OAuth-Autorisierungsservereinstellungen.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.authorizationEndpoint	string	OAuth-Autorisierungsendpunkt. Siehe http://tools.ietf.org/html/rfc6749#section-3.2.
properties.authorizationMethods	AuthorizationMethod[]	HTTP-Verben, die vom Autorisierungsendpunkt unterstützt werden. GET muss immer vorhanden sein. POST ist optional.
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	Gibt den Mechanismus an, mit dessen Hilfe das Zugriffstoken an die API übergeben wird.
properties.clientAuthenticationMethod	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.
properties.clientId	string	Bei diesem Autorisierungsserver registrierte Client- oder App-ID.
properties.clientRegistrationEndpoint	string	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.
properties.clientSecret	string	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.
properties.defaultScope	string	Zugriffstokenbereich, der standardmäßig angefordert wird. Kann auf API-Ebene überschrieben werden. Sollte in Form einer Zeichenfolge mit durch Leerzeichen getrennten Werten bereitgestellt werden.
properties.description	string	Die Beschreibung des Autorisierungsservers. Darf HTML-Formatierungstags enthalten.
properties.displayName	string	Benutzerfreundlicher Autorisierungsservername.
properties.grantTypes	GrantType[]	Form einer Autorisierungszuweisung, die der Client verwendet, um das Zugriffstoken anzufordern.
properties.resourceOwnerPassword	string	Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Das Kennwort des Standardressourcenbesitzers.
properties.resourceOwnerUsername	string	Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Der Benutzername des Standardressourcenbesitzers.
properties.supportState	boolean	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.
properties.tokenBodyParameters	TokenBodyParameterContract[]	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"}.
properties.tokenEndpoint	string	OAuth-Tokenendpunkt. Enthält einen absoluten URI zu der Entität, auf die verwiesen wird.
properties.useInApiDocumentation	boolean	Wenn true, wird der Autorisierungsserver in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird.
properties.useInTestConsole	boolean	Wenn true, kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

BearerTokenSendingMethod

Gibt den Mechanismus an, mit dessen Hilfe das Zugriffstoken an die API übergeben wird.

Name	Typ	Beschreibung
authorizationHeader	string
query	string

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.

Name	Typ	Beschreibung
Basic	string	Grundlegende Clientauthentifizierungsmethode.
Body	string	Textbasierte Authentifizierungsmethode.

ErrorFieldContract

Fehlerfeldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.
error.message	string	Lesbare Darstellung des Fehlers.

GrantType

Form einer Autorisierungszuweisung, die der Client verwendet, um das Zugriffstoken anzufordern.

Name	Typ	Beschreibung
authorizationCode	string	Autorisierungscode-Gewährungsflow wie beschrieben beschrieben https://tools.ietf.org/html/rfc6749#section-4.1.
clientCredentials	string	Ablauf der Clientanmeldeinformationenzuteilung wie beschrieben beschrieben https://tools.ietf.org/html/rfc6749#section-4.4.
implicit	string	Impliziter Code grant-Flow wie beschrieben https://tools.ietf.org/html/rfc6749#section-4.2beschrieben.
resourceOwnerPassword	string	Ablauf der Ressourcenbesitzerkennwortzuweisung wie beschrieben https://tools.ietf.org/html/rfc6749#section-4.3beschrieben.

TokenBodyParameterContract

OAuth acquire token request body parameter (www-url-form-codiert).

Name	Typ	Beschreibung
name	string	Name des Body-Parameters.
value	string	body-Parameterwert.