ManagedClustersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerServiceClient's

<xref:managed_clusters> attribute.

Inheritance

builtins.object

ManagedClustersOperations

Constructor

ManagedClustersOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a managed cluster. Creates or updates a managed cluster with the specified configuration for agents and Kubernetes version.
begin_delete	Deletes a managed cluster. Deletes the managed cluster with a specified resource group and name.
begin_reset_aad_profile	Reset AAD Profile of a managed cluster. Update the AAD Profile for a managed cluster.
begin_reset_service_principal_profile	Reset Service Principal Profile of a managed cluster. Update the service principal Profile for a managed cluster.
begin_rotate_cluster_certificates	Rotate certificates of a managed cluster. Rotate certificates of a managed cluster.
begin_run_command	Run Command against Managed Kubernetes Service. Submit a command to run against managed kubernetes service, it will create a pod to run the command.
begin_start	Start Managed Cluster. Starts a Stopped Managed Cluster.
begin_stop	Stop Managed Cluster. Stops a Running Managed Cluster.
begin_update_tags	Updates tags on a managed cluster. Updates a managed cluster with the specified tags.
get	Gets a managed cluster. Gets the details of the managed cluster with a specified resource group and name.
get_access_profile	Gets an access profile of a managed cluster. Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name. WARNING: This API will be deprecated. Instead use ListClusterUserCredentials or ListClusterAdminCredentials .
get_command_result	Get command result. Get command result from previous runCommand invoke.
get_os_options	Gets supported OS options in the specified subscription. Gets supported OS options in the specified subscription.
get_upgrade_profile	Gets upgrade profile for a managed cluster. Gets the details of the upgrade profile for a managed cluster with a specified resource group and name.
list	Gets a list of managed clusters in the specified subscription. Gets a list of managed clusters in the specified subscription. The operation returns properties of each managed cluster.
list_by_resource_group	Lists managed clusters in the specified subscription and resource group. Lists managed clusters in the specified subscription and resource group. The operation returns properties of each managed cluster.
list_cluster_admin_credentials	Gets cluster admin credential of a managed cluster. Gets cluster admin credential of the managed cluster with a specified resource group and name.
list_cluster_monitoring_user_credentials	Gets cluster monitoring user credential of a managed cluster. Gets cluster monitoring user credential of the managed cluster with a specified resource group and name.
list_cluster_user_credentials	Gets cluster user credential of a managed cluster. Gets cluster user credential of the managed cluster with a specified resource group and name.

begin_create_or_update

Creates or updates a managed cluster.

Creates or updates a managed cluster with the specified configuration for agents and Kubernetes version.

begin_create_or_update(resource_group_name: str, resource_name: str, parameters: azure.mgmt.containerservice.v2021_03_01.models._models_py3.ManagedCluster, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.containerservice.v2021_03_01.models._models_py3.ManagedCluster]

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

parameters

ManagedCluster

Required

Parameters supplied to the Create or Update a Managed Cluster operation.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedCluster or the result of cls(response)

Return type

LROPoller[ManagedCluster]

Exceptions

HttpResponseError

begin_delete

Deletes a managed cluster.

Deletes the managed cluster with a specified resource group and name.

begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_reset_aad_profile

Reset AAD Profile of a managed cluster.

Update the AAD Profile for a managed cluster.

