ManagedClustersOperations Class

Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<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.
begin_delete	Deletes a managed cluster. Deletes a managed cluster.
begin_reset_aad_profile	Reset the AAD Profile of a managed cluster. Reset the AAD Profile of a managed cluster.
begin_reset_service_principal_profile	Reset the Service Principal Profile of a managed cluster. This action cannot be performed on a cluster that is not using a service principal.
begin_rotate_cluster_certificates	Rotates the certificates of a managed cluster. See Certificate rotation for more details about rotating managed cluster certificates.
begin_run_command	Submits a command to run against the Managed Cluster. AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see AKS Run Command.
begin_start	Starts a previously stopped Managed Cluster. See starting a cluster for more details about starting a cluster.
begin_stop	Stops a Managed Cluster. This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See stopping a cluster for more details about stopping a cluster.
begin_update_tags	Updates tags on a managed cluster. Updates tags on a managed cluster.
get	Gets a managed cluster. Gets a managed cluster.
get_access_profile	Gets an access profile of a managed cluster. WARNING: This API will be deprecated. Instead use ListClusterUserCredentials or ListClusterAdminCredentials .
get_command_result	Gets the results of a command which has been run on the Managed Cluster. Gets the results of a command which has been run on the Managed Cluster.
get_os_options	Gets supported OS options in the specified subscription. Gets supported OS options in the specified subscription.
get_upgrade_profile	Gets the upgrade profile of a managed cluster. Gets the upgrade profile of a managed cluster.
list	Gets a list of managed clusters in the specified subscription. Gets a list of managed clusters in the specified subscription.
list_by_resource_group	Lists managed clusters in the specified subscription and resource group. Lists managed clusters in the specified subscription and resource group.
list_cluster_admin_credentials	Lists the admin credentials of a managed cluster. Lists the admin credentials of a managed cluster.
list_cluster_monitoring_user_credentials	Lists the cluster monitoring user credentials of a managed cluster. Lists the cluster monitoring user credentials of a managed cluster.
list_cluster_user_credentials	Lists the user credentials of a managed cluster. Lists the user credentials of a managed cluster.
list_outbound_network_dependencies_endpoints	Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.

begin_create_or_update

Creates or updates a managed cluster.

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

Parameters

resource_group_name: str

Required

The name of the resource group. The name is case insensitive.

resource_name: str

Required

The name of the managed cluster resource.

parameters: ManagedCluster

Required

The managed cluster to create or update.

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.

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. The name is case insensitive.

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 the AAD Profile of a managed cluster.

begin_reset_aad_profile(resource_group_name: str, resource_name: str, parameters: azure.mgmt.containerservice.v2022_02_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. The name is case insensitive.

resource_name: str

Required

The name of the managed cluster resource.

parameters: ManagedClusterAADProfile

Required

The AAD profile to set on the 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 the Service Principal Profile of a managed cluster.

This action cannot be performed on a cluster that is not using a service principal.

begin_reset_service_principal_profile(resource_group_name: str, resource_name: str, parameters: azure.mgmt.containerservice.v2022_02_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. The name is case insensitive.

resource_name: str

Required

The name of the managed cluster resource.

parameters: ManagedClusterServicePrincipalProfile

Required

The service principal profile to set on the 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

Rotates the certificates of a managed cluster.

See Certificate rotation for more details about rotating managed cluster certificates.

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. The name is case insensitive.

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

Submits a command to run against the Managed Cluster.

AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see AKS Run Command.

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

Parameters

resource_group_name: str

Required

The name of the resource group. The name is case insensitive.

resource_name: str

Required

The name of the managed cluster resource.

request_payload: RunCommandRequest

Required

The run command request.

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

Starts a previously stopped Managed Cluster.

See starting a cluster for more details about starting a 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. The name is case insensitive.

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

Stops a Managed Cluster.

This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See stopping a cluster for more details about stopping a 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. The name is case insensitive.

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.

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

Parameters

resource_group_name: str

Required

The name of the resource group. The name is case insensitive.

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.

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

Parameters

resource_group_name: str

Required

The name of the resource group. The name is case insensitive.

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.

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.v2022_02_01.models._models_py3.ManagedClusterAccessProfile

Parameters

resource_group_name: str

Required

The name of the resource group. The name is case insensitive.

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

Gets the results of a command which has been run on the Managed Cluster.

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

Parameters

resource_group_name: str

Required

The name of the resource group. The name is case insensitive.

resource_name: str

Required

The name of the managed cluster resource.

command_id: str

Required

Id of the command.

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.

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

Parameters

location: str

Required

The name of Azure region.

resource_type: str

Required

The 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 the upgrade profile of a managed cluster.

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

Parameters

resource_group_name: str

Required

The name of the resource group. The name is case insensitive.

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.

list(**kwargs: Any) -> Iterable[azure.mgmt.containerservice.v2022_02_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.

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

Parameters

resource_group_name: str

Required

The name of the resource group. The name is case insensitive.

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

Lists the admin credentials of a managed cluster.

list_cluster_admin_credentials(resource_group_name: str, resource_name: str, server_fqdn: Optional[str] = None, **kwargs: Any) -> azure.mgmt.containerservice.v2022_02_01.models._models_py3.CredentialResults

Parameters

resource_group_name: str

Required

The name of the resource group. The name is case insensitive.

resource_name: str

Required

The name of the managed cluster resource.

server_fqdn: str

Required

server fqdn type for credentials to be returned. Default value is None.

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

Lists the cluster monitoring user credentials of a managed cluster.

list_cluster_monitoring_user_credentials(resource_group_name: str, resource_name: str, server_fqdn: Optional[str] = None, **kwargs: Any) -> azure.mgmt.containerservice.v2022_02_01.models._models_py3.CredentialResults

Parameters

resource_group_name: str

Required

The name of the resource group. The name is case insensitive.

resource_name: str

Required

The name of the managed cluster resource.

server_fqdn: str

Required

server fqdn type for credentials to be returned. Default value is None.

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

Lists the user credentials of a managed cluster.

list_cluster_user_credentials(resource_group_name: str, resource_name: str, server_fqdn: Optional[str] = None, format: Optional[Union[str, azure.mgmt.containerservice.v2022_02_01.models._container_service_client_enums.Format]] = None, **kwargs: Any) -> azure.mgmt.containerservice.v2022_02_01.models._models_py3.CredentialResults

Parameters

resource_group_name: str

Required

The name of the resource group. The name is case insensitive.

resource_name: str

Required

The name of the managed cluster resource.

server_fqdn: str

Required

server fqdn type for credentials to be returned. Default value is None.

format: str or Format

Required

Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path. Default value is None.

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_outbound_network_dependencies_endpoints

Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.

Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.

list_outbound_network_dependencies_endpoints(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[azure.mgmt.containerservice.v2022_02_01.models._models_py3.OutboundEnvironmentEndpointCollection]

Parameters

resource_group_name: str

Required

The name of the resource group. The name is case insensitive.

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

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

Return type

ItemPaged[OutboundEnvironmentEndpointCollection]

Exceptions

HttpResponseError

Attributes

models

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