sql_pool_maintenance_windows

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

Overview

Name	sql_pool_maintenance_windows
Type	Resource
Id	azure.synapse.sql_pool_maintenance_windows

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, maintenanceWindowName		Get a SQL pool's Maintenance Windows.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, maintenanceWindowName		Creates or updates a Sql pool's maintenance windows settings.

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
maintenanceWindowName	string	Maintenance window name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
sqlPoolName	string	SQL pool name
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get a SQL pool's Maintenance Windows.

SELECT
properties
FROM azure.synapse.sql_pool_maintenance_windows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND maintenanceWindowName = '{{ maintenanceWindowName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Sql pool's maintenance windows settings.

INSERT INTO azure.synapse.sql_pool_maintenance_windows (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
sqlPoolName,
maintenanceWindowName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sqlPoolName }}',
'{{ maintenanceWindowName }}'
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_maintenance_windows
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_pool_maintenance_windows resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_pool_maintenance_windows resource.
    - name: workspaceName
      value: string
      description: Required parameter for the sql_pool_maintenance_windows resource.
    - name: sqlPoolName
      value: string
      description: Required parameter for the sql_pool_maintenance_windows resource.
    - name: maintenanceWindowName
      value: string
      description: Required parameter for the sql_pool_maintenance_windows resource.
    - name: properties
      value: object
      description: |
        Resource properties.