Share via

ResourceGroupsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ResourceManagementClient's

<xref:resource_groups> attribute.

Constructor

ResourceGroupsOperations(*args, **kwargs)

Methods

begin_delete

Delete resource group.
check_existence

Checks whether resource group exists.
create_or_update

Create a resource group.
export_template

Captures the specified resource group as a template.
get

Get a resource group.
list

Gets a collection of resource groups.
list_resources

Get all of the resources under a subscription.
patch

Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource groups, though if a field is unspecified current value will be carried over.

begin_delete

Delete resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to be deleted. The name is case insensitive. Required.

Returns

Type Description
AsyncLROPoller[None]

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

Exceptions

Type Description
HttpResponseError

check_existence

Checks whether resource group exists.

async check_existence(resource_group_name: str, **kwargs: Any) -> bool

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to check. The name is case insensitive. Required.

Returns

Type Description
bool

bool or the result of cls(response)

Exceptions

Type Description
HttpResponseError

create_or_update

Create a resource group.

async create_or_update(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to be created or updated. Required.
parameters
Required
ResourceGroup or IO[bytes]

Parameters supplied to the create or update resource group service operation. Is either a ResourceGroup type or a IO[bytes] type. Required.

Returns

Type Description
ResourceGroup

ResourceGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

export_template

Captures the specified resource group as a template.

async export_template(resource_group_name: str, parameters: _models.ExportTemplateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroupExportResult

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to be created or updated. Required.
parameters
Required
ExportTemplateRequest or IO[bytes]

Parameters supplied to the export template resource group operation. Is either a ExportTemplateRequest type or a IO[bytes] type. Required.

Returns

Type Description
ResourceGroupExportResult

ResourceGroupExportResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get a resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to get. The name is case insensitive. Required.

Returns

Type Description
ResourceGroup

ResourceGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets a collection of resource groups.

list(filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncItemPaged[ResourceGroup]

Parameters

Name Description
filter
str

The filter to apply on the operation. Default value is None.

Default value: None
top
int

Query parameters. If null is passed returns all resource groups. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[ResourceGroup]

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

Exceptions

Type Description
HttpResponseError

list_resources

Get all of the resources under a subscription.

list_resources(resource_group_name: str, filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncItemPaged[GenericResourceExpanded]

Parameters

Name Description
resource_group_name
Required
str

Query parameters. If null is passed returns all resource groups. Required.
filter
str

The filter to apply on the operation. Default value is None.

Default value: None
expand
str

Comma-separated list of additional properties to be included in the response. Valid values include createdTime, changedTime and provisioningState. For example, $expand=createdTime,changedTime. Default value is None.

Default value: None
top
int

Query parameters. If null is passed returns all resource groups. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[GenericResourceExpanded]

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

Exceptions

Type Description
HttpResponseError

patch

Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource groups, though if a field is unspecified current value will be carried over.

async patch(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to be created or updated. The name is case insensitive. Required.
parameters
Required
ResourceGroup or IO[bytes]

Parameters supplied to the update state resource group service operation. Is either a ResourceGroup type or a IO[bytes] type. Required.

Returns

Type Description
ResourceGroup

ResourceGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.resource.resources.v2016_02_01.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv206\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2016_02_01\\models\\__init__.py'>