Authorization Server - Update

Service:

API Management

API-versie:

2021-08-01

Updates de details van de autorisatieserver die is opgegeven door de id.

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

URI-parameters

Name	In	Vereist	Type	Description
authsid	path	True	string	Id van de autorisatieserver. Regex-patroon: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	De naam van de resourcegroep.
serviceName	path	True	string	De naam van de API Management service. Regex-patroon: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match	True	string	ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit de headerreactie van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.

Aanvraagbody

Name	Type	Description
properties.authorizationEndpoint	string	OAuth-autorisatie-eindpunt. Zie http://tools.ietf.org/html/rfc6749#section-3.2.
properties.authorizationMethods	AuthorizationMethod[]	HTTP-werkwoorden die worden ondersteund door het autorisatie-eindpunt. GET moet altijd aanwezig zijn. POST is optioneel.
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	Hiermee geeft u het mechanisme op waarmee het toegangstoken wordt doorgegeven aan de API.
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	Verificatiemethode die wordt ondersteund door het tokeneindpunt van deze autorisatieserver. Mogelijke waarden zijn Basic en/of Hoofdtekst. Wanneer hoofdtekst is opgegeven, worden clientreferenties en andere parameters doorgegeven in de aanvraagbody in de indeling application/x-www-form-urlencoded.
properties.clientId	string	Client- of app-id die is geregistreerd bij deze autorisatieserver.
properties.clientRegistrationEndpoint	string	Optionele verwijzing naar een pagina waarop de client- of app-registratie voor deze autorisatieserver wordt uitgevoerd. Bevat de absolute URL naar de entiteit waarnaar wordt verwezen.
properties.clientSecret	string	Client- of app-geheim dat is geregistreerd bij deze autorisatieserver. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen! Gebruik post-aanvraag '/listSecrets' om de waarde op te halen.
properties.defaultScope	string	Toegangstokenbereik dat standaard wordt aangevraagd. Kan worden overschreven op API-niveau. Moet worden opgegeven in de vorm van een tekenreeks met door spaties gescheiden waarden.
properties.description	string	Beschrijving van de autorisatieserver. Kan HTML-opmaaktags bevatten.
properties.displayName	string	Gebruiksvriendelijke autorisatieservernaam.
properties.grantTypes	GrantType[]	Vorm van een autorisatietoekenning, die de client gebruikt om het toegangstoken aan te vragen.
properties.resourceOwnerPassword	string	Kan optioneel worden opgegeven wanneer het type wachtwoordtoestemming van resource-eigenaar wordt ondersteund door deze autorisatieserver. Standaardwachtwoord voor resource-eigenaar.
properties.resourceOwnerUsername	string	Kan optioneel worden opgegeven wanneer het type wachtwoordtoestemming van resource-eigenaar wordt ondersteund door deze autorisatieserver. Standaardnaam van resource-eigenaar.
properties.supportState	boolean	Als dit waar is, bevat de autorisatieserver de statusparameter van de autorisatieaanvraag tot het antwoord. Client kan de statusparameter gebruiken om protocolbeveiliging te verhogen.
properties.tokenBodyParameters	TokenBodyParameterContract[]	Aanvullende parameters die vereist zijn voor het tokeneindpunt van deze autorisatieserver die worden weergegeven als een matrix van JSON-objecten met naam- en waardetekenreekseigenschappen, bijvoorbeeld {"name" : "name value", "value": "a value"}.
properties.tokenEndpoint	string	OAuth-tokeneindpunt. Bevat een absolute URI naar de entiteit waarnaar wordt verwezen.

Antwoorden

Name	Type	Description
200 OK	AuthorizationServerContract	De instellingen van de autorisatieserver zijn bijgewerkt. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementUpdateAuthorizationServer

Voorbeeldaanvraag

HTTP

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


{
  "properties": {
    "clientId": "update",
    "clientSecret": "updated"
  }
}

Java

import com.azure.core.util.Context;
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/2021-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", Context.NONE)
                .getValue();
        resource.update().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 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"}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-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"),
		},
	}, 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)},
	// 					},
	// 				}
}

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/2021-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",
  };
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-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()
{
    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

Voorbeeldrespons

Statuscode:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test3",
    "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"
  }
}

Definities

