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_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.
async begin_create_or_update(resource_group_name: str, resource_name: str, parameters: _models.ManagedCluster, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_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 AsyncLROPoller 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.
async begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> AsyncLROPoller[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 AsyncLROPoller 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.
async begin_reset_aad_profile(resource_group_name: str, resource_name: str, parameters: _models.ManagedClusterAADProfile, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[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 AsyncLROPoller 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.
async begin_reset_service_principal_profile(resource_group_name: str, resource_name: str, parameters: _models.ManagedClusterServicePrincipalProfile, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[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 AsyncLROPoller 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.
async begin_rotate_cluster_certificates(resource_group_name: str, resource_name: str, **kwargs: Any) -> AsyncLROPoller[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 AsyncLROPoller 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.
async begin_update_tags(resource_group_name: str, resource_name: str, parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_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 AsyncLROPoller 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.
async get(resource_group_name: str, resource_name: str, **kwargs: Any) -> ManagedClusterParameters
| 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 .
async get_access_profile(resource_group_name: str, resource_name: str, role_name: str, **kwargs: Any) -> ManagedClusterAccessProfileParameters
| 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.
async get_upgrade_profile(resource_group_name: str, resource_name: str, **kwargs: Any) -> ManagedClusterUpgradeProfileParameters
| 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) -> AsyncIterable[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) -> AsyncIterable[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.
async list_cluster_admin_credentials(resource_group_name: str, resource_name: str, **kwargs: Any) -> CredentialResultsParameters
| 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.
async list_cluster_monitoring_user_credentials(resource_group_name: str, resource_name: str, **kwargs: Any) -> CredentialResultsParameters
| 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.
async list_cluster_user_credentials(resource_group_name: str, resource_name: str, **kwargs: Any) -> CredentialResultsParameters
| 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_06_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\containerservice\\v2020_06_01\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for