sql_pool_maintenance_window_options

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

Overview

Name	sql_pool_maintenance_window_options
Type	Resource
Id	azure.synapse.sql_pool_maintenance_window_options

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.
allowMultipleMaintenanceWindowsPerCycle	boolean	Whether we allow multiple maintenance windows per cycle.
defaultDurationInMinutes	integer	Default duration for maintenance window.
isEnabled	boolean	Whether maintenance windows are enabled for the database.
maintenanceWindowCycles	array	Available maintenance cycles e.g. {Saturday, 0, 48\ 60}, {Wednesday, 0, 24\ 60}.
minCycles	integer	Minimum number of maintenance windows cycles to be set on the database.
minDurationInMinutes	integer	Minimum duration of maintenance window.
timeGranularityInMinutes	integer	Time granularity in minutes for maintenance windows.
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, workspace_name, sql_pool_name, subscription_id, maintenanceWindowOptionsName		SQL pool's available maintenance windows. Get list of SQL pool's available maintenance windows.

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
maintenanceWindowOptionsName	string	Maintenance window options name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sql_pool_name	string	SQL pool name. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

SQL pool's available maintenance windows. Get list of SQL pool's available maintenance windows.

SELECT
id,
name,
allowMultipleMaintenanceWindowsPerCycle,
defaultDurationInMinutes,
isEnabled,
maintenanceWindowCycles,
minCycles,
minDurationInMinutes,
timeGranularityInMinutes,
type
FROM azure.synapse.sql_pool_maintenance_window_options
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND maintenanceWindowOptionsName = '{{ maintenanceWindowOptionsName }}' -- required
;