managed_cluster_snapshots

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

Overview

Name	managed_cluster_snapshots
Type	Resource
Id	azure.container_service.managed_cluster_snapshots

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.
creationData	object	CreationData to be used to specify the source resource ID to create this snapshot.
location	string	The geo-location where the resource lives. Required.
managedClusterPropertiesReadOnly	object	What the properties will be showed when getting managed cluster snapshot. Those properties are read-only.
snapshotType	string	The type of a snapshot. The default is NodePool. Known values are: "NodePool" and "ManagedCluster". (NodePool, ManagedCluster)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
creationData	object	CreationData to be used to specify the source resource ID to create this snapshot.
location	string	The geo-location where the resource lives. Required.
managedClusterPropertiesReadOnly	object	What the properties will be showed when getting managed cluster snapshot. Those properties are read-only.
snapshotType	string	The type of a snapshot. The default is NodePool. Known values are: "NodePool" and "ManagedCluster". (NodePool, ManagedCluster)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
creationData	object	CreationData to be used to specify the source resource ID to create this snapshot.
location	string	The geo-location where the resource lives. Required.
managedClusterPropertiesReadOnly	object	What the properties will be showed when getting managed cluster snapshot. Those properties are read-only.
snapshotType	string	The type of a snapshot. The default is NodePool. Known values are: "NodePool" and "ManagedCluster". (NodePool, ManagedCluster)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, subscription_id		Gets a managed cluster snapshot.
list_by_resource_group	select	resource_group_name, subscription_id		Lists managed cluster snapshots in the specified subscription and resource group.
list	select	subscription_id		Gets a list of managed cluster snapshots in the specified subscription.
create_or_update	insert	resource_group_name, resource_name, subscription_id, location		Creates or updates a managed cluster snapshot.
update_tags	update	resource_group_name, resource_name, subscription_id		Updates tags on a managed cluster snapshot.
create_or_update	replace	resource_group_name, resource_name, subscription_id, location		Creates or updates a managed cluster snapshot.
delete	delete	resource_group_name, resource_name, subscription_id		Deletes a managed cluster snapshot.

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 managed cluster resource. Required.
subscription_id	string

SELECT examples

get

Gets a managed cluster snapshot.

SELECT
id,
name,
creationData,
location,
managedClusterPropertiesReadOnly,
snapshotType,
systemData,
tags,
type
FROM azure.container_service.managed_cluster_snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists managed cluster snapshots in the specified subscription and resource group.

SELECT
id,
name,
creationData,
location,
managedClusterPropertiesReadOnly,
snapshotType,
systemData,
tags,
type
FROM azure.container_service.managed_cluster_snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of managed cluster snapshots in the specified subscription.

SELECT
id,
name,
creationData,
location,
managedClusterPropertiesReadOnly,
snapshotType,
systemData,
tags,
type
FROM azure.container_service.managed_cluster_snapshots
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a managed cluster snapshot.

INSERT INTO azure.container_service.managed_cluster_snapshots (
tags,
location,
properties,
resource_group_name,
resource_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_cluster_snapshots
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_cluster_snapshots resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the managed_cluster_snapshots resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_cluster_snapshots resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of a managed cluster snapshot.
    value:
      creationData:
        sourceResourceId: "{{ sourceResourceId }}"
      snapshotType: "{{ snapshotType }}"
      managedClusterPropertiesReadOnly:
        kubernetesVersion: "{{ kubernetesVersion }}"
        sku:
          name: "{{ name }}"
          tier: "{{ tier }}"
        enableRbac: {{ enableRbac }}
        networkProfile:
          networkPlugin: "{{ networkPlugin }}"
          networkPluginMode: "{{ networkPluginMode }}"
          networkPolicy: "{{ networkPolicy }}"
          networkMode: "{{ networkMode }}"
          loadBalancerSku: "{{ loadBalancerSku }}"

UPDATE examples

update_tags

Updates tags on a managed cluster snapshot.

UPDATE azure.container_service.managed_cluster_snapshots
SET 
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

Creates or updates a managed cluster snapshot.

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

DELETE examples

delete

Deletes a managed cluster snapshot.

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