ManagedClustersOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:managed_clusters> attribute.
- Inheritance
-
builtins.objectManagedClustersOperations
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_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_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: _models.ManagedCluster, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ManagedCluster]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
parameters
Required
|
Parameters supplied to the Create or Update a Managed Cluster operation. Is either a ManagedCluster type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either ManagedCluster or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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: _models.ManagedClusterAADProfile, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
parameters
Required
|
Parameters supplied to the Reset AAD Profile operation for a Managed Cluster. Is either a ManagedClusterAADProfile type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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: _models.ManagedClusterServicePrincipalProfile, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
parameters
Required
|
Parameters supplied to the Reset Service Principal Profile operation for a Managed Cluster. Is either a ManagedClusterServicePrincipalProfile type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_start
Start Managed Cluster.
Starts a Stopped Managed Cluster.
begin_start(resource_group_name: str, resource_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_stop
Stop Managed Cluster.
Stops a Running Managed Cluster.
begin_stop(resource_group_name: str, resource_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ManagedCluster]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
parameters
Required
|
Parameters supplied to the Update Managed Cluster Tags operation. Is either a TagsObject type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either ManagedCluster or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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) -> ManagedCluster
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
Returns
Type | Description |
---|---|
ManagedCluster or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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) -> ManagedClusterAccessProfile
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
role_name
Required
|
The name of the role for managed cluster accessProfile resource. Required. |
Returns
Type | Description |
---|---|
ManagedClusterAccessProfile or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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) -> ManagedClusterUpgradeProfile
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
Returns
Type | Description |
---|---|
ManagedClusterUpgradeProfile or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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[ManagedCluster]
Returns
Type | Description |
---|---|
An iterator like instance of either ManagedCluster or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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[ManagedCluster]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ManagedCluster or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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) -> CredentialResults
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
Returns
Type | Description |
---|---|
CredentialResults or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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) -> CredentialResults
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
Returns
Type | Description |
---|---|
CredentialResults or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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) -> CredentialResults
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
resource_name
Required
|
The name of the managed cluster resource. Required. |
Returns
Type | Description |
---|---|
CredentialResults or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.containerservice.v2020_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\containerservice\\v2020_12_01\\models\\__init__.py'>
Azure SDK for Python