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.
begin_export_template

Captures the specified resource group as a template.
check_existence

Checks whether a resource group exists.
create_or_update

Creates or updates a resource group.
get

Gets a resource group.
list

Gets all the resource groups for a subscription.
update

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.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to delete. The name is case insensitive. Required.
force_deletion_types
Required
str

The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets. Default value is None.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_export_template

Captures the specified resource group as a template.

begin_export_template(resource_group_name: str, parameters: _models.ExportTemplateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ResourceGroupExportResult]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
parameters
Required
ExportTemplateRequest or IO

Parameters for exporting the template. Is either a ExportTemplateRequest type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[ResourceGroupExportResult]

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

Exceptions

Type Description
HttpResponseError

check_existence

Checks whether a resource group exists.

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.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
bool

bool or the result of cls(response)

Exceptions

Type Description
HttpResponseError

create_or_update

Creates or updates a resource group.

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. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters. Required.
parameters
Required
ResourceGroup or IO

Parameters supplied to the create or update a resource group. Is either a ResourceGroup type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ResourceGroup

ResourceGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a resource group.

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.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

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) -> Iterable[ResourceGroup]

Parameters

Name Description
filter
Required
str

The filter to apply on the operation.:code:
:code:>><<<br>You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. 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.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[ResourceGroup]

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

Exceptions

Type Description
HttpResponseError

update

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.

update(resource_group_name: str, parameters: _models.ResourceGroupPatchable, *, 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
ResourceGroupPatchable or IO

Parameters supplied to update a resource group. Is either a ResourceGroupPatchable type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ResourceGroup

ResourceGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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