patch_schedules

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

Overview

Name	patch_schedules
Type	Resource
Id	azure.redis.patch_schedules

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.
location	string	The geo-location where the resource lives.
scheduleEntries	array	List of patch schedules for a Redis cache. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_redis_resource

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.
location	string	The geo-location where the resource lives.
scheduleEntries	array	List of patch schedules for a Redis cache. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, name, default_name, subscription_id		Gets the patching schedule of a redis cache.
list_by_redis_resource	select	resource_group_name, cache_name, subscription_id		Gets all patch schedules in the specified redis cache (there is only one).
create_or_update	insert	resource_group_name, name, default_name, subscription_id, properties		Create or replace the patching schedule for Redis cache.
create_or_update	replace	resource_group_name, name, default_name, subscription_id, properties		Create or replace the patching schedule for Redis cache.
delete	delete	resource_group_name, name, default_name, subscription_id		Deletes the patching schedule of a redis cache.

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
cache_name	string	The name of the Redis cache. Required.
default_name	string	The name of the RedisPatchSchedule. "default" Required.
name	string	The name of the redis cache. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the patching schedule of a redis cache.

SELECT
id,
name,
location,
scheduleEntries,
systemData,
type
FROM azure.redis.patch_schedules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND default_name = '{{ default_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_redis_resource

Gets all patch schedules in the specified redis cache (there is only one).

SELECT
id,
name,
location,
scheduleEntries,
systemData,
type
FROM azure.redis.patch_schedules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cache_name = '{{ cache_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or replace the patching schedule for Redis cache.

INSERT INTO azure.redis.patch_schedules (
properties,
resource_group_name,
name,
default_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ name }}',
'{{ default_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: patch_schedules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the patch_schedules resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the patch_schedules resource.
  - name: default_name
    value: "{{ default_name }}"
    description: Required parameter for the patch_schedules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the patch_schedules resource.
  - name: properties
    description: |
      List of patch schedules for a Redis cache. Required.
    value:
      scheduleEntries:
        - dayOfWeek: "{{ dayOfWeek }}"
          startHourUtc: {{ startHourUtc }}
          maintenanceWindow: "{{ maintenanceWindow }}"

REPLACE examples

create_or_update

Create or replace the patching schedule for Redis cache.

REPLACE azure.redis.patch_schedules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND default_name = '{{ default_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
type;

DELETE examples

delete

Deletes the patching schedule of a redis cache.

DELETE FROM azure.redis.patch_schedules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND default_name = '{{ default_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;