Managed Clusters - Reset AAD Profile

Usługa:

AKS

Wersja interfejsu API:

2024-09-01

Zresetuj profil usługi AAD klastra zarządzanego.
ostrzeżenie: ten interfejs API zostanie wycofany. Zobacz integracji usługi Azure Active Directory zarządzanej przez usługę AKS w celu zaktualizowania klastra za pomocą usługi Azure AD zarządzanej przez usługę AKS.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
resourceName	path	True	string	Nazwa zasobu klastra zarządzanego. Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
subscriptionId	path	True	string uuid	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
adminGroupObjectIDs	string[]	Lista identyfikatorów obiektów grupy usługi AAD, które będą miały rolę administratora klastra.
clientAppID	string	(PRZESTARZAŁE) Identyfikator aplikacji usługi AAD klienta. Dowiedz się więcej na stronie https://aka.ms/aks/aad-legacy.
enableAzureRBAC	boolean	Czy włączyć kontrolę dostępu opartą na rolach platformy Azure dla autoryzacji platformy Kubernetes.
managed	boolean	Czy włączyć zarządzaną usługę AAD.
serverAppID	string	(PRZESTARZAŁE) Identyfikator aplikacji usługi AAD serwera. Dowiedz się więcej na stronie https://aka.ms/aks/aad-legacy.
serverAppSecret	string	(PRZESTARZAŁE) Wpis tajny aplikacji usługi AAD serwera. Dowiedz się więcej na stronie https://aka.ms/aks/aad-legacy.
tenantID	string	Identyfikator dzierżawy usługi AAD do użycia do uwierzytelniania. Jeśli nie zostanie określony, użyje dzierżawy subskrypcji wdrożenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK		OK
202 Accepted		Akceptowane Nagłówki Location: string
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. Jeśli klaster nie istnieje, zostanie zwrócony błąd 404 (nie znaleziono).

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Reset AAD Profile

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

200

Kod stanu:

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

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z usługi Container Service.
CloudErrorBody	Odpowiedź na błąd z usługi Container Service.
ManagedClusterAADProfile	AADProfile określa atrybuty integracji usługi Azure Active Directory.

CloudError

Odpowiedź na błąd z usługi Container Service.

Nazwa	Typ	Opis
error	CloudErrorBody	Szczegółowe informacje o błędzie.

CloudErrorBody

Odpowiedź na błąd z usługi Container Service.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

ManagedClusterAADProfile

AADProfile określa atrybuty integracji usługi Azure Active Directory.

Nazwa	Typ	Opis
adminGroupObjectIDs	string[]	Lista identyfikatorów obiektów grupy usługi AAD, które będą miały rolę administratora klastra.
clientAppID	string	(PRZESTARZAŁE) Identyfikator aplikacji usługi AAD klienta. Dowiedz się więcej na stronie https://aka.ms/aks/aad-legacy.
enableAzureRBAC	boolean	Czy włączyć kontrolę dostępu opartą na rolach platformy Azure dla autoryzacji platformy Kubernetes.
managed	boolean	Czy włączyć zarządzaną usługę AAD.
serverAppID	string	(PRZESTARZAŁE) Identyfikator aplikacji usługi AAD serwera. Dowiedz się więcej na stronie https://aka.ms/aks/aad-legacy.
serverAppSecret	string	(PRZESTARZAŁE) Wpis tajny aplikacji usługi AAD serwera. Dowiedz się więcej na stronie https://aka.ms/aks/aad-legacy.
tenantID	string	Identyfikator dzierżawy usługi AAD do użycia do uwierzytelniania. Jeśli nie zostanie określony, użyje dzierżawy subskrypcji wdrożenia.