Name	Description
AuthorizationMethod	HTTP-woorden die worden ondersteund door het autorisatie-eindpunt. GET moet altijd aanwezig zijn. POST is optioneel.
AuthorizationServerContract	Instellingen voor externe OAuth-autorisatieserver.
AuthorizationServerUpdateContract	Instellingen voor externe OAuth-autorisatieserver.
BearerTokenSendingMethod	Hiermee geeft u het mechanisme op waarmee het toegangstoken wordt doorgegeven aan de API.
ClientAuthenticationMethod	Verificatiemethode die wordt ondersteund door het tokeneindpunt van deze autorisatieserver. Mogelijke waarden zijn Basic en/of Hoofdtekst. Wanneer hoofdtekst is opgegeven, worden clientreferenties en andere parameters doorgegeven in de aanvraagbody in de indeling application/x-www-form-urlencoded.
ErrorFieldContract	Fout Veldcontract.
ErrorResponse	Foutreactie.
GrantType	Vorm van een autorisatietoekenning, die de client gebruikt om het toegangstoken aan te vragen.
TokenBodyParameterContract	OAuth acquire token request body parameter (www-url-form-encoded).

AuthorizationMethod

HTTP-woorden die worden ondersteund door het autorisatie-eindpunt. GET moet altijd aanwezig zijn. POST is optioneel.

Name	Type	Description
DELETE	string
GET	string
HEAD	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

AuthorizationServerContract

Instellingen voor externe OAuth-autorisatieserver.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.authorizationEndpoint	string	OAuth-autorisatie-eindpunt. Zie http://tools.ietf.org/html/rfc6749#section-3.2.
properties.authorizationMethods	AuthorizationMethod[]	HTTP-woorden die worden ondersteund door het autorisatie-eindpunt. GET moet altijd aanwezig zijn. POST is optioneel.
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	Hiermee geeft u het mechanisme op waarmee het toegangstoken wordt doorgegeven aan de API.
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	Verificatiemethode die wordt ondersteund door het tokeneindpunt van deze autorisatieserver. Mogelijke waarden zijn Basic en/of Hoofdtekst. Wanneer hoofdtekst is opgegeven, worden clientreferenties en andere parameters doorgegeven in de aanvraagbody in de indeling application/x-www-form-urlencoded.
properties.clientId	string	Client- of app-id die is geregistreerd bij deze autorisatieserver.
properties.clientRegistrationEndpoint	string	Optionele verwijzing naar een pagina waarop client- of app-registratie voor deze autorisatieserver wordt uitgevoerd. Bevat de absolute URL naar de entiteit waarnaar wordt verwezen.
properties.clientSecret	string	Client- of app-geheim dat is geregistreerd bij deze autorisatieserver. Deze eigenschap wordt niet ingevuld bij 'GET'-bewerkingen! Gebruik post-aanvraag '/listSecrets' om de waarde op te halen.
properties.defaultScope	string	Toegangstokenbereik dat standaard wordt aangevraagd. Kan worden overschreven op API-niveau. Moet worden opgegeven in de vorm van een tekenreeks die door spaties gescheiden waarden bevat.
properties.description	string	Beschrijving van de autorisatieserver. Kan HTML-opmaaktags bevatten.
properties.displayName	string	Gebruiksvriendelijke autorisatieservernaam.
properties.grantTypes	GrantType[]	Vorm van een autorisatietoekenning, die de client gebruikt om het toegangstoken aan te vragen.
properties.resourceOwnerPassword	string	Kan optioneel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Standaardwachtwoord voor resource-eigenaar.
properties.resourceOwnerUsername	string	Kan optioneel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Standaard gebruikersnaam van resource-eigenaar.
properties.supportState	boolean	Als dit waar is, bevat de autorisatieserver de statusparameter van de autorisatieaanvraag tot het antwoord. Client kan de statusparameter gebruiken om protocolbeveiliging te verhogen.
properties.tokenBodyParameters	TokenBodyParameterContract[]	Aanvullende parameters die vereist zijn voor het tokeneindpunt van deze autorisatieserver, weergegeven als een matrix van JSON-objecten met eigenschappen voor naam- en waardetekenreeksen, bijvoorbeeld {"name" : "name value", "value": "a value"}.
properties.tokenEndpoint	string	OAuth-tokeneindpunt. Bevat een absolute URI naar de entiteit waarnaar wordt verwezen.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

AuthorizationServerUpdateContract

