ResourceGroupsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ResourceManagementClient's

<xref:resource_groups> attribute.

Inheritance
builtins.object
ResourceGroupsOperations

Constructor

ResourceGroupsOperations(*args, **kwargs)

Methods

begin_delete

Deletes a resource group.

When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
check_existence

Checks whether a resource group exists.
create_or_update

Creates a resource group.
export_template

Captures the specified resource group as a template.
get

Gets a resource group.
list

Gets all the resource groups for a subscription.
list_resources

Get all the resources for a resource group.
patch

Updates a resource group.

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 group. If a field is unspecified, the current value is retained.

begin_delete

Deletes a resource group.

When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

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 delete. 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 a 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

Creates 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 create or update. Required.
parameters
Required
ResourceGroup or IO[bytes]

Parameters supplied to the create or update a resource group. 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 export as a template. Required.
parameters
Required
ExportTemplateRequest or IO[bytes]

Parameters for exporting the template. 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

Gets 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 all the resource groups for a subscription.

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

Parameters

Name Description
filter
Required
str

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

The number of results to return. If null is passed, returns all resource groups. Default value is 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 the resources for a resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The resource group with the resources to get. Required.
filter
Required
str

The filter to apply on the operation. Default value is None.
expand
Required
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.
top
Required
int

The number of results to return. If null is passed, returns all resources. Default value is None.

Returns

Type Description
AsyncItemPaged[GenericResourceExpanded]

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

Exceptions

Type Description
HttpResponseError

patch

Updates a resource group.

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 group. If a field is unspecified, the current value is retained.

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 update. The name is case insensitive. Required.
parameters
Required
ResourceGroup or IO[bytes]

Parameters supplied to update a resource group. 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_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2016_09_01\\models\\__init__.py'>