Managed Clusters - Reset AAD Profile

Služba:

AKS

Verze rozhraní API:

2024-09-01

Resetujte profil AAD spravovaného clusteru.
UPOZORNĚNÍ: Toto rozhraní API bude zastaralé. Informace o aktualizaci clusteru pomocí služby Azure AD spravované službou AKS najdete v integrace Azure Active Directory spravované službou AKS.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
resourceName	path	True	string	Název prostředku spravovaného clusteru. Vzor regulárního výrazu: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
subscriptionId	path	True	string uuid	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
adminGroupObjectIDs	string[]	Seznam ID objektů skupiny AAD, které budou mít roli správce clusteru.
clientAppID	string	(ZASTARALÉ) ID aplikace AAD klienta. Další informace najdete v https://aka.ms/aks/aad-legacy.
enableAzureRBAC	boolean	Určuje, jestli chcete povolit Azure RBAC pro autorizaci Kubernetes.
managed	boolean	Jestli chcete povolit spravovanou službu AAD.
serverAppID	string	(ZASTARALÉ) ID aplikace AAD serveru. Další informace najdete v https://aka.ms/aks/aad-legacy.
serverAppSecret	string	(ZASTARALÉ) Tajný klíč aplikace AAD serveru. Další informace najdete v https://aka.ms/aks/aad-legacy.
tenantID	string	ID tenanta AAD, které se má použít k ověřování. Pokud není zadaný, použije tenanta předplatného nasazení.

Odpovědi

Name	Typ	Description
200 OK		OK
202 Accepted		Přijal Hlavičky Location: string
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala. Pokud cluster neexistuje, vrátí se hodnota 404 (Nenalezena).

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Reset AAD Profile

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

Stavový kód:

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

Definice

Name	Description
CloudError	Odpověď na chybu ze služby Container Service
CloudErrorBody	Odpověď na chybu ze služby Container Service
ManagedClusterAADProfile	AADProfile určuje atributy pro integraci Azure Active Directory.

CloudError

Odpověď na chybu ze služby Container Service

Name	Typ	Description
error	CloudErrorBody	Podrobnosti o chybě

CloudErrorBody

Odpověď na chybu ze služby Container Service

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

ManagedClusterAADProfile

AADProfile určuje atributy pro integraci Azure Active Directory.

Name	Typ	Description
adminGroupObjectIDs	string[]	Seznam ID objektů skupiny AAD, které budou mít roli správce clusteru.
clientAppID	string	(ZASTARALÉ) ID aplikace AAD klienta. Další informace najdete v https://aka.ms/aks/aad-legacy.
enableAzureRBAC	boolean	Určuje, jestli chcete povolit Azure RBAC pro autorizaci Kubernetes.
managed	boolean	Jestli chcete povolit spravovanou službu AAD.
serverAppID	string	(ZASTARALÉ) ID aplikace AAD serveru. Další informace najdete v https://aka.ms/aks/aad-legacy.
serverAppSecret	string	(ZASTARALÉ) Tajný klíč aplikace AAD serveru. Další informace najdete v https://aka.ms/aks/aad-legacy.
tenantID	string	ID tenanta AAD, které se má použít k ověřování. Pokud není zadaný, použije tenanta předplatného nasazení.