maintenance_configurations

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

Overview

Name	maintenance_configurations
Type	Resource
Id	azure.maintenance.maintenance_configurations

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.
extensionProperties	object	Gets or sets extensionProperties of the maintenanceConfiguration.
installPatches	object	The input parameters to be passed to the patch run operation.
location	string	Gets or sets location of the resource.
maintenanceScope	string	Gets or sets maintenanceScope of the configuration. Known values are: "Host", "Resource", "OSImage", "Extension", "InGuestPatch", "SQLDB", and "SQLManagedInstance". (Host, Resource, OSImage, Extension, InGuestPatch, SQLDB, SQLManagedInstance)
maintenanceWindow	object	Definition of a MaintenanceWindow.
namespace	string	Gets or sets namespace of the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Gets or sets tags of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
visibility	string	Gets or sets the visibility of the configuration. The default value is 'Custom'. Known values are: "Custom" and "Public". (Custom, Public)

list

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.
extensionProperties	object	Gets or sets extensionProperties of the maintenanceConfiguration.
installPatches	object	The input parameters to be passed to the patch run operation.
location	string	Gets or sets location of the resource.
maintenanceScope	string	Gets or sets maintenanceScope of the configuration. Known values are: "Host", "Resource", "OSImage", "Extension", "InGuestPatch", "SQLDB", and "SQLManagedInstance". (Host, Resource, OSImage, Extension, InGuestPatch, SQLDB, SQLManagedInstance)
maintenanceWindow	object	Definition of a MaintenanceWindow.
namespace	string	Gets or sets namespace of the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Gets or sets tags of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
visibility	string	Gets or sets the visibility of the configuration. The default value is 'Custom'. Known values are: "Custom" and "Public". (Custom, Public)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, subscription_id		Get Configuration record.
list	select	subscription_id		Get Configuration records within a subscription.
create_or_update	insert	resource_group_name, resource_name, subscription_id		Create or Update configuration record.
update	update	resource_group_name, resource_name, subscription_id		Patch configuration record.
create_or_update	replace	resource_group_name, resource_name, subscription_id		Create or Update configuration record.
delete	delete	resource_group_name, resource_name, subscription_id		Delete Configuration record.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the MaintenanceConfiguration. Required.
subscription_id	string

SELECT examples

get

Get Configuration record.

SELECT
id,
name,
extensionProperties,
installPatches,
location,
maintenanceScope,
maintenanceWindow,
namespace,
systemData,
tags,
type,
visibility
FROM azure.maintenance.maintenance_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get Configuration records within a subscription.

SELECT
id,
name,
extensionProperties,
installPatches,
location,
maintenanceScope,
maintenanceWindow,
namespace,
systemData,
tags,
type,
visibility
FROM azure.maintenance.maintenance_configurations
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or Update configuration record.

INSERT INTO azure.maintenance.maintenance_configurations (
properties,
location,
tags,
resource_group_name,
resource_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: maintenance_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the maintenance_configurations resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the maintenance_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the maintenance_configurations resource.
  - name: properties
    description: |
      Gets or sets properties of the resource.
    value:
      namespace: "{{ namespace }}"
      extensionProperties: "{{ extensionProperties }}"
      maintenanceScope: "{{ maintenanceScope }}"
      maintenanceWindow:
        startDateTime: "{{ startDateTime }}"
        expirationDateTime: "{{ expirationDateTime }}"
        duration: "{{ duration }}"
        timeZone: "{{ timeZone }}"
        recurEvery: "{{ recurEvery }}"
      visibility: "{{ visibility }}"
      installPatches:
        rebootSetting: "{{ rebootSetting }}"
        windowsParameters:
          kbNumbersToExclude:
            - "{{ kbNumbersToExclude }}"
          kbNumbersToInclude:
            - "{{ kbNumbersToInclude }}"
          classificationsToInclude:
            - "{{ classificationsToInclude }}"
          excludeKbsRequiringReboot: {{ excludeKbsRequiringReboot }}
        linuxParameters:
          packageNameMasksToExclude:
            - "{{ packageNameMasksToExclude }}"
          packageNameMasksToInclude:
            - "{{ packageNameMasksToInclude }}"
          classificationsToInclude:
            - "{{ classificationsToInclude }}"
  - name: location
    value: "{{ location }}"
    description: |
      Gets or sets location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Gets or sets tags of the resource.

UPDATE examples

update

Patch configuration record.

UPDATE azure.maintenance.maintenance_configurations
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or Update configuration record.

REPLACE azure.maintenance.maintenance_configurations
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete Configuration record.

DELETE FROM azure.maintenance.maintenance_configurations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;