azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations
name: ManagedClustersOperations
fullName: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations
module: azure.mgmt.containerservice.v2020_02_01.aio.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.containerservice.v2020_02_01.aio.ContainerServiceClient>'s\n\
  >\n> <xref:managed_clusters> attribute.\n>"
constructor:
  syntax: ManagedClustersOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.begin_create_or_update
  name: begin_create_or_update
  summary: 'Creates or updates a managed cluster.


    Creates or updates a managed cluster with the specified configuration for agents
    and Kubernetes

    version.'
  signature: '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: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the managed cluster resource. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the Create or Update a Managed Cluster operation.
      Is

      either a ManagedCluster type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.containerservice.v2020_02_01.models.ManagedCluster>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of AsyncLROPoller that returns either ManagedCluster
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:azure.mgmt.containerservice.v2020_02_01.models.ManagedCluster>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.begin_delete
  name: begin_delete
  summary: 'Deletes a managed cluster.


    Deletes the managed cluster with a specified resource group and name.'
  signature: 'async begin_delete(resource_group_name: str, resource_name: str, **kwargs:
    Any) -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the managed cluster resource. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.begin_reset_aad_profile
  name: begin_reset_aad_profile
  summary: 'Reset AAD Profile of a managed cluster.


    Update the AAD Profile for a managed cluster.'
  signature: '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: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the managed cluster resource. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the Reset AAD Profile operation for a Managed

      Cluster. Is either a ManagedClusterAADProfile type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.containerservice.v2020_02_01.models.ManagedClusterAADProfile>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.begin_reset_service_principal_profile
  name: begin_reset_service_principal_profile
  summary: 'Reset Service Principal Profile of a managed cluster.


    Update the service principal Profile for a managed cluster.'
  signature: '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: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the managed cluster resource. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the Reset Service Principal Profile operation
      for a

      Managed Cluster. Is either a ManagedClusterServicePrincipalProfile type or a
      IO[bytes] type.

      Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.containerservice.v2020_02_01.models.ManagedClusterServicePrincipalProfile>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.begin_rotate_cluster_certificates
  name: begin_rotate_cluster_certificates
  summary: 'Rotate certificates of a managed cluster.


    Rotate certificates of a managed cluster.'
  signature: 'async begin_rotate_cluster_certificates(resource_group_name: str, resource_name:
    str, **kwargs: Any) -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the managed cluster resource. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.begin_update_tags
  name: begin_update_tags
  summary: 'Updates tags on a managed cluster.


    Updates a managed cluster with the specified tags.'
  signature: '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: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the managed cluster resource. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the Update Managed Cluster Tags operation.
      Is either

      a TagsObject type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.containerservice.v2020_02_01.models.TagsObject>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of AsyncLROPoller that returns either ManagedCluster
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:azure.mgmt.containerservice.v2020_02_01.models.ManagedCluster>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.get
  name: get
  summary: 'Gets a managed cluster.


    Gets the details of the managed cluster with a specified resource group and name.'
  signature: 'async get(resource_group_name: str, resource_name: str, **kwargs: Any)
    -> ManagedCluster'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the managed cluster resource. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: ManagedCluster or the result of cls(response)
    types:
    - <xref:azure.mgmt.containerservice.v2020_02_01.models.ManagedCluster>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.get_access_profile
  name: get_access_profile
  summary: '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.'
  signature: 'async get_access_profile(resource_group_name: str, resource_name: str,
    role_name: str, **kwargs: Any) -> ManagedClusterAccessProfile'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the managed cluster resource. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: role_name
    description: The name of the role for managed cluster accessProfile resource.
      Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: ManagedClusterAccessProfile or the result of cls(response)
    types:
    - <xref:azure.mgmt.containerservice.v2020_02_01.models.ManagedClusterAccessProfile>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.get_upgrade_profile
  name: get_upgrade_profile
  summary: '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.'
  signature: 'async get_upgrade_profile(resource_group_name: str, resource_name: str,
    **kwargs: Any) -> ManagedClusterUpgradeProfile'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the managed cluster resource. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: ManagedClusterUpgradeProfile or the result of cls(response)
    types:
    - <xref:azure.mgmt.containerservice.v2020_02_01.models.ManagedClusterUpgradeProfile>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.list
  name: list
  summary: '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.'
  signature: 'list(**kwargs: Any) -> AsyncIterable[ManagedCluster]'
  return:
    description: An iterator like instance of either ManagedCluster or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.containerservice.v2020_02_01.models.ManagedCluster>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.list_by_resource_group
  name: list_by_resource_group
  summary: '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.'
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[ManagedCluster]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either ManagedCluster or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.containerservice.v2020_02_01.models.ManagedCluster>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.list_cluster_admin_credentials
  name: list_cluster_admin_credentials
  summary: 'Gets cluster admin credential of a managed cluster.


    Gets cluster admin credential of the managed cluster with a specified resource
    group and name.'
  signature: 'async list_cluster_admin_credentials(resource_group_name: str, resource_name:
    str, **kwargs: Any) -> CredentialResults'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the managed cluster resource. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: CredentialResults or the result of cls(response)
    types:
    - <xref:azure.mgmt.containerservice.v2020_02_01.models.CredentialResults>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.list_cluster_monitoring_user_credentials
  name: list_cluster_monitoring_user_credentials
  summary: '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.'
  signature: 'async list_cluster_monitoring_user_credentials(resource_group_name:
    str, resource_name: str, **kwargs: Any) -> CredentialResults'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the managed cluster resource. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: CredentialResults or the result of cls(response)
    types:
    - <xref:azure.mgmt.containerservice.v2020_02_01.models.CredentialResults>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.list_cluster_user_credentials
  name: list_cluster_user_credentials
  summary: 'Gets cluster user credential of a managed cluster.


    Gets cluster user credential of the managed cluster with a specified resource
    group and name.'
  signature: 'async list_cluster_user_credentials(resource_group_name: str, resource_name:
    str, **kwargs: Any) -> CredentialResults'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the managed cluster resource. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: CredentialResults or the result of cls(response)
    types:
    - <xref:azure.mgmt.containerservice.v2020_02_01.models.CredentialResults>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.containerservice.v2020_02_01.aio.operations.ManagedClustersOperations.models
  name: models
  signature: models = <module 'azure.mgmt.containerservice.v2020_02_01.models' from
    'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\containerservice\\v2020_02_01\\models\\__init__.py'>