1. Packages
  2. Azure Classic
  3. API Docs
  4. compute
  5. DiskAccess

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.compute.DiskAccess

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages a Disk Access.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.compute.DiskAccess("example", {
        name: "example",
        resourceGroupName: "example",
        location: "West Europe",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.compute.DiskAccess("example",
        name="example",
        resource_group_name="example",
        location="West Europe")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := compute.NewDiskAccess(ctx, "example", &compute.DiskAccessArgs{
    			Name:              pulumi.String("example"),
    			ResourceGroupName: pulumi.String("example"),
    			Location:          pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Compute.DiskAccess("example", new()
        {
            Name = "example",
            ResourceGroupName = "example",
            Location = "West Europe",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.compute.DiskAccess;
    import com.pulumi.azure.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 example = new DiskAccess("example", DiskAccessArgs.builder()
                .name("example")
                .resourceGroupName("example")
                .location("West Europe")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:compute:DiskAccess
        properties:
          name: example
          resourceGroupName: example
          location: West Europe
    

    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,
                   location: Optional[str] = None,
                   name: 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: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.

    Example

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

    var diskAccessResource = new Azure.Compute.DiskAccess("diskAccessResource", new()
    {
        ResourceGroupName = "string",
        Location = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := compute.NewDiskAccess(ctx, "diskAccessResource", &compute.DiskAccessArgs{
    	ResourceGroupName: pulumi.String("string"),
    	Location:          pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var diskAccessResource = new DiskAccess("diskAccessResource", DiskAccessArgs.builder()
        .resourceGroupName("string")
        .location("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    disk_access_resource = azure.compute.DiskAccess("diskAccessResource",
        resource_group_name="string",
        location="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const diskAccessResource = new azure.compute.DiskAccess("diskAccessResource", {
        resourceGroupName: "string",
        location: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:compute:DiskAccess
    properties:
        location: string
        name: 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

    The DiskAccess resource accepts the following input properties:

    ResourceGroupName string
    The name of the Resource Group where the Disk Access should exist. Changing this forces a new Disk Access to be created.
    Location string
    The Azure Region where the Disk Access should exist. Changing this forces a new Disk to be created.
    Name string
    The name which should be used for this Disk Access. Changing this forces a new Disk Access to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Disk Access.
    ResourceGroupName string
    The name of the Resource Group where the Disk Access should exist. Changing this forces a new Disk Access to be created.
    Location string
    The Azure Region where the Disk Access should exist. Changing this forces a new Disk to be created.
    Name string
    The name which should be used for this Disk Access. Changing this forces a new Disk Access to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Disk Access.
    resourceGroupName String
    The name of the Resource Group where the Disk Access should exist. Changing this forces a new Disk Access to be created.
    location String
    The Azure Region where the Disk Access should exist. Changing this forces a new Disk to be created.
    name String
    The name which should be used for this Disk Access. Changing this forces a new Disk Access to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Disk Access.
    resourceGroupName string
    The name of the Resource Group where the Disk Access should exist. Changing this forces a new Disk Access to be created.
    location string
    The Azure Region where the Disk Access should exist. Changing this forces a new Disk to be created.
    name string
    The name which should be used for this Disk Access. Changing this forces a new Disk Access to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Disk Access.
    resource_group_name str
    The name of the Resource Group where the Disk Access should exist. Changing this forces a new Disk Access to be created.
    location str
    The Azure Region where the Disk Access should exist. Changing this forces a new Disk to be created.
    name str
    The name which should be used for this Disk Access. Changing this forces a new Disk Access to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Disk Access.
    resourceGroupName String
    The name of the Resource Group where the Disk Access should exist. Changing this forces a new Disk Access to be created.
    location String
    The Azure Region where the Disk Access should exist. Changing this forces a new Disk to be created.
    name String
    The name which should be used for this Disk Access. Changing this forces a new Disk Access to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Disk Access.

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

    Look up Existing DiskAccess Resource

    Get an existing DiskAccess resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DiskAccessState, opts?: CustomResourceOptions): DiskAccess
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> DiskAccess
    func GetDiskAccess(ctx *Context, name string, id IDInput, state *DiskAccessState, opts ...ResourceOption) (*DiskAccess, error)
    public static DiskAccess Get(string name, Input<string> id, DiskAccessState? state, CustomResourceOptions? opts = null)
    public static DiskAccess get(String name, Output<String> id, DiskAccessState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Location string
    The Azure Region where the Disk Access should exist. Changing this forces a new Disk to be created.
    Name string
    The name which should be used for this Disk Access. Changing this forces a new Disk Access to be created.
    ResourceGroupName string
    The name of the Resource Group where the Disk Access should exist. Changing this forces a new Disk Access to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Disk Access.
    Location string
    The Azure Region where the Disk Access should exist. Changing this forces a new Disk to be created.
    Name string
    The name which should be used for this Disk Access. Changing this forces a new Disk Access to be created.
    ResourceGroupName string
    The name of the Resource Group where the Disk Access should exist. Changing this forces a new Disk Access to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Disk Access.
    location String
    The Azure Region where the Disk Access should exist. Changing this forces a new Disk to be created.
    name String
    The name which should be used for this Disk Access. Changing this forces a new Disk Access to be created.
    resourceGroupName String
    The name of the Resource Group where the Disk Access should exist. Changing this forces a new Disk Access to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Disk Access.
    location string
    The Azure Region where the Disk Access should exist. Changing this forces a new Disk to be created.
    name string
    The name which should be used for this Disk Access. Changing this forces a new Disk Access to be created.
    resourceGroupName string
    The name of the Resource Group where the Disk Access should exist. Changing this forces a new Disk Access to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Disk Access.
    location str
    The Azure Region where the Disk Access should exist. Changing this forces a new Disk to be created.
    name str
    The name which should be used for this Disk Access. Changing this forces a new Disk Access to be created.
    resource_group_name str
    The name of the Resource Group where the Disk Access should exist. Changing this forces a new Disk Access to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Disk Access.
    location String
    The Azure Region where the Disk Access should exist. Changing this forces a new Disk to be created.
    name String
    The name which should be used for this Disk Access. Changing this forces a new Disk Access to be created.
    resourceGroupName String
    The name of the Resource Group where the Disk Access should exist. Changing this forces a new Disk Access to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Disk Access.

    Import

    Disk Access resource can be imported using the resource id, e.g.

    $ pulumi import azure:compute/diskAccess:DiskAccess example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Compute/diskAccesses/diskAccess1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi