configurations
Creates, updates, deletes, gets or lists a configurations
resource.
Overview
Name | configurations |
Type | Resource |
Id | azure.maintenance.configurations |
Fields
The following fields are returned by SELECT
queries:
- get
- list
Name | Datatype | Description |
---|---|---|
id | string (arm-id) | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name | string | The name of the resource |
location | string | Gets or sets location of the resource |
properties | object | Gets or sets properties 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" |
Name | Datatype | Description |
---|---|---|
id | string (arm-id) | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name | string | The name of the resource |
location | string | Gets or sets location of the resource |
properties | object | Gets or sets properties 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" |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | subscriptionId , resourceGroupName , resourceName | ||
list | select | subscriptionId | ||
create_or_update | insert | subscriptionId , resourceGroupName , resourceName | ||
update | update | subscriptionId , resourceGroupName , resourceName | ||
delete | delete | subscriptionId , resourceGroupName , resourceName |
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 |
---|---|---|
resourceGroupName | string | Resource Group Name |
resourceName | string | Maintenance Configuration Name |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
SELECT
examples
- get
- list
OK
SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.maintenance.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;
OK
SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.maintenance.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;
INSERT
examples
- create_or_update
- Manifest
No description available.
INSERT INTO azure.maintenance.configurations (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;
# Description fields are for documentation purposes
- name: configurations
props:
- name: subscriptionId
value: string (uuid)
description: Required parameter for the configurations resource.
- name: resourceGroupName
value: string
description: Required parameter for the configurations resource.
- name: resourceName
value: string
description: Required parameter for the configurations resource.
- name: location
value: string
description: |
Gets or sets location of the resource
- name: tags
value: object
description: |
Gets or sets tags of the resource
- name: properties
value: object
description: |
Gets or sets properties of the resource
UPDATE
examples
- update
No description available.
UPDATE azure.maintenance.configurations
SET
data__location = '{{ location }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;
DELETE
examples
- delete
No description available.
DELETE FROM azure.maintenance.configurations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
;