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. |
| 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.
Creates or updates a managed cluster.
async begin_create_or_update(resource_group_name: str, resource_name: str, parameters: azure.mgmt.containerservice.v2021_05_01.models._models_py3.ManagedCluster, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.containerservice.v2021_05_01.models._models_py3.ManagedCluster]Parameters
- 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
begin_delete
Deletes a managed cluster.
Deletes a managed cluster.
async begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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
begin_reset_aad_profile
Reset the AAD Profile of a managed cluster.
Reset the AAD Profile of a managed cluster.
async begin_reset_aad_profile(resource_group_name: str, resource_name: str, parameters: azure.mgmt.containerservice.v2021_05_01.models._models_py3.ManagedClusterAADProfile, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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
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.
async begin_reset_service_principal_profile(resource_group_name: str, resource_name: str, parameters: azure.mgmt.containerservice.v2021_05_01.models._models_py3.ManagedClusterServicePrincipalProfile, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- parameters
- ManagedClusterServicePrincipalProfile
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 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
begin_rotate_cluster_certificates
Rotates the certificates of a managed cluster.
See Certificate rotation for more details about rotating managed cluster certificates.
async begin_rotate_cluster_certificates(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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
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.
async begin_run_command(resource_group_name: str, resource_name: str, request_payload: azure.mgmt.containerservice.v2021_05_01.models._models_py3.RunCommandRequest, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.containerservice.v2021_05_01.models._models_py3.RunCommandResult]Parameters
- 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 RunCommandResult or the result of cls(response)
Return type
Exceptions
begin_start
Starts a previously stopped Managed Cluster.
See starting a cluster for more details about starting a cluster.
async begin_start(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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
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.
async begin_stop(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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
begin_update_tags
Updates tags on a managed cluster.
Updates tags on a managed cluster.
async begin_update_tags(resource_group_name: str, resource_name: str, parameters: azure.mgmt.containerservice.v2021_05_01.models._models_py3.TagsObject, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.containerservice.v2021_05_01.models._models_py3.ManagedCluster]Parameters
- 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
get
Gets a managed cluster.
Gets a managed cluster.
async get(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2021_05_01.models._models_py3.ManagedClusterParameters
- 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
get_access_profile
Gets an access profile of a managed cluster.
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) -> azure.mgmt.containerservice.v2021_05_01.models._models_py3.ManagedClusterAccessProfileParameters
- 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
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.
async get_command_result(resource_group_name: str, resource_name: str, command_id: str, **kwargs: Any) -> Optional[azure.mgmt.containerservice.v2021_05_01.models._models_py3.RunCommandResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
RunCommandResult, or the result of cls(response)
Return type
Exceptions
get_os_options
Gets supported OS options in the specified subscription.
Gets supported OS options in the specified subscription.
async get_os_options(location: str, resource_type: Optional[str] = None, **kwargs: Any) -> azure.mgmt.containerservice.v2021_05_01.models._models_py3.OSOptionProfileParameters
- resource_type
- str
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
Exceptions
get_upgrade_profile
Gets the upgrade profile of a managed cluster.
Gets the upgrade profile of a managed cluster.
async get_upgrade_profile(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2021_05_01.models._models_py3.ManagedClusterUpgradeProfileParameters
- 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
list
Gets a list of managed clusters in the specified subscription.
Gets a list of managed clusters in the specified subscription.
list(**kwargs: Any) -> AsyncIterable[azure.mgmt.containerservice.v2021_05_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
Exceptions
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_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.containerservice.v2021_05_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
Exceptions
list_cluster_admin_credentials
Lists the admin credentials of a managed cluster.
Lists the admin credentials of a managed cluster.
async list_cluster_admin_credentials(resource_group_name: str, resource_name: str, server_fqdn: Optional[str] = None, **kwargs: Any) -> azure.mgmt.containerservice.v2021_05_01.models._models_py3.CredentialResultsParameters
- 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
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.
async list_cluster_monitoring_user_credentials(resource_group_name: str, resource_name: str, server_fqdn: Optional[str] = None, **kwargs: Any) -> azure.mgmt.containerservice.v2021_05_01.models._models_py3.CredentialResultsParameters
- 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
list_cluster_user_credentials
Lists the user credentials of a managed cluster.
Lists the user credentials of a managed cluster.
async list_cluster_user_credentials(resource_group_name: str, resource_name: str, server_fqdn: Optional[str] = None, **kwargs: Any) -> azure.mgmt.containerservice.v2021_05_01.models._models_py3.CredentialResultsParameters
- 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
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) -> AsyncIterable[azure.mgmt.containerservice.v2021_05_01.models._models_py3.OutboundEnvironmentEndpointCollection]Parameters
- 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
Exceptions
Attributes
models
models = <module 'azure.mgmt.containerservice.v2021_05_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\containerservice\\v2021_05_01\\models\\__init__.py'>Feedback
Submit and view feedback for