azure.mgmt.resource.resources.v2019_05_01.operations.ResourceGroupsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.resource.resources.v2019_05_01.operations.ResourceGroupsOperations
name: ResourceGroupsOperations
fullName: azure.mgmt.resource.resources.v2019_05_01.operations.ResourceGroupsOperations
module: azure.mgmt.resource.resources.v2019_05_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.resource.resources.v2019_05_01.ResourceManagementClient>'s\n\
  >\n> <xref:resource_groups> attribute.\n>"
constructor:
  syntax: ResourceGroupsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.resource.resources.v2019_05_01.operations.ResourceGroupsOperations.begin_delete
  name: begin_delete
  summary: '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.'
  signature: 'begin_delete(resource_group_name: str, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group to delete. The name is case

      insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2019_05_01.operations.ResourceGroupsOperations.check_existence
  name: check_existence
  summary: Checks whether a resource group exists.
  signature: 'check_existence(resource_group_name: str, **kwargs: Any) -> bool'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group to check. The name is case

      insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: bool or the result of cls(response)
    types:
    - <xref:bool>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2019_05_01.operations.ResourceGroupsOperations.create_or_update
  name: create_or_update
  summary: Creates or updates a resource group.
  signature: 'create_or_update(resource_group_name: str, parameters: _models.ResourceGroup,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.ResourceGroup'
  parameters:
  - name: resource_group_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the create or update a resource group. Is
      either a

      ResourceGroup type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.resources.v2019_05_01.models.ResourceGroup>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: ResourceGroup or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.resources.v2019_05_01.models.ResourceGroup>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2019_05_01.operations.ResourceGroupsOperations.export_template
  name: export_template
  summary: Captures the specified resource group as a template.
  signature: 'export_template(resource_group_name: str, parameters: _models.ExportTemplateRequest,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.ResourceGroupExportResult'
  parameters:
  - name: resource_group_name
    description: The name of the resource group to export as a template. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters for exporting the template. Is either a ExportTemplateRequest

      type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.resources.v2019_05_01.models.ExportTemplateRequest>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: ResourceGroupExportResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.resources.v2019_05_01.models.ResourceGroupExportResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2019_05_01.operations.ResourceGroupsOperations.get
  name: get
  summary: Gets a resource group.
  signature: 'get(resource_group_name: str, **kwargs: Any) -> ResourceGroup'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group to get. The name is case

      insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: ResourceGroup or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.resources.v2019_05_01.models.ResourceGroup>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2019_05_01.operations.ResourceGroupsOperations.list
  name: list
  summary: Gets all the resource groups for a subscription.
  signature: 'list(filter: str | None = None, top: int | None = None, **kwargs: Any)
    -> Iterable[ResourceGroup]'
  parameters:
  - name: filter
    description: 'The filter to apply on the operation.:code:*<br>*: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.'
    isRequired: true
    types:
    - <xref:str>
  - name: top
    description: 'The number of results to return. If null is passed, returns all
      resource groups.

      Default value is None.'
    isRequired: true
    types:
    - <xref:int>
  return:
    description: An iterator like instance of either ResourceGroup or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.resources.v2019_05_01.models.ResourceGroup>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2019_05_01.operations.ResourceGroupsOperations.update
  name: update
  summary: '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.'
  signature: 'update(resource_group_name: str, parameters: _models.ResourceGroupPatchable,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.ResourceGroup'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group to update. The name is case

      insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to update a resource group. Is either a

      ResourceGroupPatchable type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.resources.v2019_05_01.models.ResourceGroupPatchable>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: ResourceGroup or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.resources.v2019_05_01.models.ResourceGroup>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.resource.resources.v2019_05_01.operations.ResourceGroupsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.resource.resources.v2019_05_01.models' from
    'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2019_05_01\\models\\__init__.py'>