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_a_private_endpoint_connection

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.
privateEndpoint	object	The resource of private end point.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between DiskAccess and Virtual Network. Required.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed". (Succeeded, Creating, Deleting, Failed)
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".

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.
extendedLocation	object	The extended location where the disk access will be created. Extended location cannot be changed.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported.
provisioningState	string	The disk access resource provisioning state.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeCreated	string (date-time)	The time when the disk access was created.
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.
extendedLocation	object	The extended location where the disk access will be created. Extended location cannot be changed.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported.
provisioningState	string	The disk access resource provisioning state.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeCreated	string (date-time)	The time when the disk access was created.
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.
extendedLocation	object	The extended location where the disk access will be created. Extended location cannot be changed.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported.
provisioningState	string	The disk access resource provisioning state.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeCreated	string (date-time)	The time when the disk access was created.
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_a_private_endpoint_connection	select	resource_group_name, disk_access_name, private_endpoint_connection_name, subscription_id		Gets information about a private endpoint connection under a disk access resource.
get	select	resource_group_name, disk_access_name, subscription_id		Gets information about a disk access resource.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all the disk access resources under a resource group.
list	select	subscription_id		Lists all the disk access resources under a subscription.
create_or_update	insert	resource_group_name, disk_access_name, subscription_id, location		Creates or updates a disk access resource.
update	update	resource_group_name, disk_access_name, subscription_id		Updates (patches) a disk access resource.
create_or_update	replace	resource_group_name, disk_access_name, subscription_id, location		Creates or updates a disk access resource.
delete	delete	resource_group_name, disk_access_name, subscription_id		Deletes a disk access resource.
list_private_endpoint_connections	exec	resource_group_name, disk_access_name, subscription_id		List information about private endpoint connections under a disk access resource.
get_private_link_resources	exec	resource_group_name, disk_access_name, subscription_id		Gets the private link resources possible under disk access resource.
update_a_private_endpoint_connection	exec	resource_group_name, disk_access_name, private_endpoint_connection_name, subscription_id		Approve or reject a private endpoint connection under disk access resource, this can't be used to create a new private endpoint connection.
delete_a_private_endpoint_connection	exec	resource_group_name, disk_access_name, private_endpoint_connection_name, subscription_id		Deletes a private endpoint connection under 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
disk_access_name	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. Required.
private_endpoint_connection_name	string	The name of the private endpoint connection. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get_a_private_endpoint_connection

Gets information about a private endpoint connection under a disk access resource.

SELECT
id,
name,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.compute.disk_accesses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND disk_access_name = '{{ disk_access_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets information about a disk access resource.

SELECT
id,
name,
extendedLocation,
location,
privateEndpointConnections,
provisioningState,
systemData,
tags,
timeCreated,
type
FROM azure.compute.disk_accesses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND disk_access_name = '{{ disk_access_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the disk access resources under a resource group.

SELECT
id,
name,
extendedLocation,
location,
privateEndpointConnections,
provisioningState,
systemData,
tags,
timeCreated,
type
FROM azure.compute.disk_accesses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the disk access resources under a subscription.

SELECT
id,
name,
extendedLocation,
location,
privateEndpointConnections,
provisioningState,
systemData,
tags,
timeCreated,
type
FROM azure.compute.disk_accesses
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a disk access resource.

INSERT INTO azure.compute.disk_accesses (
tags,
location,
properties,
extendedLocation,
resource_group_name,
disk_access_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ disk_access_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: disk_accesses
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the disk_accesses resource.
  - name: disk_access_name
    value: "{{ disk_access_name }}"
    description: Required parameter for the disk_accesses resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the disk_accesses resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      :vartype properties: ~azure.mgmt.compute.models.DiskAccessProperties
    value:
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      provisioningState: "{{ provisioningState }}"
      timeCreated: "{{ timeCreated }}"
  - name: extendedLocation
    description: |
      The extended location where the disk access will be created. Extended location cannot be changed.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

Updates (patches) a disk access resource.

UPDATE azure.compute.disk_accesses
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND disk_access_name = '{{ disk_access_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a disk access resource.

REPLACE azure.compute.disk_accesses
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND disk_access_name = '{{ disk_access_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a disk access resource.

DELETE FROM azure.compute.disk_accesses
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND disk_access_name = '{{ disk_access_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_private_endpoint_connections

List information about private endpoint connections under a disk access resource.

EXEC azure.compute.disk_accesses.list_private_endpoint_connections 
@resource_group_name='{{ resource_group_name }}' --required, 
@disk_access_name='{{ disk_access_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_private_link_resources

Gets the private link resources possible under disk access resource.

EXEC azure.compute.disk_accesses.get_private_link_resources 
@resource_group_name='{{ resource_group_name }}' --required, 
@disk_access_name='{{ disk_access_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_a_private_endpoint_connection

Approve or reject a private endpoint connection under disk access resource, this can't be used to create a new private endpoint connection.

EXEC azure.compute.disk_accesses.update_a_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@disk_access_name='{{ disk_access_name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_a_private_endpoint_connection

Deletes a private endpoint connection under a disk access resource.

EXEC azure.compute.disk_accesses.delete_a_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@disk_access_name='{{ disk_access_name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;