azure.mgmt.containerservice.v2017_07_01.operations module

class azure.mgmt.containerservice.v2017_07_01.operations.ContainerServicesOperations(client, config, serializer, deserializer)[source]

Bases: object

ContainerServicesOperations 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.

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_configOperation 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_configOperation configuration overrides.

Returns

An iterator like instance of ContainerService

Return type

ContainerServicePaged[ContainerService]

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_configOperation configuration overrides.

Returns

An iterator like instance of ContainerService

Return type

ContainerServicePaged[ContainerService]

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 version, available upgrades and whether that version or upgrades are in preview.

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_configOperation configuration overrides.

Returns

OrchestratorVersionProfileListResult or ClientRawResponse if raw=true

Return type

OrchestratorVersionProfileListResult or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.containerservice.v2017_07_01.models' from '/home/vsts/work/1/s/sdk/containerservice/azure-mgmt-containerservice/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/containerservice/v2017_07_01/models/__init__.py'>