Managed Clusters - Reset AAD Profile

Service:

AKS

API Version:

2020-04-01

Reset AAD Profile of a managed cluster.
Update the AAD Profile for a managed cluster.

HTTP

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group.
resourceName	path	True	string	The name of the managed cluster resource. Regex pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Request Body

Name	Type	Description
adminGroupObjectIDs	string[]	AAD group object IDs that will have admin role of the cluster.
clientAppID	string	The client AAD application ID.
managed	boolean	Whether to enable managed AAD.
serverAppID	string	The server AAD application ID.
serverAppSecret	string	The server AAD application secret.
tenantID	string	The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

Responses

Name	Type	Description
200 OK		OK
202 Accepted		Accepted
Other Status Codes	CloudError	Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Reset AAD Profile

Sample request

HTTP

HTTP

POST https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/resetAADProfile?api-version=2020-04-01

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

Sample response

Status code:

200

Status code:

202

Definitions

Name	Description
CloudError	An error response from the Container service.
CloudErrorBody	An error response from the Container service.
ManagedClusterAADProfile	AADProfile specifies attributes for Azure Active Directory integration.

CloudError

Object

An error response from the Container service.

Name	Type	Description
error	CloudErrorBody	Details about the error.

CloudErrorBody

Object

An error response from the Container service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ManagedClusterAADProfile

Object

AADProfile specifies attributes for Azure Active Directory integration.

Name	Type	Description
adminGroupObjectIDs	string[]	AAD group object IDs that will have admin role of the cluster.
clientAppID	string	The client AAD application ID.
managed	boolean	Whether to enable managed AAD.
serverAppID	string	The server AAD application ID.
serverAppSecret	string	The server AAD application secret.
tenantID	string	The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.