azure.mgmt.containerservice.v2023_06_02_preview.operations module — Azure SDK for Python 2.0.0 documentation

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations throughContainerServiceClient’sagent_pools attribute.

begin_abort_latest_operation(resource_group_name:str, resource_name:str, agent_pool_name:str, **kwargs:Any) → LROPoller[None][source]¶

Aborts last operation running on agent pool.

Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, an error is returned.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• agent_pool_name (str) – The name of the agent pool. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_create_or_update(resource_group_name:str, resource_name:str, agent_pool_name:str, parameters:_models.AgentPool, *, content_type:str='application/json', **kwargs:Any) → LROPoller[_models.AgentPool][source]¶

begin_create_or_update(resource_group_name:str, resource_name:str, agent_pool_name:str, parameters:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → LROPoller[_models.AgentPool]

Creates or updates an agent pool in the specified managed cluster.

Creates or updates an agent pool in the specified managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• agent_pool_name (str) – The name of the agent pool. Required.

• parameters (AgentPool orIO[bytes]) – The agent pool to create or update. Is either a AgentPool type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either AgentPool or the result of cls(response)

Return type:

LROPoller[AgentPool]

Raises:

HttpResponseError –

begin_delete(resource_group_name:str, resource_name:str, agent_pool_name:str, ignore_pod_disruption_budget:bool|None=None, **kwargs:Any) → LROPoller[None][source]¶

Deletes an agent pool in the specified managed cluster.

Deletes an agent pool in the specified managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• agent_pool_name (str) – The name of the agent pool. Required.

• ignore_pod_disruption_budget (bool) – ignore-pod-disruption-budget=true to delete those pods on a node without considering Pod Disruption Budget. Default value is None.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_upgrade_node_image_version(resource_group_name:str, resource_name:str, agent_pool_name:str, **kwargs:Any) → LROPoller[AgentPool][source]¶

Upgrades the node image version of an agent pool to the latest.

Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: .

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• agent_pool_name (str) – The name of the agent pool. Required.

Returns:

An instance of LROPoller that returns either AgentPool or the result of cls(response)

Return type:

LROPoller[AgentPool]

Raises:

HttpResponseError –

get(resource_group_name:str, resource_name:str, agent_pool_name:str, **kwargs:Any) → AgentPool[source]¶

Gets the specified managed cluster agent pool.

Gets the specified managed cluster agent pool.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• agent_pool_name (str) – The name of the agent pool. Required.

Returns:

AgentPool or the result of cls(response)

Return type:

AgentPool

Raises:

HttpResponseError –

get_available_agent_pool_versions(resource_group_name:str, resource_name:str, **kwargs:Any) → AgentPoolAvailableVersions[source]¶

Gets a list of supported Kubernetes versions for the specified agent pool.

See supported Kubernetes versions for more details about the version lifecycle.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

AgentPoolAvailableVersions or the result of cls(response)

Return type:

AgentPoolAvailableVersions

Raises:

HttpResponseError –

get_upgrade_profile(resource_group_name:str, resource_name:str, agent_pool_name:str, **kwargs:Any) → AgentPoolUpgradeProfile[source]¶

Gets the upgrade profile for an agent pool.

Gets the upgrade profile for an agent pool.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• agent_pool_name (str) – The name of the agent pool. Required.

Returns:

AgentPoolUpgradeProfile or the result of cls(response)

Return type:

AgentPoolUpgradeProfile

Raises:

HttpResponseError –

list(resource_group_name:str, resource_name:str, **kwargs:Any) → Iterable[AgentPool][source]¶

Gets a list of agent pools in the specified managed cluster.

Gets a list of agent pools in the specified managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

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

Return type:

ItemPaged[AgentPool]

Raises:

HttpResponseError –

models=<module 'azure.mgmt.containerservice.v2023_06_02_preview.models' from '/mnt/vss/_work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/containerservice/v2023_06_02_preview/models/__init__.py'>¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations throughContainerServiceClient’smaintenance_configurations attribute.

create_or_update(resource_group_name:str, resource_name:str, config_name:str, parameters:_models.MaintenanceConfiguration, *, content_type:str='application/json', **kwargs:Any) → _models.MaintenanceConfiguration[source]¶

create_or_update(resource_group_name:str, resource_name:str, config_name:str, parameters:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → _models.MaintenanceConfiguration

Creates or updates a maintenance configuration in the specified managed cluster.

Creates or updates a maintenance configuration in the specified managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• config_name (str) – The name of the maintenance configuration. Required.

• parameters (MaintenanceConfiguration or IO[bytes]) – The maintenance configuration to create or update. Is either a MaintenanceConfiguration type or a IO[bytes] type. Required.

Returns:

MaintenanceConfiguration or the result of cls(response)

Return type:

MaintenanceConfiguration

Raises:

HttpResponseError –

delete(resource_group_name:str, resource_name:str, config_name:str, **kwargs:Any) → None[source]¶

Deletes a maintenance configuration.

Deletes a maintenance configuration.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• config_name (str) – The name of the maintenance configuration. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name:str, resource_name:str, config_name:str, **kwargs:Any) → MaintenanceConfiguration[source]¶

Gets the specified maintenance configuration of a managed cluster.

Gets the specified maintenance configuration of a managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• config_name (str) – The name of the maintenance configuration. Required.

Returns:

MaintenanceConfiguration or the result of cls(response)

Return type:

MaintenanceConfiguration

Raises:

HttpResponseError –

list_by_managed_cluster(resource_group_name:str, resource_name:str, **kwargs:Any) → Iterable[MaintenanceConfiguration][source]¶

Gets a list of maintenance configurations in the specified managed cluster.

Gets a list of maintenance configurations in the specified managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

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

Return type:

ItemPaged[MaintenanceConfiguration]

Raises:

HttpResponseError –

models=<module 'azure.mgmt.containerservice.v2023_06_02_preview.models' from '/mnt/vss/_work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/containerservice/v2023_06_02_preview/models/__init__.py'>¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations throughContainerServiceClient’smanaged_cluster_snapshots attribute.

create_or_update(resource_group_name:str, resource_name:str, parameters:_models.ManagedClusterSnapshot, *, content_type:str='application/json', **kwargs:Any) → _models.ManagedClusterSnapshot[source]¶

create_or_update(resource_group_name:str, resource_name:str, parameters:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → _models.ManagedClusterSnapshot

Creates or updates a managed cluster snapshot.

Creates or updates a managed cluster snapshot.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• parameters (ManagedClusterSnapshot or IO[bytes]) – The managed cluster snapshot to create or update. Is either a ManagedClusterSnapshot type or a IO[bytes] type. Required.

Returns:

ManagedClusterSnapshot or the result of cls(response)

Return type:

ManagedClusterSnapshot

Raises:

HttpResponseError –

delete(resource_group_name:str, resource_name:str, **kwargs:Any) → None[source]¶

Deletes a managed cluster snapshot.

Deletes a managed cluster snapshot.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name:str, resource_name:str, **kwargs:Any) → ManagedClusterSnapshot[source]¶

Gets a managed cluster snapshot.

Gets a managed cluster snapshot.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

ManagedClusterSnapshot or the result of cls(response)

Return type:

ManagedClusterSnapshot

Raises:

HttpResponseError –

list(**kwargs:Any) → Iterable[ManagedClusterSnapshot][source]¶

Gets a list of managed cluster snapshots in the specified subscription.

Gets a list of managed cluster snapshots in the specified subscription.

Returns:

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

Return type:

ItemPaged[ManagedClusterSnapshot]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name:str, **kwargs:Any) → Iterable[ManagedClusterSnapshot][source]¶

