Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. networkcloud
  5. getVolume
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.networkcloud.getVolume

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get properties of the provided volume.

    Uses Azure REST API version 2025-02-01.

    Other available API versions: 2023-10-01-preview, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native networkcloud [ApiVersion]. See the version guide for details.

    Using getVolume

    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 getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>
function getVolumeOutput(args: GetVolumeOutputArgs, opts?: InvokeOptions): Output<GetVolumeResult>
    def get_volume(resource_group_name: Optional[str] = None,
               volume_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(resource_group_name: Optional[pulumi.Input[str]] = None,
               volume_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVolumeResult]
    func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput

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

    public static class GetVolume 
{
    public static Task<GetVolumeResult> InvokeAsync(GetVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeResult> Invoke(GetVolumeInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:networkcloud:getVolume
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VolumeName string
    The name of the volume.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VolumeName string
    The name of the volume.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    volumeName String
    The name of the volume.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    volumeName string
    The name of the volume.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    volume_name str
    The name of the volume.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    volumeName String
    The name of the volume.

    getVolume Result

    The following output properties are available:

    AttachedTo List<string>
    The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
    AzureApiVersion string
    The Azure API version of the resource.
    DetailedStatus string
    The more detailed status of the volume.
    DetailedStatusMessage string
    The descriptive message about the current detailed status.
    Etag string
    Resource ETag.
    ExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the volume.
    SerialNumber string
    The unique identifier of the volume.
    SizeMiB double
    The size of the allocation for this volume in Mebibytes.
    SystemData Pulumi.AzureNative.NetworkCloud.Outputs.SystemDataResponse
    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"
    Tags Dictionary<string, string>
    Resource tags.
    AttachedTo []string
    The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
    AzureApiVersion string
    The Azure API version of the resource.
    DetailedStatus string
    The more detailed status of the volume.
    DetailedStatusMessage string
    The descriptive message about the current detailed status.
    Etag string
    Resource ETag.
    ExtendedLocation ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the volume.
    SerialNumber string
    The unique identifier of the volume.
    SizeMiB float64
    The size of the allocation for this volume in Mebibytes.
    SystemData SystemDataResponse
    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"
    Tags map[string]string
    Resource tags.
    attachedTo List<String>
    The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
    azureApiVersion String
    The Azure API version of the resource.
    detailedStatus String
    The more detailed status of the volume.
    detailedStatusMessage String
    The descriptive message about the current detailed status.
    etag String
    Resource ETag.
    extendedLocation ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the volume.
    serialNumber String
    The unique identifier of the volume.
    sizeMiB Double
    The size of the allocation for this volume in Mebibytes.
    systemData SystemDataResponse
    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"
    tags Map<String,String>
    Resource tags.
    attachedTo string[]
    The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
    azureApiVersion string
    The Azure API version of the resource.
    detailedStatus string
    The more detailed status of the volume.
    detailedStatusMessage string
    The descriptive message about the current detailed status.
    etag string
    Resource ETag.
    extendedLocation ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    The provisioning state of the volume.
    serialNumber string
    The unique identifier of the volume.
    sizeMiB number
    The size of the allocation for this volume in Mebibytes.
    systemData SystemDataResponse
    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"
    tags {[key: string]: string}
    Resource tags.
    attached_to Sequence[str]
    The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
    azure_api_version str
    The Azure API version of the resource.
    detailed_status str
    The more detailed status of the volume.
    detailed_status_message str
    The descriptive message about the current detailed status.
    etag str
    Resource ETag.
    extended_location ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    The provisioning state of the volume.
    serial_number str
    The unique identifier of the volume.
    size_mi_b float
    The size of the allocation for this volume in Mebibytes.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Mapping[str, str]
    Resource tags.
    attachedTo List<String>
    The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
    azureApiVersion String
    The Azure API version of the resource.
    detailedStatus String
    The more detailed status of the volume.
    detailedStatusMessage String
    The descriptive message about the current detailed status.
    etag String
    Resource ETag.
    extendedLocation Property Map
    The extended location of the cluster associated with the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the volume.
    serialNumber String
    The unique identifier of the volume.
    sizeMiB Number
    The size of the allocation for this volume in Mebibytes.
    systemData Property Map
    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"
    tags Map<String>
    Resource tags.

    Supporting Types

    ExtendedLocationResponse

    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type String
    The extended location type, for example, CustomLocation.
    name string
    The resource ID of the extended location on which the resource will be created.
    type string
    The extended location type, for example, CustomLocation.
    name str
    The resource ID of the extended location on which the resource will be created.
    type str
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type String
    The extended location type, for example, CustomLocation.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native