Share via

KubeEnvironmentsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

WebSiteManagementClient's

<xref:kube_environments> attribute.

Inheritance
builtins.object
KubeEnvironmentsOperations

Constructor

KubeEnvironmentsOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates a Kubernetes Environment.

Creates or updates a Kubernetes Environment.
begin_delete

Delete a Kubernetes Environment.

Delete a Kubernetes Environment.
get

Get the properties of a Kubernetes Environment.

Get the properties of a Kubernetes Environment.
list_by_resource_group

Get all the Kubernetes Environments in a resource group.

Get all the Kubernetes Environments in a resource group.
list_by_subscription

Get all Kubernetes Environments for a subscription.

Get all Kubernetes Environments for a subscription.
update

Creates or updates a Kubernetes Environment.

Creates or updates a Kubernetes Environment.

begin_create_or_update

Creates or updates a Kubernetes Environment.

Creates or updates a Kubernetes Environment.

begin_create_or_update(resource_group_name: str, name: str, kube_environment_envelope: _models.KubeEnvironment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.KubeEnvironment]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
name
Required
str

Name of the Kubernetes Environment. Required.
kube_environment_envelope
Required
KubeEnvironment or IO[bytes]

Configuration details of the Kubernetes Environment. Is either a KubeEnvironment type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[KubeEnvironment]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a Kubernetes Environment.

Delete a Kubernetes Environment.

begin_delete(resource_group_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
name
Required
str

Name of the Kubernetes Environment. Required.

Returns

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

get

Get the properties of a Kubernetes Environment.

Get the properties of a Kubernetes Environment.

get(resource_group_name: str, name: str, **kwargs: Any) -> KubeEnvironment

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
name
Required
str

Name of the Kubernetes Environment. Required.

Returns

Type Description
KubeEnvironment

KubeEnvironment or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Get all the Kubernetes Environments in a resource group.

Get all the Kubernetes Environments in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[KubeEnvironment]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

Returns

Type Description
ItemPaged[KubeEnvironment]

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

Exceptions

Type Description
HttpResponseError

list_by_subscription

Get all Kubernetes Environments for a subscription.

Get all Kubernetes Environments for a subscription.

list_by_subscription(**kwargs: Any) -> Iterable[KubeEnvironment]

Returns

Type Description
ItemPaged[KubeEnvironment]

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

Exceptions

Type Description
HttpResponseError

update

Creates or updates a Kubernetes Environment.

Creates or updates a Kubernetes Environment.

update(resource_group_name: str, name: str, kube_environment_envelope: _models.KubeEnvironmentPatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.KubeEnvironment

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
name
Required
str

Name of the Kubernetes Environment. Required.
kube_environment_envelope
Required
KubeEnvironmentPatchResource or IO[bytes]

Configuration details of the Kubernetes Environment. Is either a KubeEnvironmentPatchResource type or a IO[bytes] type. Required.

Returns

Type Description
KubeEnvironment

KubeEnvironment or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.web.v2021_01_15.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2021_01_15\\models\\__init__.py'>