Lists managed cluster snapshots in the specified subscription and resource group.

Lists managed cluster snapshots in the specified subscription and resource group.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

Returns:

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

Return type:

ItemPaged[ManagedClusterSnapshot]

Raises:

HttpResponseError –

update_tags(resource_group_name:str, resource_name:str, parameters:_models.TagsObject, *, content_type:str='application/json', **kwargs:Any) → _models.ManagedClusterSnapshot[source]¶

update_tags(resource_group_name:str, resource_name:str, parameters:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → _models.ManagedClusterSnapshot

Updates tags on a managed cluster snapshot.

Updates tags on a managed cluster snapshot.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• parameters (TagsObject orIO[bytes]) – Parameters supplied to the Update managed cluster snapshot Tags operation. Is either a TagsObject type or a IO[bytes] type. Required.

Returns:

ManagedClusterSnapshot or the result of cls(response)

Return type:

ManagedClusterSnapshot

Raises:

HttpResponseError –

models=<module 'azure.mgmt.containerservice.v2023_06_02_preview.models' from '/mnt/vss/_work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/containerservice/v2023_06_02_preview/models/__init__.py'>¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations throughContainerServiceClient’smanaged_clusters attribute.

begin_abort_latest_operation(resource_group_name:str, resource_name:str, **kwargs:Any) → LROPoller[None][source]¶

Aborts last operation running on managed cluster.

Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, an error is returned.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_create_or_update(resource_group_name:str, resource_name:str, parameters:_models.ManagedCluster, *, content_type:str='application/json', **kwargs:Any) → LROPoller[_models.ManagedCluster][source]¶

begin_create_or_update(resource_group_name:str, resource_name:str, parameters:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → LROPoller[_models.ManagedCluster]

Creates or updates a managed cluster.

Creates or updates a managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• parameters (ManagedCluster orIO[bytes]) – The managed cluster to create or update. Is either a ManagedCluster type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ManagedCluster or the result of cls(response)

Return type:

LROPoller[ManagedCluster]

Raises:

HttpResponseError –

begin_delete(resource_group_name:str, resource_name:str, ignore_pod_disruption_budget:bool|None=None, **kwargs:Any) → LROPoller[None][source]¶

Deletes a managed cluster.

Deletes a managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• ignore_pod_disruption_budget (bool) – ignore-pod-disruption-budget=true to delete those pods on a node without considering Pod Disruption Budget. Default value is None.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_reset_aad_profile(resource_group_name:str, resource_name:str, parameters:_models.ManagedClusterAADProfile, *, content_type:str='application/json', **kwargs:Any) → LROPoller[None][source]¶

begin_reset_aad_profile(resource_group_name:str, resource_name:str, parameters:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → LROPoller[None]

Reset the AAD Profile of a managed cluster.

WARNING: This API will be deprecated. Please see AKS-managed Azure Active Directory integration to update your cluster with AKS-managed Azure AD.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• parameters (ManagedClusterAADProfile or IO[bytes]) – The AAD profile to set on the Managed Cluster. Is either a ManagedClusterAADProfile type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_reset_service_principal_profile(resource_group_name:str, resource_name:str, parameters:_models.ManagedClusterServicePrincipalProfile, *, content_type:str='application/json', **kwargs:Any) → LROPoller[None][source]¶

begin_reset_service_principal_profile(resource_group_name:str, resource_name:str, parameters:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → LROPoller[None]

Reset the Service Principal Profile of a managed cluster.

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

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• parameters (ManagedClusterServicePrincipalProfileor IO[bytes]) – The service principal profile to set on the managed cluster. Is either a ManagedClusterServicePrincipalProfile type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_rotate_cluster_certificates(resource_group_name:str, resource_name:str, **kwargs:Any) → LROPoller[None][source]¶

Rotates the certificates of a managed cluster.

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

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_rotate_service_account_signing_keys(resource_group_name:str, resource_name:str, **kwargs:Any) → LROPoller[None][source]¶

Rotates the service account signing keys of a managed cluster.

Rotates the service account signing keys of a managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_run_command(resource_group_name:str, resource_name:str, request_payload:_models.RunCommandRequest, *, content_type:str='application/json', **kwargs:Any) → LROPoller[_models.RunCommandResult][source]¶

begin_run_command(resource_group_name:str, resource_name:str, request_payload:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → LROPoller[_models.RunCommandResult]

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.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• request_payload (RunCommandRequest or IO[bytes]) – The run command request. Is either a RunCommandRequest type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either RunCommandResult or the result of cls(response)

Return type:

LROPoller[RunCommandResult]

Raises:

HttpResponseError –

begin_start(resource_group_name:str, resource_name:str, **kwargs:Any) → LROPoller[None][source]¶

Starts a previously stopped Managed Cluster.

See starting a cluster for more details about starting a cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_stop(resource_group_name:str, resource_name:str, **kwargs:Any) → LROPoller[None][source]¶

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.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_update_tags(resource_group_name:str, resource_name:str, parameters:_models.TagsObject, *, content_type:str='application/json', **kwargs:Any) → LROPoller[_models.ManagedCluster][source]¶

begin_update_tags(resource_group_name:str, resource_name:str, parameters:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → LROPoller[_models.ManagedCluster]

Updates tags on a managed cluster.

Updates tags on a managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• parameters (TagsObject orIO[bytes]) – Parameters supplied to the Update Managed Cluster Tags operation. Is either a TagsObject type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either ManagedCluster or the result of cls(response)

Return type:

LROPoller[ManagedCluster]

Raises:

HttpResponseError –

get(resource_group_name:str, resource_name:str, **kwargs:Any) → ManagedCluster[source]¶

Gets a managed cluster.

Gets a managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

ManagedCluster or the result of cls(response)

Return type:

ManagedCluster

Raises:

HttpResponseError –

get_access_profile(resource_group_name:str, resource_name:str, role_name:str, **kwargs:Any) → ManagedClusterAccessProfile[source]¶

Gets an access profile of a managed cluster.

WARNING: This API will be deprecated. Instead use ListClusterUserCredentials orListClusterAdminCredentials .

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• role_name (str) – The name of the role for managed cluster accessProfile resource. Required.

Returns:

ManagedClusterAccessProfile or the result of cls(response)

Return type:

ManagedClusterAccessProfile

Raises:

HttpResponseError –

get_command_result(resource_group_name:str, resource_name:str, command_id:str, **kwargs:Any) → RunCommandResult|None[source]¶

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.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• command_id (str) – Id of the command. Required.

Returns:

RunCommandResult or None or the result of cls(response)

Return type:

RunCommandResult or None

Raises:

HttpResponseError –

get_mesh_revision_profile(location:str, mode:str, **kwargs:Any) → MeshRevisionProfile[source]¶

Gets a mesh revision profile for a specified mesh in the specified location.

Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades.

Parameters:

• location (str) – The name of Azure region. Required.

• mode (str) – The mode of the mesh. Required.

Returns:

MeshRevisionProfile or the result of cls(response)

Return type:

MeshRevisionProfile

Raises:

HttpResponseError –

get_mesh_upgrade_profile(resource_group_name:str, resource_name:str, mode:str, **kwargs:Any) → MeshUpgradeProfile[source]¶

Gets available upgrades for a service mesh in a cluster.

Gets available upgrades for a service mesh in a cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• mode (str) – The mode of the mesh. Required.

Returns:

MeshUpgradeProfile or the result of cls(response)

Return type:

MeshUpgradeProfile

Raises:

HttpResponseError –

get_os_options(location:str, resource_type:str|None=None, **kwargs:Any) → OSOptionProfile[source]¶

Gets supported OS options in the specified subscription.

Gets supported OS options in the specified subscription.

Parameters:

• location (str) – The name of Azure region. Required.

• resource_type (str) – The resource type for which the OS options needs to be returned. Default value is None.

Returns:

OSOptionProfile or the result of cls(response)

Return type:

OSOptionProfile

Raises:

HttpResponseError –

get_upgrade_profile(resource_group_name:str, resource_name:str, **kwargs:Any) → ManagedClusterUpgradeProfile[source]¶

Gets the upgrade profile of a managed cluster.

Gets the upgrade profile of a managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

ManagedClusterUpgradeProfile or the result of cls(response)

Return type:

ManagedClusterUpgradeProfile

Raises:

HttpResponseError –

list(**kwargs:Any) → Iterable[ManagedCluster][source]¶

Gets a list of managed clusters in the specified subscription.

Gets a list of managed clusters in the specified subscription.

Returns:

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

Return type:

ItemPaged[ManagedCluster]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name:str, **kwargs:Any) → Iterable[ManagedCluster][source]¶

Lists managed clusters in the specified subscription and resource group.

Lists managed clusters in the specified subscription and resource group.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

Returns:

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

Return type:

ItemPaged[ManagedCluster]

Raises:

HttpResponseError –

list_cluster_admin_credentials(resource_group_name:str, resource_name:str, server_fqdn:str|None=None, **kwargs:Any) → CredentialResults[source]¶

Lists the admin credentials of a managed cluster.

Lists the admin credentials of a managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• server_fqdn (str) – server fqdn type for credentials to be returned. Default value is None.

Returns:

CredentialResults or the result of cls(response)

Return type:

CredentialResults

Raises:

HttpResponseError –

list_cluster_monitoring_user_credentials(resource_group_name:str, resource_name:str, server_fqdn:str|None=None, **kwargs:Any) → CredentialResults[source]¶

Lists the cluster monitoring user credentials of a managed cluster.

Lists the cluster monitoring user credentials of a managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• server_fqdn (str) – server fqdn type for credentials to be returned. Default value is None.

Returns:

CredentialResults or the result of cls(response)

Return type:

CredentialResults

Raises:

HttpResponseError –

list_cluster_user_credentials(resource_group_name:str, resource_name:str, server_fqdn:str|None=None, format:str|Format|None=None, **kwargs:Any) → CredentialResults[source]¶

Lists the user credentials of a managed cluster.

Lists the user credentials of a managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• server_fqdn (str) – server fqdn type for credentials to be returned. Default value is None.

• format (str or Format) – 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. Known values are: “azure” and “exec”. Default value is None.

Returns:

CredentialResults or the result of cls(response)

Return type:

CredentialResults

Raises:

HttpResponseError –

list_kubernetes_versions(location:str, **kwargs:Any) → KubernetesVersionListResult[source]¶

Gets a list of supported Kubernetes versions in the specified subscription.

Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version.

Parameters:

location (str) – The name of Azure region. Required.

Returns:

KubernetesVersionListResult or the result of cls(response)

Return type:

KubernetesVersionListResult

Raises:

HttpResponseError –

list_mesh_revision_profiles(location:str, **kwargs:Any) → Iterable[MeshRevisionProfile][source]¶

Lists mesh revision profiles for all meshes in the specified location.

Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades.

Parameters:

location (str) – The name of Azure region. Required.

Returns:

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

Return type:

ItemPaged[MeshRevisionProfile]

Raises:

HttpResponseError –

list_mesh_upgrade_profiles(resource_group_name:str, resource_name:str, **kwargs:Any) → Iterable[MeshUpgradeProfile][source]¶

Lists available upgrades for all service meshes in a specific cluster.

Lists available upgrades for all service meshes in a specific cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

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

Return type:

ItemPaged[MeshUpgradeProfile]

Raises:

HttpResponseError –

list_outbound_network_dependencies_endpoints(resource_group_name:str, resource_name:str, **kwargs:Any) → Iterable[OutboundEnvironmentEndpoint][source]¶

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.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

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

Return type:

ItemPaged[OutboundEnvironmentEndpoint]

Raises:

HttpResponseError –

models=<module 'azure.mgmt.containerservice.v2023_06_02_preview.models' from '/mnt/vss/_work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/containerservice/v2023_06_02_preview/models/__init__.py'>¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations throughContainerServiceClient’soperations attribute.

list(**kwargs:Any) → Iterable[OperationValue][source]¶

Gets a list of operations.

Gets a list of operations.

Returns:

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

Return type:

ItemPaged[OperationValue]

Raises:

HttpResponseError –

models=<module 'azure.mgmt.containerservice.v2023_06_02_preview.models' from '/mnt/vss/_work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/containerservice/v2023_06_02_preview/models/__init__.py'>¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations throughContainerServiceClient’sprivate_endpoint_connections attribute.

begin_delete(resource_group_name:str, resource_name:str, private_endpoint_connection_name:str, **kwargs:Any) → LROPoller[None][source]¶

Deletes a private endpoint connection.

Deletes a private endpoint connection.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

get(resource_group_name:str, resource_name:str, private_endpoint_connection_name:str, **kwargs:Any) → PrivateEndpointConnection[source]¶

Gets the specified private endpoint connection.

To learn more about private clusters, see: .

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

list(resource_group_name:str, resource_name:str, **kwargs:Any) → PrivateEndpointConnectionListResult[source]¶

Gets a list of private endpoint connections in the specified managed cluster.

To learn more about private clusters, see: .

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

PrivateEndpointConnectionListResult or the result of cls(response)

Return type:

PrivateEndpointConnectionListResult

Raises:

HttpResponseError –

update(resource_group_name:str, resource_name:str, private_endpoint_connection_name:str, parameters:_models.PrivateEndpointConnection, *, content_type:str='application/json', **kwargs:Any) → _models.PrivateEndpointConnection[source]¶

update(resource_group_name:str, resource_name:str, private_endpoint_connection_name:str, parameters:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → _models.PrivateEndpointConnection

Updates a private endpoint connection.

Updates a private endpoint connection.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

• parameters (PrivateEndpointConnection or IO[bytes]) – The updated private endpoint connection. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

models=<module 'azure.mgmt.containerservice.v2023_06_02_preview.models' from '/mnt/vss/_work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/containerservice/v2023_06_02_preview/models/__init__.py'>¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations throughContainerServiceClient’sprivate_link_resources attribute.

list(resource_group_name:str, resource_name:str, **kwargs:Any) → PrivateLinkResourcesListResult[source]¶

Gets a list of private link resources in the specified managed cluster.

To learn more about private clusters, see: .

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

PrivateLinkResourcesListResult or the result of cls(response)

Return type:

PrivateLinkResourcesListResult

Raises:

HttpResponseError –

models=<module 'azure.mgmt.containerservice.v2023_06_02_preview.models' from '/mnt/vss/_work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/containerservice/v2023_06_02_preview/models/__init__.py'>¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations throughContainerServiceClient’sresolve_private_link_service_id attribute.

post(resource_group_name:str, resource_name:str, parameters:_models.PrivateLinkResource, *, content_type:str='application/json', **kwargs:Any) → _models.PrivateLinkResource[source]¶

post(resource_group_name:str, resource_name:str, parameters:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → _models.PrivateLinkResource

Gets the private link service ID for the specified managed cluster.

Gets the private link service ID for the specified managed cluster.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• parameters (PrivateLinkResourceor IO[bytes]) – Parameters required in order to resolve a private link service ID. Is either a PrivateLinkResource type or a IO[bytes] type. Required.

Returns:

PrivateLinkResource or the result of cls(response)

Return type:

PrivateLinkResource

Raises:

HttpResponseError –

models=<module 'azure.mgmt.containerservice.v2023_06_02_preview.models' from '/mnt/vss/_work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/containerservice/v2023_06_02_preview/models/__init__.py'>¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations throughContainerServiceClient’ssnapshots attribute.

create_or_update(resource_group_name:str, resource_name:str, parameters:_models.Snapshot, *, content_type:str='application/json', **kwargs:Any) → _models.Snapshot[source]¶

create_or_update(resource_group_name:str, resource_name:str, parameters:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → _models.Snapshot

Creates or updates a snapshot.

Creates or updates a snapshot.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• parameters (Snapshot or IO[bytes]) – The snapshot to create or update. Is either a Snapshot type or a IO[bytes] type. Required.

Returns:

Snapshot or the result of cls(response)

Return type:

Snapshot

Raises:

HttpResponseError –

delete(resource_group_name:str, resource_name:str, **kwargs:Any) → None[source]¶

Deletes a snapshot.

Deletes a snapshot.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name:str, resource_name:str, **kwargs:Any) → Snapshot[source]¶

Gets a snapshot.

Gets a snapshot.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

Snapshot or the result of cls(response)

Return type:

Snapshot

Raises:

HttpResponseError –

list(**kwargs:Any) → Iterable[Snapshot][source]¶

Gets a list of snapshots in the specified subscription.

Gets a list of snapshots in the specified subscription.

Returns:

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

Return type:

ItemPaged[Snapshot]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name:str, **kwargs:Any) → Iterable[Snapshot][source]¶

Lists snapshots in the specified subscription and resource group.

Lists snapshots in the specified subscription and resource group.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

Returns:

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

Return type:

ItemPaged[Snapshot]

Raises:

HttpResponseError –

update_tags(resource_group_name:str, resource_name:str, parameters:_models.TagsObject, *, content_type:str='application/json', **kwargs:Any) → _models.Snapshot[source]¶

update_tags(resource_group_name:str, resource_name:str, parameters:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → _models.Snapshot

Updates tags on a snapshot.

Updates tags on a snapshot.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• parameters (TagsObject orIO[bytes]) – Parameters supplied to the Update snapshot Tags operation. Is either a TagsObject type or a IO[bytes] type. Required.

Returns:

Snapshot or the result of cls(response)

Return type:

Snapshot

Raises:

HttpResponseError –

models=<module 'azure.mgmt.containerservice.v2023_06_02_preview.models' from '/mnt/vss/_work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/containerservice/v2023_06_02_preview/models/__init__.py'>¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations throughContainerServiceClient’strusted_access_role_bindings attribute.

create_or_update(resource_group_name:str, resource_name:str, trusted_access_role_binding_name:str, trusted_access_role_binding:_models.TrustedAccessRoleBinding, *, content_type:str='application/json', **kwargs:Any) → _models.TrustedAccessRoleBinding[source]¶

create_or_update(resource_group_name:str, resource_name:str, trusted_access_role_binding_name:str, trusted_access_role_binding:IO[bytes], *, content_type:str='application/json', **kwargs:Any) → _models.TrustedAccessRoleBinding

Create or update a trusted access role binding.

Create or update a trusted access role binding.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• trusted_access_role_binding_name (str) – The name of trusted access role binding. Required.

• trusted_access_role_binding (TrustedAccessRoleBinding or IO[bytes]) – A trusted access role binding. Is either a TrustedAccessRoleBinding type or a IO[bytes] type. Required.

Returns:

TrustedAccessRoleBinding or the result of cls(response)

Return type:

TrustedAccessRoleBinding

Raises:

HttpResponseError –

delete(resource_group_name:str, resource_name:str, trusted_access_role_binding_name:str, **kwargs:Any) → None[source]¶

Delete a trusted access role binding.

Delete a trusted access role binding.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• trusted_access_role_binding_name (str) – The name of trusted access role binding. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name:str, resource_name:str, trusted_access_role_binding_name:str, **kwargs:Any) → TrustedAccessRoleBinding[source]¶

Get a trusted access role binding.

Get a trusted access role binding.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

• trusted_access_role_binding_name (str) – The name of trusted access role binding. Required.

Returns:

TrustedAccessRoleBinding or the result of cls(response)

Return type:

TrustedAccessRoleBinding

Raises:

HttpResponseError –

list(resource_group_name:str, resource_name:str, **kwargs:Any) → Iterable[TrustedAccessRoleBinding][source]¶

List trusted access role bindings.

List trusted access role bindings.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

• resource_name (str) – The name of the managed cluster resource. Required.

Returns:

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

Return type:

ItemPaged[TrustedAccessRoleBinding]

Raises:

HttpResponseError –

models=<module 'azure.mgmt.containerservice.v2023_06_02_preview.models' from '/mnt/vss/_work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/containerservice/v2023_06_02_preview/models/__init__.py'>¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations throughContainerServiceClient’strusted_access_roles attribute.

list(location:str, **kwargs:Any) → Iterable[TrustedAccessRole][source]¶

List supported trusted access roles.

List supported trusted access roles.

Parameters:

location (str) – The name of Azure region. Required.

Returns:

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

Return type:

ItemPaged[TrustedAccessRole]

Raises:

HttpResponseError –

models=<module 'azure.mgmt.containerservice.v2023_06_02_preview.models' from '/mnt/vss/_work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/containerservice/v2023_06_02_preview/models/__init__.py'>¶