OpenId Connect Provider - Update

Dienst:

API Management

API-Version:

2022-08-01

Updates den spezifischen OpenID Connect-Anbieter.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
opid	path	True	string	Bezeichner des OpenID Connect-Anbieters. 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.clientId	string	Client-ID der Entwicklerkonsole, bei der es sich um die Clientanwendung handelt.
properties.clientSecret	string	Geheimer Clientschlüssel der Entwicklerkonsole, bei der es sich um die Clientanwendung handelt.
properties.description	string	Benutzerfreundliche Beschreibung des OpenID Connect-Anbieters.
properties.displayName	string	Benutzerfreundlicher Name des OpenID Connect-Anbieters.
properties.metadataEndpoint	string	Metadatenendpunkt-URI.
properties.useInApiDocumentation	boolean	Wenn true, wird der Open ID Connect-Anbieter in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird.
properties.useInTestConsole	boolean	Wenn true, kann der Open ID Connect-Anbieter in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird.

Antworten

Name	Typ	Beschreibung
200 OK	OpenidConnectProviderContract	Der OpenIdConnect-Anbieter wurde 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

ApiManagementUpdateOpenIdConnectProvider

Beispielanforderung

HTTP

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


{
  "properties": {
    "clientSecret": "updatedsecret",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

Java

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

/** Samples for OpenIdConnectProvider Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateOpenIdConnectProvider.json
     */
    /**
     * Sample code: ApiManagementUpdateOpenIdConnectProvider.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateOpenIdConnectProvider(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        OpenidConnectProviderContract resource =
            manager
                .openIdConnectProviders()
                .getWithResponse("rg1", "apimService1", "templateOpenIdConnect2", com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withClientSecret("updatedsecret")
            .withUseInTestConsole(false)
            .withUseInApiDocumentation(true)
            .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_open_id_connect_provider.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.open_id_connect_provider.update(
        resource_group_name="rg1",
        service_name="apimService1",
        opid="templateOpenIdConnect2",
        if_match="*",
        parameters={
            "properties": {"clientSecret": "updatedsecret", "useInApiDocumentation": True, "useInTestConsole": False}
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateOpenIdConnectProvider.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/ApiManagementUpdateOpenIdConnectProvider.json
func ExampleOpenIDConnectProviderClient_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.NewOpenIDConnectProviderClient().Update(ctx, "rg1", "apimService1", "templateOpenIdConnect2", "*", armapimanagement.OpenidConnectProviderUpdateContract{
		Properties: &armapimanagement.OpenidConnectProviderUpdateContractProperties{
			ClientSecret:          to.Ptr("updatedsecret"),
			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.OpenidConnectProviderContract = armapimanagement.OpenidConnectProviderContract{
	// 	Name: to.Ptr("templateOpenIdConnect2"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/openidconnectproviders"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2"),
	// 	Properties: &armapimanagement.OpenidConnectProviderContractProperties{
	// 		Description: to.Ptr("open id provider template2"),
	// 		ClientID: to.Ptr("oidprovidertemplate2"),
	// 		DisplayName: to.Ptr("templateoidprovider2"),
	// 		MetadataEndpoint: to.Ptr("https://oidprovider-template2.net"),
	// 		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 specific OpenID Connect Provider.
 *
 * @summary Updates the specific OpenID Connect Provider.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateOpenIdConnectProvider.json
 */
async function apiManagementUpdateOpenIdConnectProvider() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const opid = "templateOpenIdConnect2";
  const ifMatch = "*";
  const parameters = {
    clientSecret: "updatedsecret",
    useInApiDocumentation: true,
    useInTestConsole: false,
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.openIdConnectProvider.update(
    resourceGroupName,
    serviceName,
    opid,
    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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2",
  "type": "Microsoft.ApiManagement/service/openidconnectproviders",
  "name": "templateOpenIdConnect2",
  "properties": {
    "displayName": "templateoidprovider2",
    "description": "open id provider template2",
    "metadataEndpoint": "https://oidprovider-template2.net",
    "clientId": "oidprovidertemplate2",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

Definitionen

Name	Beschreibung
ErrorFieldContract	Fehlerfeldvertrag.
ErrorResponse	Fehlerantwort.
OpenidConnectProviderContract	Details des OpenId Connect-Anbieters.
OpenidConnectProviderUpdateContract	Parameter, die für den Vorgang OpenID Connect Provider aktualisieren angegeben werden.

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.

OpenidConnectProviderContract

Details des OpenId Connect-Anbieters.

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.clientId	string	Client-ID der Entwicklerkonsole, bei der es sich um die Clientanwendung handelt.
properties.clientSecret	string	Geheimer Clientschlüssel der Entwicklerkonsole, bei der es sich um die Clientanwendung handelt.
properties.description	string	Benutzerfreundliche Beschreibung des OpenID Connect-Anbieters.
properties.displayName	string	Benutzerfreundlicher Name des OpenID Connect-Anbieters.
properties.metadataEndpoint	string	Metadatenendpunkt-URI.
properties.useInApiDocumentation	boolean	Wenn true, wird der Open ID Connect-Anbieter in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird.
properties.useInTestConsole	boolean	Wenn true, kann der Open ID Connect-Anbieter 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"

OpenidConnectProviderUpdateContract

Parameter, die für den Vorgang OpenID Connect Provider aktualisieren angegeben werden.

Name	Typ	Beschreibung
properties.clientId	string	Client-ID der Entwicklerkonsole, bei der es sich um die Clientanwendung handelt.
properties.clientSecret	string	Geheimer Clientschlüssel der Entwicklerkonsole, bei der es sich um die Clientanwendung handelt.
properties.description	string	Benutzerfreundliche Beschreibung des OpenID Connect-Anbieters.
properties.displayName	string	Benutzerfreundlicher Name des OpenID Connect-Anbieters.
properties.metadataEndpoint	string	Metadatenendpunkt-URI.
properties.useInApiDocumentation	boolean	Wenn true, wird der Open ID Connect-Anbieter in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird.
properties.useInTestConsole	boolean	Wenn true, kann der Open ID Connect-Anbieter in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird.