azure.mgmt.devtestlabs.operations.GlobalSchedulesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.devtestlabs.operations.GlobalSchedulesOperations
name: GlobalSchedulesOperations
fullName: azure.mgmt.devtestlabs.operations.GlobalSchedulesOperations
module: azure.mgmt.devtestlabs.operations
inheritances:
- builtins.object
summary: 'GlobalSchedulesOperations operations.


  You should not instantiate this class directly. Instead, you should create a Client
  instance that

  instantiates it for you and attaches it as an attribute.'
constructor:
  syntax: GlobalSchedulesOperations(client, config, serializer, deserializer)
  parameters:
  - name: client
    description: Client for service requests.
    isRequired: true
  - name: config
    description: Configuration of service client.
    isRequired: true
  - name: serializer
    description: An object model serializer.
    isRequired: true
  - name: deserializer
    description: An object model deserializer.
    isRequired: true
variables:
- description: Alias to model classes used in this operation group.
  name: models
methods:
- uid: azure.mgmt.devtestlabs.operations.GlobalSchedulesOperations.begin_execute
  name: begin_execute
  summary: Execute a schedule. This operation can take a while to complete.
  signature: 'begin_execute(resource_group_name: str, name: str, **kwargs: Any) ->
    LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the schedule.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'True for ARMPolling, False for no polling, or a

      polling object for personal polling strategy'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  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.devtestlabs.operations.GlobalSchedulesOperations.begin_retarget
  name: begin_retarget
  summary: Updates a schedule's target resource Id. This operation can take a while
    to complete.
  signature: 'begin_retarget(resource_group_name: str, name: str, current_resource_id:
    str | None = None, target_resource_id: str | None = None, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the schedule.
    isRequired: true
    types:
    - <xref:str>
  - name: current_resource_id
    description: 'The resource Id of the virtual machine on which the schedule

      operates.'
    defaultValue: None
    types:
    - <xref:str>
  - name: target_resource_id
    description: 'The resource Id of the virtual machine that the schedule should
      be

      retargeted to.'
    defaultValue: None
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'True for ARMPolling, False for no polling, or a

      polling object for personal polling strategy'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  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.devtestlabs.operations.GlobalSchedulesOperations.create_or_update
  name: create_or_update
  summary: Create or replace an existing schedule.
  signature: 'create_or_update(resource_group_name: str, name: str, schedule: ''_models.Schedule'',
    **kwargs: Any) -> _models.Schedule'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the schedule.
    isRequired: true
    types:
    - <xref:str>
  - name: schedule
    description: A schedule.
    isRequired: true
    types:
    - <xref:azure.mgmt.devtestlabs.models.Schedule>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Schedule, or the result of cls(response)
    types:
    - <xref:azure.mgmt.devtestlabs.models.Schedule>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.devtestlabs.operations.GlobalSchedulesOperations.delete
  name: delete
  summary: Delete schedule.
  signature: 'delete(resource_group_name: str, name: str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the schedule.
    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.devtestlabs.operations.GlobalSchedulesOperations.get
  name: get
  summary: Get schedule.
  signature: 'get(resource_group_name: str, name: str, expand: str | None = None,
    **kwargs: Any) -> _models.Schedule'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the schedule.
    isRequired: true
    types:
    - <xref:str>
  - name: expand
    description: 'Specify the $expand query. Example: ''properties($select=status)''.'
    defaultValue: None
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Schedule, or the result of cls(response)
    types:
    - <xref:azure.mgmt.devtestlabs.models.Schedule>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.devtestlabs.operations.GlobalSchedulesOperations.list_by_resource_group
  name: list_by_resource_group
  summary: List schedules in a resource group.
  signature: 'list_by_resource_group(resource_group_name: str, expand: str | None
    = None, filter: str | None = None, top: int | None = None, orderby: str | None
    = None, **kwargs: Any) -> Iterable[''_models.ScheduleList'']'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: expand
    description: 'Specify the $expand query. Example: ''properties($select=status)''.'
    defaultValue: None
    types:
    - <xref:str>
  - name: filter
    description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'').'
    defaultValue: None
    types:
    - <xref:str>
  - name: top
    description: 'The maximum number of resources to return from the operation. Example:
      ''$top=10''.'
    defaultValue: None
    types:
    - <xref:int>
  - name: orderby
    description: 'The ordering expression for the results, using OData notation. Example:

      ''$orderby=name desc''.'
    defaultValue: None
    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 ScheduleList or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.devtestlabs.models.ScheduleList>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.devtestlabs.operations.GlobalSchedulesOperations.list_by_subscription
  name: list_by_subscription
  summary: List schedules in a subscription.
  signature: 'list_by_subscription(expand: str | None = None, filter: str | None =
    None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> Iterable[''_models.ScheduleList'']'
  parameters:
  - name: expand
    description: 'Specify the $expand query. Example: ''properties($select=status)''.'
    defaultValue: None
    types:
    - <xref:str>
  - name: filter
    description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'').'
    defaultValue: None
    types:
    - <xref:str>
  - name: top
    description: 'The maximum number of resources to return from the operation. Example:
      ''$top=10''.'
    defaultValue: None
    types:
    - <xref:int>
  - name: orderby
    description: 'The ordering expression for the results, using OData notation. Example:

      ''$orderby=name desc''.'
    defaultValue: None
    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 ScheduleList or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.devtestlabs.models.ScheduleList>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.devtestlabs.operations.GlobalSchedulesOperations.update
  name: update
  summary: Allows modifying tags of schedules. All other properties will be ignored.
  signature: 'update(resource_group_name: str, name: str, schedule: ''_models.ScheduleFragment'',
    **kwargs: Any) -> _models.Schedule'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the schedule.
    isRequired: true
    types:
    - <xref:str>
  - name: schedule
    description: A schedule.
    isRequired: true
    types:
    - <xref:azure.mgmt.devtestlabs.models.ScheduleFragment>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Schedule, or the result of cls(response)
    types:
    - <xref:azure.mgmt.devtestlabs.models.Schedule>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.devtestlabs.operations.GlobalSchedulesOperations.models
  name: models
  signature: models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>