azure.mgmt.resource.policy.v2022_08_01_preview.operations.VariablesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.resource.policy.v2022_08_01_preview.operations.VariablesOperations
name: VariablesOperations
fullName: azure.mgmt.resource.policy.v2022_08_01_preview.operations.VariablesOperations
module: azure.mgmt.resource.policy.v2022_08_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.resource.policy.v2022_08_01_preview.PolicyClient>'s\n\
  >\n> <xref:variables> attribute.\n>"
constructor:
  syntax: VariablesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.resource.policy.v2022_08_01_preview.operations.VariablesOperations.create_or_update
  name: create_or_update
  summary: 'Creates or updates a variable.


    This operation creates or updates a variable with the given subscription and name.
    Policy

    variables can only be used by a policy definition at the scope they are created
    or below.'
  signature: 'create_or_update(variable_name: str, parameters: _models.Variable, *,
    content_type: str = ''application/json'', **kwargs: Any) -> _models.Variable'
  parameters:
  - name: variable_name
    description: The name of the variable to operate on. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters for the variable. Is either a Variable type or a IO[bytes]
      type.

      Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.policy.v2022_08_01_preview.models.Variable>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: Variable or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.policy.v2022_08_01_preview.models.Variable>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2022_08_01_preview.operations.VariablesOperations.create_or_update_at_management_group
  name: create_or_update_at_management_group
  summary: 'Creates or updates a variable.


    This operation creates or updates a variable with the given  management group
    and name. Policy

    variables can only be used by a policy definition at the scope they are created
    or below.'
  signature: 'create_or_update_at_management_group(management_group_id: str, variable_name:
    str, parameters: _models.Variable, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.Variable'
  parameters:
  - name: management_group_id
    description: The ID of the management group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: variable_name
    description: The name of the variable to operate on. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters for the variable. Is either a Variable type or a IO[bytes]
      type.

      Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.policy.v2022_08_01_preview.models.Variable>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: Variable or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.policy.v2022_08_01_preview.models.Variable>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2022_08_01_preview.operations.VariablesOperations.delete
  name: delete
  summary: 'Deletes a variable.


    This operation deletes a variable, given its name and the subscription it was
    created in. The

    scope of a variable is the part of its ID preceding

    ''/providers/Microsoft.Authorization/variables/{variableName}''.'
  signature: 'delete(variable_name: str, **kwargs: Any) -> None'
  parameters:
  - name: variable_name
    description: The name of the variable to operate on. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2022_08_01_preview.operations.VariablesOperations.delete_at_management_group
  name: delete_at_management_group
  summary: 'Deletes a variable.


    This operation deletes a variable, given its name and the management group it
    was created in.

    The scope of a variable is the part of its ID preceding

    ''/providers/Microsoft.Authorization/variables/{variableName}''.'
  signature: 'delete_at_management_group(management_group_id: str, variable_name:
    str, **kwargs: Any) -> None'
  parameters:
  - name: management_group_id
    description: The ID of the management group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: variable_name
    description: The name of the variable to operate on. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2022_08_01_preview.operations.VariablesOperations.get
  name: get
  summary: 'Retrieves a variable.


    This operation retrieves a single variable, given its name and the subscription
    it was created

    at.'
  signature: 'get(variable_name: str, **kwargs: Any) -> Variable'
  parameters:
  - name: variable_name
    description: The name of the variable to operate on. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: Variable or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.policy.v2022_08_01_preview.models.Variable>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2022_08_01_preview.operations.VariablesOperations.get_at_management_group
  name: get_at_management_group
  summary: 'Retrieves a variable.


    This operation retrieves a single variable, given its name and the  management
    group it was

    created at.'
  signature: 'get_at_management_group(management_group_id: str, variable_name: str,
    **kwargs: Any) -> Variable'
  parameters:
  - name: management_group_id
    description: The ID of the management group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: variable_name
    description: The name of the variable to operate on. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: Variable or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.policy.v2022_08_01_preview.models.Variable>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2022_08_01_preview.operations.VariablesOperations.list
  name: list
  summary: 'Retrieves all variables that are at this subscription level.


    This operation retrieves the list of all variables associated with the given subscription.'
  signature: 'list(**kwargs: Any) -> Iterable[Variable]'
  return:
    description: An iterator like instance of either Variable or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.policy.v2022_08_01_preview.models.Variable>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2022_08_01_preview.operations.VariablesOperations.list_for_management_group
  name: list_for_management_group
  summary: 'Retrieves all variables that are at this management group level.


    This operation retrieves the list of all variables applicable to the management
    group.'
  signature: 'list_for_management_group(management_group_id: str, **kwargs: Any) ->
    Iterable[Variable]'
  parameters:
  - name: management_group_id
    description: The ID of the management group. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either Variable or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.policy.v2022_08_01_preview.models.Variable>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.resource.policy.v2022_08_01_preview.operations.VariablesOperations.models
  name: models
  signature: models = <module 'azure.mgmt.resource.policy.v2022_08_01_preview.models'
    from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\policy\\v2022_08_01_preview\\models\\__init__.py'>