azure.mgmt.monitor.v2022_02_01_preview.operations.DataCollectionRulesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.monitor.v2022_02_01_preview.operations.DataCollectionRulesOperations
name: DataCollectionRulesOperations
fullName: azure.mgmt.monitor.v2022_02_01_preview.operations.DataCollectionRulesOperations
module: azure.mgmt.monitor.v2022_02_01_preview.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.monitor.v2022_02_01_preview.MonitorManagementClient>'s\n\
  >\n> <xref:data_collection_rules> attribute.\n>"
constructor:
  syntax: DataCollectionRulesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.monitor.v2022_02_01_preview.operations.DataCollectionRulesOperations.create
  name: create
  summary: 'Creates or updates a data collection rule.


    Creates or updates a data collection rule.'
  signature: 'create(resource_group_name: str, data_collection_rule_name: str, body:
    _models.DataCollectionRuleResource | None = None, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.DataCollectionRuleResource'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: data_collection_rule_name
    description: 'The name of the data collection rule. The name is case

      insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: body
    description: 'The payload. Is either a DataCollectionRuleResource type or a IO
      type. Default

      value is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.monitor.v2022_02_01_preview.models.DataCollectionRuleResource>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: DataCollectionRuleResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.monitor.v2022_02_01_preview.models.DataCollectionRuleResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.monitor.v2022_02_01_preview.operations.DataCollectionRulesOperations.delete
  name: delete
  summary: 'Deletes a data collection rule.


    Deletes a data collection rule.'
  signature: 'delete(resource_group_name: str, data_collection_rule_name: str, **kwargs:
    Any) -> None'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: data_collection_rule_name
    description: 'The name of the data collection rule. The name is case

      insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.monitor.v2022_02_01_preview.operations.DataCollectionRulesOperations.get
  name: get
  summary: 'Returns the specified data collection rule.


    Returns the specified data collection rule.'
  signature: 'get(resource_group_name: str, data_collection_rule_name: str, **kwargs:
    Any) -> DataCollectionRuleResource'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: data_collection_rule_name
    description: 'The name of the data collection rule. The name is case

      insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: DataCollectionRuleResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.monitor.v2022_02_01_preview.models.DataCollectionRuleResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.monitor.v2022_02_01_preview.operations.DataCollectionRulesOperations.list_by_resource_group
  name: list_by_resource_group
  summary: 'Lists all data collection rules in the specified resource group.


    Lists all data collection rules in the specified resource group.'
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[DataCollectionRuleResource]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either DataCollectionRuleResource or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.monitor.v2022_02_01_preview.models.DataCollectionRuleResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.monitor.v2022_02_01_preview.operations.DataCollectionRulesOperations.list_by_subscription
  name: list_by_subscription
  summary: 'Lists all data collection rules in the specified subscription.


    Lists all data collection rules in the specified subscription.'
  signature: 'list_by_subscription(**kwargs: Any) -> Iterable[DataCollectionRuleResource]'
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either DataCollectionRuleResource or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.monitor.v2022_02_01_preview.models.DataCollectionRuleResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.monitor.v2022_02_01_preview.operations.DataCollectionRulesOperations.update
  name: update
  summary: 'Updates part of a data collection rule.


    Updates part of a data collection rule.'
  signature: 'update(resource_group_name: str, data_collection_rule_name: str, body:
    _models.ResourceForUpdate | None = None, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.DataCollectionRuleResource'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: data_collection_rule_name
    description: 'The name of the data collection rule. The name is case

      insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: body
    description: 'The payload. Is either a ResourceForUpdate type or a IO type. Default
      value is

      None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.monitor.v2022_02_01_preview.models.ResourceForUpdate>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: DataCollectionRuleResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.monitor.v2022_02_01_preview.models.DataCollectionRuleResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.monitor.v2022_02_01_preview.operations.DataCollectionRulesOperations.models
  name: models
  signature: models = <module 'azure.mgmt.monitor.v2022_02_01_preview.models' from
    'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\monitor\\v2022_02_01_preview\\models\\__init__.py'>