ContainerServicesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerServiceClient's

<xref:container_services> attribute.

Inheritance

builtins.object

ContainerServicesOperations

Constructor

ContainerServicesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a container service. Creates or updates a container service with the specified configuration of orchestrator, masters, and agents.
begin_delete	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.
get	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.
list	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.
list_by_resource_group	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.
list_orchestrators	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.

begin_create_or_update

Creates or updates a container service.

Creates or updates a container service with the specified configuration of orchestrator, masters, and agents.

begin_create_or_update(resource_group_name: str, container_service_name: str, parameters: azure.mgmt.containerservice.v2017_07_01.models._models_py3.ContainerService, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.containerservice.v2017_07_01.models._models_py3.ContainerService]

Parameters

resource_group_name

str

Required

The name of the resource group.

container_service_name

str

Required

The name of the container service in the specified subscription and resource group.

parameters

ContainerService

Required

Parameters supplied to the Create or Update a Container Service operation.

api_version

str

Api Version. Default value is "2017-07-01". Note that overriding this default value may result in unsupported behavior.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ContainerService]

Exceptions

HttpResponseError

begin_delete

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.

begin_delete(resource_group_name: str, container_service_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

container_service_name

str

Required

The name of the container service in the specified subscription and resource group.

api_version

str

Api Version. Default value is "2017-07-01". Note that overriding this default value may result in unsupported behavior.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Exceptions

HttpResponseError

get

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.

get(resource_group_name: str, container_service_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2017_07_01.models._models_py3.ContainerService

Parameters

resource_group_name

str

Required

The name of the resource group.

container_service_name

str

Required

The name of the container service in the specified subscription and resource group.

api_version

str

Api Version. Default value is "2017-07-01". Note that overriding this default value may result in unsupported behavior.

cls

callable

A custom type or function that will be passed the direct response

Returns

ContainerService, or the result of cls(response)

Return type

ContainerService

Exceptions

HttpResponseError

list

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.

list(**kwargs: Any) -> Iterable[azure.mgmt.containerservice.v2017_07_01.models._models_py3.ContainerServiceListResult]

Parameters

api_version

str

Api Version. Default value is "2017-07-01". Note that overriding this default value may result in unsupported behavior.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ContainerServiceListResult]

Exceptions

HttpResponseError

list_by_resource_group

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.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.containerservice.v2017_07_01.models._models_py3.ContainerServiceListResult]

Parameters

resource_group_name

str

Required

The name of the resource group.

api_version

str

Api Version. Default value is "2017-07-01". Note that overriding this default value may result in unsupported behavior.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ContainerServiceListResult]

Exceptions

HttpResponseError

list_orchestrators

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.

list_orchestrators(location: str, resource_type: Optional[str] = None, **kwargs: Any) -> azure.mgmt.containerservice.v2017_07_01.models._models_py3.OrchestratorVersionProfileListResult

Parameters

location

str

Required

The name of a supported Azure region.

resource_type

str

Required

resource type for which the list of orchestrators needs to be returned. Default value is None.

api_version

str

Api Version. Default value is "2019-04-01". Note that overriding this default value may result in unsupported behavior.

cls

callable

A custom type or function that will be passed the direct response

Returns

OrchestratorVersionProfileListResult, or the result of cls(response)

Return type

OrchestratorVersionProfileListResult

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.containerservice.v2017_07_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\containerservice\\v2017_07_01\\models\\__init__.py'>