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.
begin_create_or_update(resource_group_name: str, sandbox_group_name: str, resource: _models.SandboxGroup, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.SandboxGroup]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
sandbox_group_name
Required
|
The name of the SandboxGroup. Required. |
|
resource
Required
|
Resource create parameters. Is either a SandboxGroup type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns SandboxGroup. The SandboxGroup is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
begin_delete
Delete a SandboxGroup.
begin_delete(resource_group_name: str, sandbox_group_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
sandbox_group_name
Required
|
The name of the SandboxGroup. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns None |
Exceptions
| Type | Description |
|---|---|
begin_update
Patches a SandboxGroup.
begin_update(resource_group_name: str, sandbox_group_name: str, properties: _models.SandboxGroupPatch, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.SandboxGroup]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
sandbox_group_name
Required
|
The name of the SandboxGroup. Required. |
|
properties
Required
|
The resource properties to be updated. Is either a SandboxGroupPatch type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns SandboxGroup. The SandboxGroup is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
get
Get the properties of a SandboxGroup.
get(resource_group_name: str, sandbox_group_name: str, **kwargs: Any) -> SandboxGroup
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
sandbox_group_name
Required
|
The name of the SandboxGroup. Required. |
Returns
| Type | Description |
|---|---|
|
SandboxGroup. The SandboxGroup is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
list_by_resource_group
Get all SandboxGroups in a resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> ItemPaged[SandboxGroup]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of SandboxGroup |
Exceptions
| Type | Description |
|---|---|
list_by_subscription
Get all SandboxGroups for a subscription.
list_by_subscription(**kwargs: Any) -> ItemPaged[SandboxGroup]
Returns
| Type | Description |
|---|---|
|
An iterator like instance of SandboxGroup |
Exceptions
| Type | Description |
|---|---|