1. Packages
  2. Azure Native
  3. API Docs
  4. compute
  5. DiskAccess
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.compute.DiskAccess

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    disk access resource. Azure REST API version: 2022-07-02. Prior API version in Azure Native 1.x: 2020-12-01.

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

    Example Usage

    Create a disk access resource.

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var diskAccess = new AzureNative.Compute.DiskAccess("diskAccess", new()
        {
            DiskAccessName = "myDiskAccess",
            Location = "West US",
            ResourceGroupName = "myResourceGroup",
        });
    
    });
    
    package main
    
    import (
    	compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := compute.NewDiskAccess(ctx, "diskAccess", &compute.DiskAccessArgs{
    			DiskAccessName:    pulumi.String("myDiskAccess"),
    			Location:          pulumi.String("West US"),
    			ResourceGroupName: pulumi.String("myResourceGroup"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.compute.DiskAccess;
    import com.pulumi.azurenative.compute.DiskAccessArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var diskAccess = new DiskAccess("diskAccess", DiskAccessArgs.builder()
                .diskAccessName("myDiskAccess")
                .location("West US")
                .resourceGroupName("myResourceGroup")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    disk_access = azure_native.compute.DiskAccess("diskAccess",
        disk_access_name="myDiskAccess",
        location="West US",
        resource_group_name="myResourceGroup")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const diskAccess = new azure_native.compute.DiskAccess("diskAccess", {
        diskAccessName: "myDiskAccess",
        location: "West US",
        resourceGroupName: "myResourceGroup",
    });
    
    resources:
      diskAccess:
        type: azure-native:compute:DiskAccess
        properties:
          diskAccessName: myDiskAccess
          location: West US
          resourceGroupName: myResourceGroup
    

    Create DiskAccess Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DiskAccess(name: string, args: DiskAccessArgs, opts?: CustomResourceOptions);
    @overload
    def DiskAccess(resource_name: str,
                   args: DiskAccessArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DiskAccess(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   disk_access_name: Optional[str] = None,
                   extended_location: Optional[ExtendedLocationArgs] = None,
                   location: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewDiskAccess(ctx *Context, name string, args DiskAccessArgs, opts ...ResourceOption) (*DiskAccess, error)
    public DiskAccess(string name, DiskAccessArgs args, CustomResourceOptions? opts = null)
    public DiskAccess(String name, DiskAccessArgs args)
    public DiskAccess(String name, DiskAccessArgs args, CustomResourceOptions options)
    
    type: azure-native:compute:DiskAccess
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DiskAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DiskAccessArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DiskAccessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DiskAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DiskAccessArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var diskAccessResource = new AzureNative.Compute.DiskAccess("diskAccessResource", new()
    {
        ResourceGroupName = "string",
        DiskAccessName = "string",
        ExtendedLocation = new AzureNative.Compute.Inputs.ExtendedLocationArgs
        {
            Name = "string",
            Type = "string",
        },
        Location = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := compute.NewDiskAccess(ctx, "diskAccessResource", &compute.DiskAccessArgs{
    	ResourceGroupName: pulumi.String("string"),
    	DiskAccessName:    pulumi.String("string"),
    	ExtendedLocation: &compute.ExtendedLocationArgs{
    		Name: pulumi.String("string"),
    		Type: pulumi.String("string"),
    	},
    	Location: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var diskAccessResource = new DiskAccess("diskAccessResource", DiskAccessArgs.builder()
        .resourceGroupName("string")
        .diskAccessName("string")
        .extendedLocation(ExtendedLocationArgs.builder()
            .name("string")
            .type("string")
            .build())
        .location("string")
        .tags(Map.of("string", "string"))
        .build());
    
    disk_access_resource = azure_native.compute.DiskAccess("diskAccessResource",
        resource_group_name="string",
        disk_access_name="string",
        extended_location={
            "name": "string",
            "type": "string",
        },
        location="string",
        tags={
            "string": "string",
        })
    
    const diskAccessResource = new azure_native.compute.DiskAccess("diskAccessResource", {
        resourceGroupName: "string",
        diskAccessName: "string",
        extendedLocation: {
            name: "string",
            type: "string",
        },
        location: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:compute:DiskAccess
    properties:
        diskAccessName: string
        extendedLocation:
            name: string
            type: string
        location: string
        resourceGroupName: string
        tags:
            string: string
    

    DiskAccess Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DiskAccess resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group.
    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.
    ExtendedLocation Pulumi.AzureNative.Compute.Inputs.ExtendedLocation
    The extended location where the disk access will be created. Extended location cannot be changed.
    Location string
    Resource location
    Tags Dictionary<string, string>
    Resource tags
    ResourceGroupName string
    The name of the resource group.
    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.
    ExtendedLocation ExtendedLocationArgs
    The extended location where the disk access will be created. Extended location cannot be changed.
    Location string
    Resource location
    Tags map[string]string
    Resource tags
    resourceGroupName String
    The name of the resource group.
    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.
    extendedLocation ExtendedLocation
    The extended location where the disk access will be created. Extended location cannot be changed.
    location String
    Resource location
    tags Map<String,String>
    Resource tags
    resourceGroupName string
    The name of the resource group.
    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.
    extendedLocation ExtendedLocation
    The extended location where the disk access will be created. Extended location cannot be changed.
    location string
    Resource location
    tags {[key: string]: string}
    Resource tags
    resource_group_name str
    The name of the resource group.
    disk_access_name 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.
    extended_location ExtendedLocationArgs
    The extended location where the disk access will be created. Extended location cannot be changed.
    location str
    Resource location
    tags Mapping[str, str]
    Resource tags
    resourceGroupName String
    The name of the resource group.
    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.
    extendedLocation Property Map
    The extended location where the disk access will be created. Extended location cannot be changed.
    location String
    Resource location
    tags Map<String>
    Resource tags

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DiskAccess resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    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
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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
    id string
    The provider-assigned unique ID for this managed resource.
    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
    id str
    The provider-assigned unique ID for this managed resource.
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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

    Supporting Types

    ExtendedLocation, ExtendedLocationArgs

    Name string
    The name of the extended location.
    Type string | Pulumi.AzureNative.Compute.ExtendedLocationTypes
    The type of the extended location.
    Name string
    The name of the extended location.
    Type string | ExtendedLocationTypes
    The type of the extended location.
    name String
    The name of the extended location.
    type String | ExtendedLocationTypes
    The type of the extended location.
    name string
    The name of the extended location.
    type string | ExtendedLocationTypes
    The type of the extended location.
    name str
    The name of the extended location.
    type str | ExtendedLocationTypes
    The type of the extended location.
    name String
    The name of the extended location.
    type String | "EdgeZone"
    The type of the extended location.

    ExtendedLocationResponse, ExtendedLocationResponseArgs

    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.

    ExtendedLocationTypes, ExtendedLocationTypesArgs

    EdgeZone
    EdgeZone
    ExtendedLocationTypesEdgeZone
    EdgeZone
    EdgeZone
    EdgeZone
    EdgeZone
    EdgeZone
    EDGE_ZONE
    EdgeZone
    "EdgeZone"
    EdgeZone

    PrivateEndpointConnectionResponse, PrivateEndpointConnectionResponseArgs

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

    PrivateEndpointResponse, PrivateEndpointResponseArgs

    Id string
    The ARM identifier for Private Endpoint
    Id string
    The ARM identifier for Private Endpoint
    id String
    The ARM identifier for Private Endpoint
    id string
    The ARM identifier for Private Endpoint
    id str
    The ARM identifier for Private Endpoint
    id String
    The ARM identifier for Private Endpoint

    PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs

    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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:compute:DiskAccess myDiskAccess /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi