maintenance_configurations

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

Overview

Name	maintenance_configurations
Type	Resource
Id	azure.container_service.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.
maintenanceWindow	object	Maintenance window for the maintenance configuration.
notAllowedTime	array	Time slots on which upgrade is not allowed.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeInWeek	array	Time slots during the week when planned maintenance is allowed to proceed. If two array entries specify the same day of the week, the applied configuration is the union of times in both entries.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_managed_cluster

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.
maintenanceWindow	object	Maintenance window for the maintenance configuration.
notAllowedTime	array	Time slots on which upgrade is not allowed.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeInWeek	array	Time slots during the week when planned maintenance is allowed to proceed. If two array entries specify the same day of the week, the applied configuration is the union of times in both entries.
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, resource_name, config_name, subscription_id		Gets the specified maintenance configuration of a managed cluster.
list_by_managed_cluster	select	resource_group_name, resource_name, subscription_id		Gets a list of maintenance configurations in the specified managed cluster.
create_or_update	insert	resource_group_name, resource_name, config_name, subscription_id		Creates or updates a maintenance configuration in the specified managed cluster.
create_or_update	replace	resource_group_name, resource_name, config_name, subscription_id		Creates or updates a maintenance configuration in the specified managed cluster.
delete	delete	resource_group_name, resource_name, config_name, subscription_id		Deletes a maintenance configuration.

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
config_name	string	The name of the maintenance configuration. Supported values are 'default', 'aksManagedAutoUpgradeSchedule', or 'aksManagedNodeOSUpgradeSchedule'. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the managed cluster resource. Required.
subscription_id	string

SELECT examples

get

Gets the specified maintenance configuration of a managed cluster.

SELECT
id,
name,
maintenanceWindow,
notAllowedTime,
systemData,
timeInWeek,
type
FROM azure.container_service.maintenance_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND config_name = '{{ config_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_managed_cluster

Gets a list of maintenance configurations in the specified managed cluster.

SELECT
id,
name,
maintenanceWindow,
notAllowedTime,
systemData,
timeInWeek,
type
FROM azure.container_service.maintenance_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a maintenance configuration in the specified managed cluster.

INSERT INTO azure.container_service.maintenance_configurations (
properties,
resource_group_name,
resource_name,
config_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ config_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
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: config_name
    value: "{{ config_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: |
      Properties of a default maintenance configuration.
    value:
      timeInWeek:
        - day: "{{ day }}"
          hourSlots: "{{ hourSlots }}"
      notAllowedTime:
        - start: "{{ start }}"
          end: "{{ end }}"
      maintenanceWindow:
        schedule:
          daily:
            intervalDays: {{ intervalDays }}
          weekly:
            intervalWeeks: {{ intervalWeeks }}
            dayOfWeek: "{{ dayOfWeek }}"
          absoluteMonthly:
            intervalMonths: {{ intervalMonths }}
            dayOfMonth: {{ dayOfMonth }}
          relativeMonthly:
            intervalMonths: {{ intervalMonths }}
            weekIndex: "{{ weekIndex }}"
            dayOfWeek: "{{ dayOfWeek }}"
        durationHours: {{ durationHours }}
        utcOffset: "{{ utcOffset }}"
        startDate: "{{ startDate }}"
        startTime: "{{ startTime }}"
        notAllowedDates:
          - start: "{{ start }}"
            end: "{{ end }}"

REPLACE examples

create_or_update

Creates or updates a maintenance configuration in the specified managed cluster.

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

DELETE examples

delete

Deletes a maintenance configuration.

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