maintenance_windows

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

Overview

Name	maintenance_windows
Type	Resource
Id	azure.sql.maintenance_windows

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved maintenance windows settings.

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	resourceGroupName, serverName, databaseName, maintenanceWindowName, subscriptionId		Gets maintenance windows settings for a database.
create_or_update	insert	resourceGroupName, serverName, databaseName, maintenanceWindowName, subscriptionId		Sets maintenance windows settings for a database.

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
databaseName	string	The name of the database to set maintenance windows for.
maintenanceWindowName	string	Maintenance window name.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets maintenance windows settings for a database.

SELECT
properties
FROM azure.sql.maintenance_windows
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND maintenanceWindowName = '{{ maintenanceWindowName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Sets maintenance windows settings for a database.

INSERT INTO azure.sql.maintenance_windows (
data__properties,
resourceGroupName,
serverName,
databaseName,
maintenanceWindowName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}',
'{{ maintenanceWindowName }}',
'{{ subscriptionId }}'
;

Manifest

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