Instellingen voor externe OAuth-autorisatieserver.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.authorizationEndpoint	string	OAuth-autorisatie-eindpunt. Zie http://tools.ietf.org/html/rfc6749#section-3.2.
properties.authorizationMethods	AuthorizationMethod[]	HTTP-woorden die worden ondersteund door het autorisatie-eindpunt. GET moet altijd aanwezig zijn. POST is optioneel.
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	Hiermee geeft u het mechanisme op waarmee het toegangstoken wordt doorgegeven aan de API.
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	Verificatiemethode die wordt ondersteund door het tokeneindpunt van deze autorisatieserver. Mogelijke waarden zijn Basic en/of Hoofdtekst. Wanneer hoofdtekst is opgegeven, worden clientreferenties en andere parameters doorgegeven in de aanvraagbody in de indeling application/x-www-form-urlencoded.
properties.clientId	string	Client- of app-id die is geregistreerd bij deze autorisatieserver.
properties.clientRegistrationEndpoint	string	Optionele verwijzing naar een pagina waarop client- of app-registratie voor deze autorisatieserver wordt uitgevoerd. Bevat de absolute URL naar de entiteit waarnaar wordt verwezen.
properties.clientSecret	string	Client- of app-geheim dat is geregistreerd bij deze autorisatieserver. Deze eigenschap wordt niet ingevuld bij 'GET'-bewerkingen! Gebruik post-aanvraag '/listSecrets' om de waarde op te halen.
properties.defaultScope	string	Toegangstokenbereik dat standaard wordt aangevraagd. Kan worden overschreven op API-niveau. Moet worden opgegeven in de vorm van een tekenreeks die door spaties gescheiden waarden bevat.
properties.description	string	Beschrijving van de autorisatieserver. Kan HTML-opmaaktags bevatten.
properties.displayName	string	Gebruiksvriendelijke autorisatieservernaam.
properties.grantTypes	GrantType[]	Vorm van een autorisatietoekenning, die de client gebruikt om het toegangstoken aan te vragen.
properties.resourceOwnerPassword	string	Kan optioneel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Standaardwachtwoord voor resource-eigenaar.
properties.resourceOwnerUsername	string	Kan optioneel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Standaard gebruikersnaam van resource-eigenaar.
properties.supportState	boolean	Als dit waar is, bevat de autorisatieserver de statusparameter van de autorisatieaanvraag tot het antwoord. Client kan de statusparameter gebruiken om protocolbeveiliging te verhogen.
properties.tokenBodyParameters	TokenBodyParameterContract[]	Aanvullende parameters die vereist zijn voor het tokeneindpunt van deze autorisatieserver, weergegeven als een matrix van JSON-objecten met eigenschappen voor naam- en waardetekenreeksen, bijvoorbeeld {"name" : "name value", "value": "a value"}.
properties.tokenEndpoint	string	OAuth-tokeneindpunt. Bevat een absolute URI naar de entiteit waarnaar wordt verwezen.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

BearerTokenSendingMethod

Hiermee geeft u het mechanisme op waarmee het toegangstoken wordt doorgegeven aan de API.

Name	Type	Description
authorizationHeader	string
query	string

ClientAuthenticationMethod

Verificatiemethode die wordt ondersteund door het tokeneindpunt van deze autorisatieserver. Mogelijke waarden zijn Basic en/of Hoofdtekst. Wanneer hoofdtekst is opgegeven, worden clientreferenties en andere parameters doorgegeven in de aanvraagbody in de indeling application/x-www-form-urlencoded.

Name	Type	Description
Basic	string	Basismethode voor clientverificatie.
Body	string	Verificatiemethode op basis van hoofdtekst.

ErrorFieldContract

Fout Veldcontract.

Name	Type	Description
code	string	Foutcode op eigenschapsniveau.
message	string	Door mensen leesbare weergave van fout op eigenschapsniveau.
target	string	Naam van eigenschap.

ErrorResponse

Foutreactie.

Name	Type	Description
error.code	string	Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
error.details	ErrorFieldContract[]	De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout.
error.message	string	Door mensen leesbare weergave van de fout.

GrantType

Vorm van een autorisatietoekenning, die de client gebruikt om het toegangstoken aan te vragen.

Name	Type	Description
authorizationCode	string	Stroom voor het verlenen van autorisatiecode zoals beschreven https://tools.ietf.org/html/rfc6749#section-4.1.
clientCredentials	string	Stroom voor het verlenen van clientreferenties zoals beschreven https://tools.ietf.org/html/rfc6749#section-4.4.
implicit	string	Impliciete stroom voor het verlenen van code zoals beschreven https://tools.ietf.org/html/rfc6749#section-4.2.
resourceOwnerPassword	string	Stroom voor wachtwoordtoestemming van resource-eigenaar zoals beschreven https://tools.ietf.org/html/rfc6749#section-4.3.

TokenBodyParameterContract

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

Name	Type	Description
name	string	naam van de hoofdparameter.
value	string	parameterwaarde body.