begin_reset_aad_profile(resource_group_name: str, resource_name: str, parameters: azure.mgmt.containerservice.v2021_03_01.models._models_py3.ManagedClusterAADProfile, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

parameters

ManagedClusterAADProfile

Required

Parameters supplied to the Reset AAD Profile operation for a Managed Cluster.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_reset_service_principal_profile

Reset Service Principal Profile of a managed cluster.

Update the service principal Profile for a managed cluster.

begin_reset_service_principal_profile(resource_group_name: str, resource_name: str, parameters: azure.mgmt.containerservice.v2021_03_01.models._models_py3.ManagedClusterServicePrincipalProfile, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

parameters

ManagedClusterServicePrincipalProfile

Required

Parameters supplied to the Reset Service Principal Profile operation for a Managed Cluster.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_rotate_cluster_certificates

Rotate certificates of a managed cluster.

Rotate certificates of a managed cluster.

begin_rotate_cluster_certificates(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_run_command

Run Command against Managed Kubernetes Service.

Submit a command to run against managed kubernetes service, it will create a pod to run the command.

begin_run_command(resource_group_name: str, resource_name: str, request_payload: azure.mgmt.containerservice.v2021_03_01.models._models_py3.RunCommandRequest, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.containerservice.v2021_03_01.models._models_py3.RunCommandResult]

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

request_payload

RunCommandRequest

Required

Parameters supplied to the RunCommand operation.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either RunCommandResult or the result of cls(response)

Return type

LROPoller[RunCommandResult]

Exceptions

HttpResponseError

begin_start

Start Managed Cluster.

Starts a Stopped Managed Cluster.

begin_start(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_stop

Stop Managed Cluster.

Stops a Running Managed Cluster.

begin_stop(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_update_tags

Updates tags on a managed cluster.

Updates a managed cluster with the specified tags.

begin_update_tags(resource_group_name: str, resource_name: str, parameters: azure.mgmt.containerservice.v2021_03_01.models._models_py3.TagsObject, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.containerservice.v2021_03_01.models._models_py3.ManagedCluster]

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

parameters

TagsObject

Required

Parameters supplied to the Update Managed Cluster Tags operation.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedCluster or the result of cls(response)

Return type

LROPoller[ManagedCluster]

Exceptions

HttpResponseError

get

Gets a managed cluster.

Gets the details of the managed cluster with a specified resource group and name.

get(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2021_03_01.models._models_py3.ManagedCluster

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

ManagedCluster, or the result of cls(response)

Return type

ManagedCluster

Exceptions

HttpResponseError

get_access_profile

Gets an access profile of a managed cluster.

Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name. WARNING: This API will be deprecated. Instead use ListClusterUserCredentials or ListClusterAdminCredentials .

get_access_profile(resource_group_name: str, resource_name: str, role_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2021_03_01.models._models_py3.ManagedClusterAccessProfile

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

role_name

str

Required

The name of the role for managed cluster accessProfile resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

ManagedClusterAccessProfile, or the result of cls(response)

Return type

ManagedClusterAccessProfile

Exceptions

HttpResponseError

get_command_result

Get command result.

Get command result from previous runCommand invoke.

get_command_result(resource_group_name: str, resource_name: str, command_id: str, **kwargs: Any) -> Optional[azure.mgmt.containerservice.v2021_03_01.models._models_py3.RunCommandResult]

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

command_id

str

Required

Id of the command request.

cls

callable

A custom type or function that will be passed the direct response

Returns

RunCommandResult, or the result of cls(response)

Return type

RunCommandResult,

None

Exceptions

HttpResponseError

get_os_options

Gets supported OS options in the specified subscription.

Gets supported OS options in the specified subscription.

get_os_options(location: str, resource_type: Optional[str] = None, **kwargs: Any) -> azure.mgmt.containerservice.v2021_03_01.models._models_py3.OSOptionProfile

Parameters

location

str

Required

The name of a supported Azure region.

resource_type

str

Required

resource type for which the OS options needs to be returned. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

OSOptionProfile, or the result of cls(response)

Return type

OSOptionProfile

Exceptions

HttpResponseError

get_upgrade_profile

Gets upgrade profile for a managed cluster.

Gets the details of the upgrade profile for a managed cluster with a specified resource group and name.

get_upgrade_profile(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2021_03_01.models._models_py3.ManagedClusterUpgradeProfile

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

ManagedClusterUpgradeProfile, or the result of cls(response)

Return type

ManagedClusterUpgradeProfile

Exceptions

HttpResponseError

list

Gets a list of managed clusters in the specified subscription.

Gets a list of managed clusters in the specified subscription. The operation returns properties of each managed cluster.

list(**kwargs: Any) -> Iterable[azure.mgmt.containerservice.v2021_03_01.models._models_py3.ManagedClusterListResult]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedClusterListResult or the result of cls(response)

Return type

ItemPaged[ManagedClusterListResult]

Exceptions

HttpResponseError

list_by_resource_group

Lists managed clusters in the specified subscription and resource group.

Lists managed clusters in the specified subscription and resource group. The operation returns properties of each managed cluster.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.containerservice.v2021_03_01.models._models_py3.ManagedClusterListResult]

Parameters

resource_group_name

str

Required

The name of the resource group.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedClusterListResult or the result of cls(response)

Return type

ItemPaged[ManagedClusterListResult]

Exceptions

HttpResponseError

list_cluster_admin_credentials

Gets cluster admin credential of a managed cluster.

Gets cluster admin credential of the managed cluster with a specified resource group and name.

list_cluster_admin_credentials(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2021_03_01.models._models_py3.CredentialResults

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

CredentialResults, or the result of cls(response)

Return type

CredentialResults

Exceptions

HttpResponseError

list_cluster_monitoring_user_credentials

Gets cluster monitoring user credential of a managed cluster.

Gets cluster monitoring user credential of the managed cluster with a specified resource group and name.

list_cluster_monitoring_user_credentials(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2021_03_01.models._models_py3.CredentialResults

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

CredentialResults, or the result of cls(response)

Return type

CredentialResults

Exceptions

HttpResponseError

list_cluster_user_credentials

Gets cluster user credential of a managed cluster.

Gets cluster user credential of the managed cluster with a specified resource group and name.

list_cluster_user_credentials(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2021_03_01.models._models_py3.CredentialResults

Parameters

resource_group_name

str

Required

The name of the resource group.

resource_name

str

Required

The name of the managed cluster resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

CredentialResults, or the result of cls(response)

Return type

CredentialResults

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.containerservice.v2021_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\containerservice\\v2021_03_01\\models\\__init__.py'>