snapshots

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

Overview

Name	snapshots
Type	Resource
Id	azure.aks.snapshots

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of a snapshot.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of a snapshot.
tags	object	Resource tags.

list

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of a snapshot.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName
list_by_resource_group	select	subscriptionId, resourceGroupName
list	select	subscriptionId
create_or_update	insert	subscriptionId, resourceGroupName, resourceName
delete	delete	subscriptionId, resourceGroupName, resourceName
update_tags	exec	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	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the managed cluster resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

OK

SELECT
location,
properties,
tags
FROM azure.aks.snapshots
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list_by_resource_group

OK

SELECT
location,
properties,
tags
FROM azure.aks.snapshots
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

OK

SELECT
location,
properties,
tags
FROM azure.aks.snapshots
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.aks.snapshots (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: snapshots
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the snapshots resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the snapshots resource.
    - name: resourceName
      value: string
      description: Required parameter for the snapshots resource.
    - name: properties
      value: object
      description: |
        Properties of a snapshot.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

DELETE examples

delete

No description available.

DELETE FROM azure.aks.snapshots
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
;

Lifecycle Methods

update_tags

OK

EXEC azure.aks.snapshots.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;