start_stop_managed_instance_schedules

Creates, updates, deletes, gets or lists a start_stop_managed_instance_schedules resource.

Overview

Name	start_stop_managed_instance_schedules
Type	Resource
Id	azure.sql.start_stop_managed_instance_schedules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The description of the schedule.
nextExecutionTime	string	Timestamp when the next action will be executed in the corresponding schedule time zone.
nextRunAction	string	Next action to be executed (Start or Stop).
scheduleList	array	Schedule list. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeZoneId	string	The time zone of the schedule.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_instance

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The description of the schedule.
nextExecutionTime	string	Timestamp when the next action will be executed in the corresponding schedule time zone.
nextRunAction	string	Next action to be executed (Start or Stop).
scheduleList	array	Schedule list. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeZoneId	string	The time zone of the schedule.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, managed_instance_name, start_stop_schedule_name, subscription_id		Gets the managed instance's Start/Stop schedule.
list_by_instance	select	resource_group_name, managed_instance_name, subscription_id		Lists the managed instance's Start/Stop schedules.
create_or_update	insert	resource_group_name, managed_instance_name, start_stop_schedule_name, subscription_id		Creates or updates the managed instance's Start/Stop schedule.
create_or_update	replace	resource_group_name, managed_instance_name, start_stop_schedule_name, subscription_id		Creates or updates the managed instance's Start/Stop schedule.
delete	delete	resource_group_name, managed_instance_name, start_stop_schedule_name, subscription_id		Deletes the managed instance's Start/Stop schedule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
managed_instance_name	string	The name of the managed instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
start_stop_schedule_name	string	Name of the managed instance Start/Stop schedule. "default" Required.
subscription_id	string

SELECT examples

get

Gets the managed instance's Start/Stop schedule.

SELECT
id,
name,
description,
nextExecutionTime,
nextRunAction,
scheduleList,
systemData,
timeZoneId,
type
FROM azure.sql.start_stop_managed_instance_schedules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND start_stop_schedule_name = '{{ start_stop_schedule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_instance

Lists the managed instance's Start/Stop schedules.

SELECT
id,
name,
description,
nextExecutionTime,
nextRunAction,
scheduleList,
systemData,
timeZoneId,
type
FROM azure.sql.start_stop_managed_instance_schedules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the managed instance's Start/Stop schedule.

INSERT INTO azure.sql.start_stop_managed_instance_schedules (
properties,
resource_group_name,
managed_instance_name,
start_stop_schedule_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ managed_instance_name }}',
'{{ start_stop_schedule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: start_stop_managed_instance_schedules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the start_stop_managed_instance_schedules resource.
  - name: managed_instance_name
    value: "{{ managed_instance_name }}"
    description: Required parameter for the start_stop_managed_instance_schedules resource.
  - name: start_stop_schedule_name
    value: "{{ start_stop_schedule_name }}"
    description: Required parameter for the start_stop_managed_instance_schedules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the start_stop_managed_instance_schedules resource.
  - name: properties
    description: |
      Resource properties.
    value:
      description: "{{ description }}"
      timeZoneId: "{{ timeZoneId }}"
      scheduleList:
        - startDay: "{{ startDay }}"
          startTime: "{{ startTime }}"
          stopDay: "{{ stopDay }}"
          stopTime: "{{ stopTime }}"
      nextRunAction: "{{ nextRunAction }}"
      nextExecutionTime: "{{ nextExecutionTime }}"

REPLACE examples

create_or_update

Creates or updates the managed instance's Start/Stop schedule.

REPLACE azure.sql.start_stop_managed_instance_schedules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND start_stop_schedule_name = '{{ start_stop_schedule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the managed instance's Start/Stop schedule.

DELETE FROM azure.sql.start_stop_managed_instance_schedules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND start_stop_schedule_name = '{{ start_stop_schedule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;