Managed Clusters - Reset AAD Profile

Dienst:

AKS

API-Version:

2024-09-01

Setzen Sie das AAD-Profil eines verwalteten Clusters zurück.
WARNUNG: Diese API ist veraltet. Lesen Sie AKS-verwaltete Azure Active Directory-Integration, um Ihren Cluster mit AKS-verwalteten Azure AD zu aktualisieren.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile?api-version=2024-09-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string	Der Name der verwalteten Clusterressource. RegEx-Muster: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
subscriptionId	path	True	string uuid	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
adminGroupObjectIDs	string[]	Die Liste der AAD-Gruppenobjekt-IDs, die über die Administratorrolle des Clusters verfügen.
clientAppID	string	(VERALTET) Die Client-AAD-Anwendungs-ID. Weitere Informationen finden Sie unter https://aka.ms/aks/aad-legacy.
enableAzureRBAC	boolean	Gibt an, ob Azure RBAC für kubernetes-Autorisierung aktiviert werden soll.
managed	boolean	Gibt an, ob verwaltete AAD aktiviert werden soll.
serverAppID	string	(VERALTET) Die Server-AAD-Anwendungs-ID. Weitere Informationen finden Sie unter https://aka.ms/aks/aad-legacy.
serverAppSecret	string	(VERALTET) Der AAD-Anwendungsschlüssel des Servers. Weitere Informationen finden Sie unter https://aka.ms/aks/aad-legacy.
tenantID	string	Die AAD-Mandanten-ID, die für die Authentifizierung verwendet werden soll. Wenn nicht angegeben, wird der Mandant des Bereitstellungsabonnements verwendet.

Antworten

Name	Typ	Beschreibung
200 OK		OKAY
202 Accepted		Angenommen Header Location: string
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. Wenn der Cluster nicht vorhanden ist, wird 404 (Nicht gefunden) zurückgegeben.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Reset AAD Profile

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/resetAADProfile?api-version=2024-09-01

{
  "clientAppID": "clientappid",
  "serverAppID": "serverappid",
  "serverAppSecret": "serverappsecret",
  "tenantID": "tenantid"
}

Java

import com.azure.resourcemanager.containerservice.models.ManagedClusterAadProfile;

/**
 * Samples for ManagedClusters ResetAadProfile.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/
     * ManagedClustersResetAADProfile.json
     */
    /**
     * Sample code: Reset AAD Profile.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void resetAADProfile(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getManagedClusters().resetAadProfile("rg1", "clustername1",
            new ManagedClusterAadProfile().withClientAppId("clientappid").withServerAppId("serverappid")
                .withServerAppSecret("fakeTokenPlaceholder").withTenantId("tenantid"),
            com.azure.core.util.Context.NONE);
    }
}

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.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python managed_clusters_reset_aad_profile.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 = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    client.managed_clusters.begin_reset_aad_profile(
        resource_group_name="rg1",
        resource_name="clustername1",
        parameters={
            "clientAppID": "clientappid",
            "serverAppID": "serverappid",
            "serverAppSecret": "serverappsecret",
            "tenantID": "tenantid",
        },
    ).result()


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersResetAADProfile.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 armcontainerservice_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/containerservice/armcontainerservice/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersResetAADProfile.json
func ExampleManagedClustersClient_BeginResetAADProfile() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewManagedClustersClient().BeginResetAADProfile(ctx, "rg1", "clustername1", armcontainerservice.ManagedClusterAADProfile{
		ClientAppID:     to.Ptr("clientappid"),
		ServerAppID:     to.Ptr("serverappid"),
		ServerAppSecret: to.Ptr("serverappsecret"),
		TenantID:        to.Ptr("tenantid"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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 { ContainerServiceClient } = require("@azure/arm-containerservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to **WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.
 *
 * @summary **WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersResetAADProfile.json
 */
async function resetAadProfile() {
  const subscriptionId =
    process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERSERVICE_RESOURCE_GROUP"] || "rg1";
  const resourceName = "clustername1";
  const parameters = {
    clientAppID: "clientappid",
    serverAppID: "serverappid",
    serverAppSecret: "serverappsecret",
    tenantID: "tenantid",
  };
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.managedClusters.beginResetAADProfileAndWait(
    resourceGroupName,
    resourceName,
    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

Statuscode:

202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Containerdiensts.
CloudErrorBody	Eine Fehlerantwort des Containerdiensts.
ManagedClusterAADProfile	AADProfile gibt Attribute für die Azure Active Directory-Integration an.

CloudError

Eine Fehlerantwort des Containerdiensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Details zum Fehler.

CloudErrorBody

Eine Fehlerantwort des Containerdiensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

ManagedClusterAADProfile

AADProfile gibt Attribute für die Azure Active Directory-Integration an.

Name	Typ	Beschreibung
adminGroupObjectIDs	string[]	Die Liste der AAD-Gruppenobjekt-IDs, die über die Administratorrolle des Clusters verfügen.
clientAppID	string	(VERALTET) Die Client-AAD-Anwendungs-ID. Weitere Informationen finden Sie unter https://aka.ms/aks/aad-legacy.
enableAzureRBAC	boolean	Gibt an, ob Azure RBAC für kubernetes-Autorisierung aktiviert werden soll.
managed	boolean	Gibt an, ob verwaltete AAD aktiviert werden soll.
serverAppID	string	(VERALTET) Die Server-AAD-Anwendungs-ID. Weitere Informationen finden Sie unter https://aka.ms/aks/aad-legacy.
serverAppSecret	string	(VERALTET) Der AAD-Anwendungsschlüssel des Servers. Weitere Informationen finden Sie unter https://aka.ms/aks/aad-legacy.
tenantID	string	Die AAD-Mandanten-ID, die für die Authentifizierung verwendet werden soll. Wenn nicht angegeben, wird der Mandant des Bereitstellungsabonnements verwendet.