azure.mgmt.containerservice.v2019_02_01.operations module¶
-
class
azure.mgmt.containerservice.v2019_02_01.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- 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: “2019-02-01”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of compute operations.
- Parameters
- Returns
An iterator like instance of OperationValue
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.containerservice.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/containerservice/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.containerservice.v2019_02_01.operations.
ManagedClustersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ManagedClustersOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- 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: “2019-02-01”.
-
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
- 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
- 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 cluster admin credential of a managed cluster.
Gets cluster admin 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 cluster user credential of a managed cluster.
Gets cluster user 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
-
reset_aad_profile
(resource_group_name, resource_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Reset AAD Profile of a managed cluster.
Update the AAD Profile for a managed cluster.
- Parameters
resource_group_name (str) – The name of the resource group.
resource_name (str) – The name of the managed cluster resource.
parameters (ManagedClusterAADProfile) – Parameters supplied to the Reset AAD Profile operation for a Managed Cluster.
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
-
reset_service_principal_profile
(resource_group_name, resource_name, client_id, secret=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Reset Service Principal Profile of a managed cluster.
Update the service principal Profile for a managed cluster.
- Parameters
resource_group_name (str) – The name of the resource group.
resource_name (str) – The name of the managed cluster resource.
client_id (str) – The ID for the service principal.
secret (str) – The secret password associated with the service principal in plain text.
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
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.
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
-
models
= <module 'azure.mgmt.containerservice.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/containerservice/v2019_02_01/models/__init__.py'>¶
-
class
azure.mgmt.containerservice.v2019_02_01.operations.
AgentPoolsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AgentPoolsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- 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: “2019-02-01”.
-
create_or_update
(resource_group_name, managed_cluster_name, agent_pool_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates an agent pool.
Creates or updates an agent pool in the specified managed cluster.
- Parameters
resource_group_name (str) – The name of the resource group.
managed_cluster_name (str) – The name of the managed cluster resource.
agent_pool_name (str) – The name of the agent pool.
parameters (AgentPool) – Parameters supplied to the Create or Update an agent pool 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 AgentPool or ClientRawResponse<AgentPool> if raw==True
- Return type
AzureOperationPoller[AgentPool] or AzureOperationPoller[ClientRawResponse[AgentPool]]
- Raises
CloudError
-
delete
(resource_group_name, managed_cluster_name, agent_pool_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes an agent pool.
Deletes the agent pool in the specified managed cluster.
- Parameters
resource_group_name (str) – The name of the resource group.
managed_cluster_name (str) – The name of the managed cluster resource.
agent_pool_name (str) – The name of the agent pool.
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, managed_cluster_name, agent_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the agent pool.
Gets the details of the agent pool by managed cluster and resource group.
- Parameters
resource_group_name (str) – The name of the resource group.
managed_cluster_name (str) – The name of the managed cluster resource.
agent_pool_name (str) – The name of the agent pool.
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
AgentPool or ClientRawResponse if raw=true
- Return type
AgentPool or ClientRawResponse
- Raises
CloudError
-
list
(resource_group_name, managed_cluster_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of agent pools in the specified managed cluster.
Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.
- Parameters
resource_group_name (str) – The name of the resource group.
managed_cluster_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
An iterator like instance of AgentPool
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.containerservice.v2019_02_01.models' from '/home/vsts/work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/containerservice/v2019_02_01/models/__init__.py'>¶