ManagedClustersOperations Class

ManagedClustersOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
ManagedClustersOperations

Constructor

ManagedClustersOperations(client, config, serializer, deserializer) -> None

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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_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.

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.v2020_02_01.models._models_py3.ManagedCluster, **kwargs: typing.Any) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('_models.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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either ManagedCluster or the result of cls(response)

Return type

Exceptions

~azure.core.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: typing.Any) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

~azure.core.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.v2020_02_01.models._models_py3.ManagedClusterAADProfile, **kwargs: typing.Any) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

~azure.core.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.v2020_02_01.models._models_py3.ManagedClusterServicePrincipalProfile, **kwargs: typing.Any) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

~azure.core.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: typing.Any) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

~azure.core.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.v2020_02_01.models._models_py3.TagsObject, **kwargs: typing.Any) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('_models.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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either ManagedCluster or the result of cls(response)

Return type

Exceptions

~azure.core.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: typing.Any) -> azure.mgmt.containerservice.v2020_02_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

Exceptions

~azure.core.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.

get_access_profile(resource_group_name: str, resource_name: str, role_name: str, **kwargs: typing.Any) -> azure.mgmt.containerservice.v2020_02_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

Exceptions

~azure.core.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: typing.Any) -> azure.mgmt.containerservice.v2020_02_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

Exceptions

~azure.core.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: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.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

Exceptions

~azure.core.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: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.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

Exceptions

~azure.core.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: typing.Any) -> azure.mgmt.containerservice.v2020_02_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

Exceptions

~azure.core.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: typing.Any) -> azure.mgmt.containerservice.v2020_02_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

Exceptions

~azure.core.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: typing.Any) -> azure.mgmt.containerservice.v2020_02_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

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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