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

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.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeRanges	array	:vartype time_ranges: list[~azure.mgmt.sql.models.MaintenanceWindowTimeRange]
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, server_name, database_name, subscription_id, maintenanceWindowName		Gets maintenance windows settings for a database.
create_or_update	insert	resource_group_name, server_name, database_name, subscription_id, maintenanceWindowName		Sets maintenance windows settings for a database.
create_or_update	replace	resource_group_name, server_name, database_name, subscription_id, maintenanceWindowName		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
database_name	string	The name of the database. Required.
maintenanceWindowName	string	Maintenance window name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets maintenance windows settings for a database.

SELECT
id,
name,
systemData,
timeRanges,
type
FROM azure.sql.maintenance_windows
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND maintenanceWindowName = '{{ maintenanceWindowName }}' -- required
;

INSERT examples

create_or_update

Sets maintenance windows settings for a database.

INSERT INTO azure.sql.maintenance_windows (
properties,
resource_group_name,
server_name,
database_name,
subscription_id,
maintenanceWindowName
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ database_name }}',
'{{ subscription_id }}',
'{{ maintenanceWindowName }}'
;

Manifest

# Description fields are for documentation purposes
- name: maintenance_windows
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the maintenance_windows resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the maintenance_windows resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the maintenance_windows resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the maintenance_windows resource.
  - name: maintenanceWindowName
    value: "{{ maintenanceWindowName }}"
    description: Required parameter for the maintenance_windows resource.
  - name: properties
    description: |
      Resource properties.
    value:
      timeRanges:
        - dayOfWeek: "{{ dayOfWeek }}"
          startTime: "{{ startTime }}"
          duration: "{{ duration }}"

REPLACE examples

create_or_update

Sets maintenance windows settings for a database.

REPLACE azure.sql.maintenance_windows
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND maintenanceWindowName = '{{ maintenanceWindowName }}' --required;