azure.mgmt.containerservice.operations module¶
-
class
azure.mgmt.containerservice.operations.
ContainerServicesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ContainerServicesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
create_or_update
(resource_group_name, container_service_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a container service.
Creates or updates a container service with the specified configuration of orchestrator, masters, and agents.
- Parameters
resource_group_name (str) – The name of the resource group.
container_service_name (str) – The name of the container service in the specified subscription and resource group.
parameters (ContainerService) – Parameters supplied to the Create or Update a Container Service operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ContainerService or ClientRawResponse<ContainerService> if raw==True
- Return type
AzureOperationPoller[ContainerService] or AzureOperationPoller[ClientRawResponse[ContainerService]]
- Raises
CloudError
-
delete
(resource_group_name, container_service_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes the specified container service.
Deletes the specified container service in the specified subscription and resource group. The operation does not delete other resources created as part of creating a container service, including storage accounts, VMs, and availability sets. All the other resources created with the container service are part of the same resource group and can be deleted individually.
- Parameters
resource_group_name (str) – The name of the resource group.
container_service_name (str) – The name of the container service in the specified subscription and resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, container_service_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the properties of the specified container service.
Gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of masters and agents. .
- Parameters
resource_group_name (str) – The name of the resource group.
container_service_name (str) – The name of the container service in the specified subscription and resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ContainerService or ClientRawResponse if raw=true
- Return type
ContainerService or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of container services in the specified subscription.
Gets a list of container services in the specified subscription. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.
- Parameters
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ContainerService
- Return type
- Raises
CloudError
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of container services in the specified resource group.
Gets a list of container services in the specified subscription and resource group. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.
- Parameters
resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ContainerService
- Return type
- Raises
CloudError
-
list_orchestrators
(location, resource_type=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of supported orchestrators in the specified subscription.
Gets a list of supported orchestrators in the specified subscription. The operation returns properties of each orchestrator including verison and available upgrades.
- Parameters
location (str) – The name of a supported Azure region.
resource_type (str) – resource type for which the list of orchestrators needs to be returned
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
OrchestratorVersionProfileListResult or ClientRawResponse if raw=true
- Return type
OrchestratorVersionProfileListResult or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.containerservice.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/containerservice/models/__init__.py'>¶
-
class
azure.mgmt.containerservice.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Client Api Version. Constant value: “2018-03-31”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of compute operations.
- Parameters
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of OperationValue
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.containerservice.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/containerservice/models/__init__.py'>¶
-
class
azure.mgmt.containerservice.operations.
ManagedClustersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ManagedClustersOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Client Api Version. Constant value: “2018-03-31”.
-
create_or_update
(resource_group_name, resource_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a managed cluster.
Creates or updates a managed cluster with the specified configuration for agents and Kubernetes version.
- Parameters
resource_group_name (str) – The name of the resource group.
resource_name (str) – The name of the managed cluster resource.
parameters (ManagedCluster) – Parameters supplied to the Create or Update a Managed Cluster operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ManagedCluster or ClientRawResponse<ManagedCluster> if raw==True
- Return type
AzureOperationPoller[ManagedCluster] or AzureOperationPoller[ClientRawResponse[ManagedCluster]]
- Raises
CloudError
-
delete
(resource_group_name, resource_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a managed cluster.
Deletes the managed cluster with a specified resource group and name.
- Parameters
resource_group_name (str) – The name of the resource group.
resource_name (str) – The name of the managed cluster resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a managed cluster.
Gets the details of the managed cluster with a specified resource group and name.
- Parameters
resource_group_name (str) – The name of the resource group.
resource_name (str) – The name of the managed cluster resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ManagedCluster or ClientRawResponse if raw=true
- Return type
ManagedCluster or ClientRawResponse
- Raises
CloudError
-
get_access_profile
(resource_group_name, resource_name, role_name, custom_headers=None, raw=False, **operation_config)[source]¶ 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.
- Parameters
resource_group_name (str) – The name of the resource group.
resource_name (str) – The name of the managed cluster resource.
role_name (str) – The name of the role for managed cluster accessProfile resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ManagedClusterAccessProfile or ClientRawResponse if raw=true
- Return type
ManagedClusterAccessProfile or ClientRawResponse
- Raises
CloudError
-
get_upgrade_profile
(resource_group_name, resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ 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.
- Parameters
resource_group_name (str) – The name of the resource group.
resource_name (str) – The name of the managed cluster resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ManagedClusterUpgradeProfile or ClientRawResponse if raw=true
- Return type
ManagedClusterUpgradeProfile or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ 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.
- Parameters
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ManagedCluster
- Return type
- Raises
CloudError
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ 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.
- Parameters
resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ManagedCluster
- Return type
- Raises
CloudError
-
list_cluster_admin_credentials
(resource_group_name, resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets clusteradmin credential of a managed cluster.
Gets clusteradmin credential of the managed cluster with a specified resource group and name.
- Parameters
resource_group_name (str) – The name of the resource group.
resource_name (str) – The name of the managed cluster resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
CredentialResults or ClientRawResponse if raw=true
- Return type
CredentialResults or ClientRawResponse
- Raises
CloudError
-
list_cluster_user_credentials
(resource_group_name, resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets clusteruser credential of a managed cluster.
Gets clusteruser credential of the managed cluster with a specified resource group and name.
- Parameters
resource_group_name (str) – The name of the resource group.
resource_name (str) – The name of the managed cluster resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
CredentialResults or ClientRawResponse if raw=true
- Return type
CredentialResults or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.containerservice.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/containerservice/models/__init__.py'>¶
Updates tags on a managed cluster.
Updates a managed cluster with the specified tags.
- Parameters
resource_group_name (str) – The name of the resource group.
resource_name (str) – The name of the managed cluster resource.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ManagedCluster or ClientRawResponse<ManagedCluster> if raw==True
- Return type
AzureOperationPoller[ManagedCluster] or AzureOperationPoller[ClientRawResponse[ManagedCluster]]
- Raises
CloudError