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

### YamlMime:PythonClass
uid: azure.mgmt.resource.resources.v2016_02_01.operations.ResourceGroupsOperations
name: ResourceGroupsOperations
fullName: azure.mgmt.resource.resources.v2016_02_01.operations.ResourceGroupsOperations
module: azure.mgmt.resource.resources.v2016_02_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.v2016_02_01.ResourceManagementClient>'s\n\
  >\n> <xref:resource_groups> attribute.\n>"
constructor:
  syntax: ResourceGroupsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.resource.resources.v2016_02_01.operations.ResourceGroupsOperations.begin_delete
  name: begin_delete
  summary: Delete resource group.
  signature: 'begin_delete(resource_group_name: str, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group to be deleted. 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.v2016_02_01.operations.ResourceGroupsOperations.check_existence
  name: check_existence
  summary: Checks whether 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.v2016_02_01.operations.ResourceGroupsOperations.create_or_update
  name: create_or_update
  summary: Create 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 be created or updated. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the create or update resource group service

      operation. Is either a ResourceGroup type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.resources.v2016_02_01.models.ResourceGroup>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: ResourceGroup or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.resources.v2016_02_01.models.ResourceGroup>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2016_02_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 be created or updated. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the export template resource group operation.
      Is

      either a ExportTemplateRequest type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.resources.v2016_02_01.models.ExportTemplateRequest>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: ResourceGroupExportResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.resources.v2016_02_01.models.ResourceGroupExportResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2016_02_01.operations.ResourceGroupsOperations.get
  name: get
  summary: Get 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.v2016_02_01.models.ResourceGroup>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2016_02_01.operations.ResourceGroupsOperations.list
  name: list
  summary: Gets a collection of resource groups.
  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. Default value is None.
    isRequired: true
    types:
    - <xref:str>
  - name: top
    description: 'Query parameters. 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.v2016_02_01.models.ResourceGroup>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2016_02_01.operations.ResourceGroupsOperations.list_resources
  name: list_resources
  summary: Get all of the resources under a subscription.
  signature: 'list_resources(resource_group_name: str, filter: str | None = None,
    expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]'
  parameters:
  - name: resource_group_name
    description: 'Query parameters. If null is passed returns all resource groups.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: The filter to apply on the operation. Default value is None.
    isRequired: true
    types:
    - <xref:str>
  - name: expand
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: top
    description: 'Query parameters. 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 GenericResourceExpanded or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.resources.v2016_02_01.models.GenericResourceExpanded>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2016_02_01.operations.ResourceGroupsOperations.patch
  name: patch
  summary: '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.'
  signature: 'patch(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 be created or updated. The name

      is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the update state resource group service operation.
      Is

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