1. Packages
  2. Azure Native v2
  3. API Docs
  4. compute
  5. getDiskAccess
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.compute.getDiskAccess

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets information about a disk access resource. Azure REST API version: 2022-07-02.

Other available API versions: 2023-01-02, 2023-04-02, 2023-10-02, 2024-03-02.

Using getDiskAccess

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDiskAccess(args: GetDiskAccessArgs, opts?: InvokeOptions): Promise<GetDiskAccessResult>
function getDiskAccessOutput(args: GetDiskAccessOutputArgs, opts?: InvokeOptions): Output<GetDiskAccessResult>
Copy
def get_disk_access(disk_access_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDiskAccessResult
def get_disk_access_output(disk_access_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDiskAccessResult]
Copy
func LookupDiskAccess(ctx *Context, args *LookupDiskAccessArgs, opts ...InvokeOption) (*LookupDiskAccessResult, error)
func LookupDiskAccessOutput(ctx *Context, args *LookupDiskAccessOutputArgs, opts ...InvokeOption) LookupDiskAccessResultOutput
Copy

> Note: This function is named LookupDiskAccess in the Go SDK.

public static class GetDiskAccess 
{
    public static Task<GetDiskAccessResult> InvokeAsync(GetDiskAccessArgs args, InvokeOptions? opts = null)
    public static Output<GetDiskAccessResult> Invoke(GetDiskAccessInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDiskAccessResult> getDiskAccess(GetDiskAccessArgs args, InvokeOptions options)
public static Output<GetDiskAccessResult> getDiskAccess(GetDiskAccessArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:compute:getDiskAccess
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DiskAccessName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
DiskAccessName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
diskAccessName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
diskAccessName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
disk_access_name
This property is required.
Changes to this property will trigger replacement.
str
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.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
diskAccessName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getDiskAccess Result

The following output properties are available:

Id string
Resource Id
Location string
Resource location
Name string
Resource name
PrivateEndpointConnections List<Pulumi.AzureNative.Compute.Outputs.PrivateEndpointConnectionResponse>
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.
TimeCreated string
The time when the disk access was created.
Type string
Resource type
ExtendedLocation Pulumi.AzureNative.Compute.Outputs.ExtendedLocationResponse
The extended location where the disk access will be created. Extended location cannot be changed.
Tags Dictionary<string, string>
Resource tags
Id string
Resource Id
Location string
Resource location
Name string
Resource name
PrivateEndpointConnections []PrivateEndpointConnectionResponse
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.
TimeCreated string
The time when the disk access was created.
Type string
Resource type
ExtendedLocation ExtendedLocationResponse
The extended location where the disk access will be created. Extended location cannot be changed.
Tags map[string]string
Resource tags
id String
Resource Id
location String
Resource location
name String
Resource name
privateEndpointConnections List<PrivateEndpointConnectionResponse>
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.
timeCreated String
The time when the disk access was created.
type String
Resource type
extendedLocation ExtendedLocationResponse
The extended location where the disk access will be created. Extended location cannot be changed.
tags Map<String,String>
Resource tags
id string
Resource Id
location string
Resource location
name string
Resource name
privateEndpointConnections PrivateEndpointConnectionResponse[]
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.
timeCreated string
The time when the disk access was created.
type string
Resource type
extendedLocation ExtendedLocationResponse
The extended location where the disk access will be created. Extended location cannot be changed.
tags {[key: string]: string}
Resource tags
id str
Resource Id
location str
Resource location
name str
Resource name
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported.
provisioning_state str
The disk access resource provisioning state.
time_created str
The time when the disk access was created.
type str
Resource type
extended_location ExtendedLocationResponse
The extended location where the disk access will be created. Extended location cannot be changed.
tags Mapping[str, str]
Resource tags
id String
Resource Id
location String
Resource location
name String
Resource name
privateEndpointConnections List<Property Map>
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.
timeCreated String
The time when the disk access was created.
type String
Resource type
extendedLocation Property Map
The extended location where the disk access will be created. Extended location cannot be changed.
tags Map<String>
Resource tags

Supporting Types

ExtendedLocationResponse

Name string
The name of the extended location.
Type string
The type of the extended location.
Name string
The name of the extended location.
Type string
The type of the extended location.
name String
The name of the extended location.
type String
The type of the extended location.
name string
The name of the extended location.
type string
The type of the extended location.
name str
The name of the extended location.
type str
The type of the extended location.
name String
The name of the extended location.
type String
The type of the extended location.

PrivateEndpointConnectionResponse

Id This property is required. string
private endpoint connection Id
Name This property is required. string
private endpoint connection name
PrivateEndpoint This property is required. Pulumi.AzureNative.Compute.Inputs.PrivateEndpointResponse
The resource of private end point.
PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.Compute.Inputs.PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between DiskAccess and Virtual Network.
ProvisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
Type This property is required. string
private endpoint connection type
Id This property is required. string
private endpoint connection Id
Name This property is required. string
private endpoint connection name
PrivateEndpoint This property is required. PrivateEndpointResponse
The resource of private end point.
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between DiskAccess and Virtual Network.
ProvisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
Type This property is required. string
private endpoint connection type
id This property is required. String
private endpoint connection Id
name This property is required. String
private endpoint connection name
privateEndpoint This property is required. PrivateEndpointResponse
The resource of private end point.
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between DiskAccess and Virtual Network.
provisioningState This property is required. String
The provisioning state of the private endpoint connection resource.
type This property is required. String
private endpoint connection type
id This property is required. string
private endpoint connection Id
name This property is required. string
private endpoint connection name
privateEndpoint This property is required. PrivateEndpointResponse
The resource of private end point.
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between DiskAccess and Virtual Network.
provisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
type This property is required. string
private endpoint connection type
id This property is required. str
private endpoint connection Id
name This property is required. str
private endpoint connection name
private_endpoint This property is required. PrivateEndpointResponse
The resource of private end point.
private_link_service_connection_state This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between DiskAccess and Virtual Network.
provisioning_state This property is required. str
The provisioning state of the private endpoint connection resource.
type This property is required. str
private endpoint connection type
id This property is required. String
private endpoint connection Id
name This property is required. String
private endpoint connection name
privateEndpoint This property is required. Property Map
The resource of private end point.
privateLinkServiceConnectionState This property is required. Property Map
A collection of information about the state of the connection between DiskAccess and Virtual Network.
provisioningState This property is required. String
The provisioning state of the private endpoint connection resource.
type This property is required. String
private endpoint connection type

PrivateEndpointResponse

Id This property is required. string
The ARM identifier for Private Endpoint
Id This property is required. string
The ARM identifier for Private Endpoint
id This property is required. String
The ARM identifier for Private Endpoint
id This property is required. string
The ARM identifier for Private Endpoint
id This property is required. str
The ARM identifier for Private Endpoint
id This property is required. String
The ARM identifier for Private Endpoint

PrivateLinkServiceConnectionStateResponse

ActionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
Description string
The reason for approval/rejection of the connection.
Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
ActionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
Description string
The reason for approval/rejection of the connection.
Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired String
A message indicating if changes on the service provider require any updates on the consumer.
description String
The reason for approval/rejection of the connection.
status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
description string
The reason for approval/rejection of the connection.
status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actions_required str
A message indicating if changes on the service provider require any updates on the consumer.
description str
The reason for approval/rejection of the connection.
status str
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired String
A message indicating if changes on the service provider require any updates on the consumer.
description String
The reason for approval/rejection of the connection.
status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi