SandboxGroupsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:sandbox_groups> attribute.

Constructor

SandboxGroupsOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update a SandboxGroup.
begin_delete	Delete a SandboxGroup.
begin_update	Patches a SandboxGroup.
get	Get the properties of a SandboxGroup.
list_by_resource_group	Get all SandboxGroups in a resource group.
list_by_subscription	Get all SandboxGroups for a subscription.

begin_create_or_update

Create or update a SandboxGroup.

async begin_create_or_update(resource_group_name: str, sandbox_group_name: str, resource: _models.SandboxGroup, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.SandboxGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
sandbox_group_name Required	str The name of the SandboxGroup. Required.
resource Required	SandboxGroup or SandboxGroup or IO[bytes] Resource create parameters. Is either a SandboxGroup type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[SandboxGroup]	An instance of AsyncLROPoller that returns SandboxGroup. The SandboxGroup is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete a SandboxGroup.

async begin_delete(resource_group_name: str, sandbox_group_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
sandbox_group_name Required	str The name of the SandboxGroup. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_update

Patches a SandboxGroup.

async begin_update(resource_group_name: str, sandbox_group_name: str, properties: _models.SandboxGroupPatch, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.SandboxGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
sandbox_group_name Required	str The name of the SandboxGroup. Required.
properties Required	SandboxGroupPatch or SandboxGroupPatch or IO[bytes] The resource properties to be updated. Is either a SandboxGroupPatch type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[SandboxGroup]	An instance of AsyncLROPoller that returns SandboxGroup. The SandboxGroup is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Get the properties of a SandboxGroup.

async get(resource_group_name: str, sandbox_group_name: str, **kwargs: Any) -> SandboxGroup

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
sandbox_group_name Required	str The name of the SandboxGroup. Required.

Returns

Type	Description
SandboxGroup	SandboxGroup. The SandboxGroup is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Get all SandboxGroups in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncItemPaged[SandboxGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
AsyncItemPaged[SandboxGroup]	An iterator like instance of SandboxGroup

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Get all SandboxGroups for a subscription.

list_by_subscription(**kwargs: Any) -> AsyncItemPaged[SandboxGroup]

Returns

Type	Description
AsyncItemPaged[SandboxGroup]	An iterator like instance of SandboxGroup

Exceptions

Type	Description
HttpResponseError

Opinia

Czy ta strona była pomocna?