Authorization Server - Update

Dienst:

API Management

API-Version:

2022-08-01

Updates die Details des Autorisierungsservers, der durch seinen Bezeichner angegeben wird.

PATCH 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-Muster: ^[^*#&+:<>?]+$
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-Muster: ^[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	True	string	ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

Anforderungstext

Name	Typ	Beschreibung
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.

Antworten

Name	Typ	Beschreibung
200 OK	AuthorizationServerContract	Die Autorisierungsservereinstellungen wurden erfolgreich aktualisiert. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementUpdateAuthorizationServer

Beispielanforderung

HTTP

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


{
  "properties": {
    "clientId": "update",
    "clientSecret": "updated",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.AuthorizationServerContract;

/** Samples for AuthorizationServer Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateAuthorizationServer.json
     */
    /**
     * Sample code: ApiManagementUpdateAuthorizationServer.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateAuthorizationServer(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        AuthorizationServerContract resource =
            manager
                .authorizationServers()
                .getWithResponse("rg1", "apimService1", "newauthServer", com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withUseInTestConsole(false)
            .withUseInApiDocumentation(true)
            .withClientId("update")
            .withClientSecret("updated")
            .withIfMatch("*")
            .apply();
    }
}

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_update_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.update(
        resource_group_name="rg1",
        service_name="apimService1",
        authsid="newauthServer",
        if_match="*",
        parameters={
            "properties": {
                "clientId": "update",
                "clientSecret": "updated",
                "useInApiDocumentation": True,
                "useInTestConsole": False,
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateAuthorizationServer.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/ApiManagementUpdateAuthorizationServer.json
func ExampleAuthorizationServerClient_Update() {
	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().Update(ctx, "rg1", "apimService1", "newauthServer", "*", armapimanagement.AuthorizationServerUpdateContract{
		Properties: &armapimanagement.AuthorizationServerUpdateContractProperties{
			ClientID:              to.Ptr("update"),
			ClientSecret:          to.Ptr("updated"),
			UseInAPIDocumentation: to.Ptr(true),
			UseInTestConsole:      to.Ptr(false),
		},
	}, 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)},
	// 				ClientAuthenticationMethod: []*armapimanagement.ClientAuthenticationMethod{
	// 					to.Ptr(armapimanagement.ClientAuthenticationMethodBasic)},
	// 					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("updated"),
	// 					ClientRegistrationEndpoint: to.Ptr("https://www.contoso.com/apps"),
	// 					DisplayName: to.Ptr("test3"),
	// 					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 Updates the details of the authorization server specified by its identifier.
 *
 * @summary Updates the details of the authorization server specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateAuthorizationServer.json
 */
async function apiManagementUpdateAuthorizationServer() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const authsid = "newauthServer";
  const ifMatch = "*";
  const parameters = {
    clientId: "update",
    clientSecret: "updated",
    useInApiDocumentation: true,
    useInTestConsole: false,
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.authorizationServer.update(
    resourceGroupName,
    serviceName,
    authsid,
    ifMatch,
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateAuthorizationServer.json
// this example is just showing the usage of "AuthorizationServer_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementAuthorizationServerResource created on azure
// for more information of creating ApiManagementAuthorizationServerResource, please refer to the document of ApiManagementAuthorizationServerResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string authsid = "newauthServer";
ResourceIdentifier apiManagementAuthorizationServerResourceId = ApiManagementAuthorizationServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, authsid);
ApiManagementAuthorizationServerResource apiManagementAuthorizationServer = client.GetApiManagementAuthorizationServerResource(apiManagementAuthorizationServerResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiManagementAuthorizationServerPatch patch = new ApiManagementAuthorizationServerPatch()
{
    UseInTestConsole = false,
    UseInApiDocumentation = true,
    ClientId = "update",
    ClientSecret = "updated",
};
ApiManagementAuthorizationServerResource result = await apiManagementAuthorizationServer.UpdateAsync(ifMatch, patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementAuthorizationServerData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test3",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "clientAuthenticationMethod": [
      "Basic"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "updated",
    "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	Einstellungen des externen OAuth-Autorisierungsservers.
AuthorizationServerUpdateContract	Einstellungen des externen OAuth-Autorisierungsservers.
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 innerhalb des Anforderungstexts im Format application/x-www-form-urlencoded übergeben.
ErrorFieldContract	Fehlerfeldvertrag.
ErrorResponse	Fehlerantwort.
GrantType	Form einer Autorisierungszuweisung, die der Client verwendet, um das Zugriffstoken anzufordern.
TokenBodyParameterContract	OAuth-Parameter zum Abrufen des Tokenanforderungstexts (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

Einstellungen des externen OAuth-Autorisierungsservers.

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 innerhalb des Anforderungstexts im Format application/x-www-form-urlencoded ü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, die als Array von JSON-Objekten mit eigenschaften für Name und Wertzeichenfolge dargestellt werden, 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. Standardmäßig false, wenn kein Wert angegeben wird.
properties.useInTestConsole	boolean	Wenn true, kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. Standardmäßig true, wenn kein Wert angegeben wird.
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

AuthorizationServerUpdateContract

Einstellungen des externen OAuth-Autorisierungsservers.

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 innerhalb des Anforderungstexts im Format application/x-www-form-urlencoded ü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, die als Array von JSON-Objekten mit eigenschaften für Name und Wertzeichenfolge dargestellt werden, 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. Standardmäßig false, wenn kein Wert angegeben wird.
properties.useInTestConsole	boolean	Wenn true, kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. Standardmäßig true, 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 innerhalb des Anforderungstexts im Format application/x-www-form-urlencoded ü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 in der Anforderung gesendet werden, im Falle eines Validierungsfehlers.
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 https://tools.ietf.org/html/rfc6749#section-4.1.
clientCredentials	string	Ablauf zur Gewährung von Clientanmeldeinformationen wie 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.2.
resourceOwnerPassword	string	Ablauf für die Kennwortzuweisung von Ressourcenbesitzern wie beschrieben https://tools.ietf.org/html/rfc6749#section-4.3.

TokenBodyParameterContract

OAuth-Parameter zum Abrufen des Tokenanforderungstexts (www-url-form-codiert).

Name	Typ	Beschreibung
name	string	body-Parametername.
value	string	body-Parameterwert.