Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VolumeResourceDescription

Package version

interface

An interface representing VolumeResourceDescription. This type describes a volume resource.

extends

TrackedResource

Hierarchy

Index

Properties

Properties

Optional azureFileParameters

azureFileParameters: VolumeProviderParametersAzureFile
member

{VolumeProviderParametersAzureFile} [azureFileParameters] This type describes a volume provided by an Azure Files file share.

Optional description

description: undefined | string
member

{string} [description] User readable description of the volume.

Optional id

id: undefined | string
member

{string} [id] Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string
member

{string} location The geo-location where the resource lives

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string
member

{string} [provisioningState] State of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: ResourceStatus
member

{ResourceStatus} [status] Status of the volume. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string
member

{string} [statusDetails] Gives additional information about the current status of the volume. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

Optional type

type: undefined | string
member

{string} [type] The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc