disk_accesses

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

Overview

Name	disk_accesses
Type	Resource
Id	azure.compute.disk_accesses

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
extendedLocation	object	The extended location where the disk access will be created. Extended location cannot be changed.
location	string	Resource location
properties	object
tags	object	Resource tags
type	string	Resource type

list_by_resource_group

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
extendedLocation	object	The extended location where the disk access will be created. Extended location cannot be changed.
location	string	Resource location
properties	object
tags	object	Resource tags
type	string	Resource type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
extendedLocation	object	The extended location where the disk access will be created. Extended location cannot be changed.
location	string	Resource location
properties	object
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, diskAccessName		Gets information about a disk access resource.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the disk access resources under a resource group.
list	select	subscriptionId		Lists all the disk access resources under a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, diskAccessName		Creates or updates a disk access resource
update	update	subscriptionId, resourceGroupName, diskAccessName		Updates (patches) a disk access resource.
delete	delete	subscriptionId, resourceGroupName, diskAccessName		Deletes a disk access resource.

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
diskAccessName	string	The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets information about a disk access resource.

SELECT
id,
name,
extendedLocation,
location,
properties,
tags,
type
FROM azure.compute.disk_accesses
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND diskAccessName = '{{ diskAccessName }}' -- required
;

list_by_resource_group

Lists all the disk access resources under a resource group.

SELECT
id,
name,
extendedLocation,
location,
properties,
tags,
type
FROM azure.compute.disk_accesses
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

Lists all the disk access resources under a subscription.

SELECT
id,
name,
extendedLocation,
location,
properties,
tags,
type
FROM azure.compute.disk_accesses
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a disk access resource

INSERT INTO azure.compute.disk_accesses (
data__properties,
data__extendedLocation,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
diskAccessName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ diskAccessName }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: disk_accesses
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the disk_accesses resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the disk_accesses resource.
    - name: diskAccessName
      value: string
      description: Required parameter for the disk_accesses resource.
    - name: properties
      value: object
    - name: extendedLocation
      value: object
      description: |
        The extended location where the disk access will be created. Extended location cannot be changed.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

UPDATE examples

update

Updates (patches) a disk access resource.

UPDATE azure.compute.disk_accesses
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND diskAccessName = '{{ diskAccessName }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a disk access resource.

DELETE FROM azure.compute.disk_accesses
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND diskAccessName = '{{ diskAccessName }}' --required
;