Microsoft.AzureStackHCI (preview:2024-10-01)

2025/01/16 • 65 new methods

VirtualMachineInstances_List (new)
Description :  Lists all of the virtual machine instances within the specified parent resource.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VirtualMachineInstance items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hardwareProfile:
{
Description: HardwareProfile - Specifies the hardware settings for the virtual machine instance. ,
Required: False ,
}
{
vmSize:
{
Description: Enum of VM Sizes ,
Enum:
{
Default: Default virtual machine size ,
Standard_A2_v2: Standard A2 v2 virtual machine size ,
Standard_A4_v2: Standard A4 v2 virtual machine size ,
Standard_D2s_v3: Standard D2s v3 virtual machine size ,
Standard_D4s_v3: Standard D4s v3 virtual machine size ,
Standard_D8s_v3: Standard D8s v3 virtual machine size ,
Standard_D16s_v3: Standard D16s v3 virtual machine size ,
Standard_D32s_v3: Standard D32s v3 virtual machine size ,
Standard_DS2_v2: Standard DS2 v2 virtual machine size ,
Standard_DS3_v2: Standard DS3 v2 virtual machine size ,
Standard_DS4_v2: Standard DS4 v2 virtual machine size ,
Standard_DS5_v2: Standard DS5 v2 virtual machine size ,
Standard_DS13_v2: Standard DS13 v2 virtual machine size ,
Standard_K8S_v1: Standard K8S v1 virtual machine size ,
Standard_K8S2_v1: Standard K8S2 v1 virtual machine size ,
Standard_K8S3_v1: Standard K8S3 v1 virtual machine size ,
Standard_K8S4_v1: Standard K8S4 v1 virtual machine size ,
Standard_NK6: Standard NK6 virtual machine size ,
Standard_NK12: Standard NK12 virtual machine size ,
Standard_NV6: Standard NV6 virtual machine size ,
Standard_NV12: Standard NV12 virtual machine size ,
Standard_K8S5_v1: Standard K8S5 v1 virtual machine size ,
Custom: Custom virtual machine size ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: number of processors for the virtual machine instance ,
Format: int32 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: RAM in MB for the virtual machine instance ,
Format: int64 ,
Required: False ,
}
integer ,
dynamicMemoryConfig:
{
Description: Dynamic memory config ,
Required: False ,
}
{
maximumMemoryMB:
{
Description: Maximum memory in MB ,
Format: int64 ,
Required: False ,
}
integer ,
minimumMemoryMB:
{
Description: Minimum memory in MB ,
Format: int64 ,
Required: False ,
}
integer ,
targetMemoryBuffer:
{
Description: Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
virtualMachineGPUs:
{
Description: virtualMachineGPUs - list of gpus to be attached to the virtual machine instance ,
Required: False ,
}
[
{
assignmentType:
{
Description: GPU assignment type ,
Enum:
{
GpuDDA: Attach Graphics Processing Unit (GPU) using Discrete Device Assignment (DDA) ,
GpuP: Attach Graphics Processing Unit (GPU) using GPU Partitioning ,
}
,
Required: True ,
}
enum ,
partitionSizeMB:
{
Description: Size of gpu partition in MB for GPU-P ,
Format: int64 ,
Required: False ,
}
integer ,
gpuName:
{
Description: Name of the GPU ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkProfile:
{
Description: NetworkProfile - describes the network configuration the virtual machine instance ,
Required: False ,
}
{
networkInterfaces:
{
Description: NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
osProfile:
{
Description: OsProfile - describes the configuration of the operating system and sets login data ,
Required: False ,
}
{
adminPassword:
{
Description: AdminPassword - admin password ,
Format: password ,
Required: False ,
}
string ,
adminUsername:
{
Description: AdminUsername - admin username ,
Required: False ,
}
string ,
computerName:
{
Description: ComputerName - name of the compute ,
Required: False ,
}
string ,
linuxConfiguration:
{
Description: LinuxConfiguration - linux specific configuration values for the virtual machine instance ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: DisablePasswordAuthentication - whether password authentication should be disabled ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
windowsConfiguration:
{
Description: Windows Configuration for the virtual machine instance ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether to EnableAutomaticUpdates on the machine ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for Windows OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
timeZone:
{
Description: TimeZone for the virtual machine instance ,
Required: False ,
}
string ,
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
}
,
securityProfile:
{
Description: SecurityProfile - Specifies the security settings for the virtual machine instance. ,
Required: False ,
}
{
enableTPM:
{
Description: Enable TPM flag ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Uefi settings of the virtual machine instance ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine instance. ,
Required: False ,
}
boolean ,
}
,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function. ,
Enum:
{
TrustedLaunch: Trusted Launch security type ,
ConfidentialVM: Confidential VM security type ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: StorageProfile - contains information about the disks and storage information for the virtual machine instance ,
Required: False ,
}
{
dataDisks:
{
Description: adds data disks to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
imageReference:
{
Description: Which Image to use for the virtual machine instance ,
Required: False ,
}
{
id:
{
Description: The ARM ID for an image resource used by the virtual machine instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: VHD to attach as OS disk ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux. ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. NOTE: It can be set for only Confidential VMs. ,
Enum:
{
NonPersistedTPM: Non-persisted TPM encryption type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
vmConfigStoragePathId:
{
Description: Id of the storage container that hosts the VM configuration file ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
httpProxyConfig:
{
Description: HTTP Proxy configuration for the VM. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Format: password ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Format: password ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
vmAgent:
{
Description: The VM Config Agent running on the virtual machine. ,
Required: False ,
}
{
vmConfigAgentVersion:
{
Description: The VM Config Agent full version. ,
Required: False ,
}
string ,
statuses:
{
Description: The resource status information. ,
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: Informational status level ,
Warning: Warning status level ,
Error: Error status level ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
status:
{
Description: The observed state of virtual machine instances ,
Required: False ,
}
{
errorCode:
{
Description: VirtualMachine provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the virtual machine instance ,
Enum:
{
Deallocated: Virtual machine deallocated ,
Deallocating: Virtual machine deallocating ,
Running: Virtual machine running ,
Starting: Virtual machine starting ,
Stopped: Virtual machine stopped ,
Stopping: Virtual machine stopping ,
Paused: Virtual machine paused ,
Saved: Virtual machine Saved, ,
Unknown: Power state of the virtual machine is unknown ,
}
,
Required: False ,
}
enum ,
provisioningStatus:
{
Description: Provisioning status of the virtual machine instance ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual machine instance ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
guestAgentInstallStatus:
{
Description: Guest agent install status. ,
Required: False ,
}
{
vmUuid:
{
Description: Specifies the VM's unique SMBIOS ID. ,
Required: False ,
}
string ,
status:
{
Description: The installation status of the hybrid machine agent installation. ,
Enum:
{
Succeeded: Installation succeeded ,
InProgress: Installation in progress ,
Failed: Installation failed ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
vmId:
{
Description: Unique identifier for the vm resource. ,
Required: False ,
}
string ,
resourceUid:
{
Description: Unique identifier defined by ARC to identify the guest of the VM. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Get (new)
Description :  Gets a virtual machine instance
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hardwareProfile:
{
Description: HardwareProfile - Specifies the hardware settings for the virtual machine instance. ,
Required: False ,
}
{
vmSize:
{
Description: Enum of VM Sizes ,
Enum:
{
Default: Default virtual machine size ,
Standard_A2_v2: Standard A2 v2 virtual machine size ,
Standard_A4_v2: Standard A4 v2 virtual machine size ,
Standard_D2s_v3: Standard D2s v3 virtual machine size ,
Standard_D4s_v3: Standard D4s v3 virtual machine size ,
Standard_D8s_v3: Standard D8s v3 virtual machine size ,
Standard_D16s_v3: Standard D16s v3 virtual machine size ,
Standard_D32s_v3: Standard D32s v3 virtual machine size ,
Standard_DS2_v2: Standard DS2 v2 virtual machine size ,
Standard_DS3_v2: Standard DS3 v2 virtual machine size ,
Standard_DS4_v2: Standard DS4 v2 virtual machine size ,
Standard_DS5_v2: Standard DS5 v2 virtual machine size ,
Standard_DS13_v2: Standard DS13 v2 virtual machine size ,
Standard_K8S_v1: Standard K8S v1 virtual machine size ,
Standard_K8S2_v1: Standard K8S2 v1 virtual machine size ,
Standard_K8S3_v1: Standard K8S3 v1 virtual machine size ,
Standard_K8S4_v1: Standard K8S4 v1 virtual machine size ,
Standard_NK6: Standard NK6 virtual machine size ,
Standard_NK12: Standard NK12 virtual machine size ,
Standard_NV6: Standard NV6 virtual machine size ,
Standard_NV12: Standard NV12 virtual machine size ,
Standard_K8S5_v1: Standard K8S5 v1 virtual machine size ,
Custom: Custom virtual machine size ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: number of processors for the virtual machine instance ,
Format: int32 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: RAM in MB for the virtual machine instance ,
Format: int64 ,
Required: False ,
}
integer ,
dynamicMemoryConfig:
{
Description: Dynamic memory config ,
Required: False ,
}
{
maximumMemoryMB:
{
Description: Maximum memory in MB ,
Format: int64 ,
Required: False ,
}
integer ,
minimumMemoryMB:
{
Description: Minimum memory in MB ,
Format: int64 ,
Required: False ,
}
integer ,
targetMemoryBuffer:
{
Description: Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
virtualMachineGPUs:
{
Description: virtualMachineGPUs - list of gpus to be attached to the virtual machine instance ,
Required: False ,
}
[
{
assignmentType:
{
Description: GPU assignment type ,
Enum:
{
GpuDDA: Attach Graphics Processing Unit (GPU) using Discrete Device Assignment (DDA) ,
GpuP: Attach Graphics Processing Unit (GPU) using GPU Partitioning ,
}
,
Required: True ,
}
enum ,
partitionSizeMB:
{
Description: Size of gpu partition in MB for GPU-P ,
Format: int64 ,
Required: False ,
}
integer ,
gpuName:
{
Description: Name of the GPU ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkProfile:
{
Description: NetworkProfile - describes the network configuration the virtual machine instance ,
Required: False ,
}
{
networkInterfaces:
{
Description: NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
osProfile:
{
Description: OsProfile - describes the configuration of the operating system and sets login data ,
Required: False ,
}
{
adminPassword:
{
Description: AdminPassword - admin password ,
Format: password ,
Required: False ,
}
string ,
adminUsername:
{
Description: AdminUsername - admin username ,
Required: False ,
}
string ,
computerName:
{
Description: ComputerName - name of the compute ,
Required: False ,
}
string ,
linuxConfiguration:
{
Description: LinuxConfiguration - linux specific configuration values for the virtual machine instance ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: DisablePasswordAuthentication - whether password authentication should be disabled ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
windowsConfiguration:
{
Description: Windows Configuration for the virtual machine instance ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether to EnableAutomaticUpdates on the machine ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for Windows OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
timeZone:
{
Description: TimeZone for the virtual machine instance ,
Required: False ,
}
string ,
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
}
,
securityProfile:
{
Description: SecurityProfile - Specifies the security settings for the virtual machine instance. ,
Required: False ,
}
{
enableTPM:
{
Description: Enable TPM flag ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Uefi settings of the virtual machine instance ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine instance. ,
Required: False ,
}
boolean ,
}
,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function. ,
Enum:
{
TrustedLaunch: Trusted Launch security type ,
ConfidentialVM: Confidential VM security type ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: StorageProfile - contains information about the disks and storage information for the virtual machine instance ,
Required: False ,
}
{
dataDisks:
{
Description: adds data disks to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
imageReference:
{
Description: Which Image to use for the virtual machine instance ,
Required: False ,
}
{
id:
{
Description: The ARM ID for an image resource used by the virtual machine instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: VHD to attach as OS disk ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux. ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. NOTE: It can be set for only Confidential VMs. ,
Enum:
{
NonPersistedTPM: Non-persisted TPM encryption type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
vmConfigStoragePathId:
{
Description: Id of the storage container that hosts the VM configuration file ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
httpProxyConfig:
{
Description: HTTP Proxy configuration for the VM. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Format: password ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Format: password ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
vmAgent:
{
Description: The VM Config Agent running on the virtual machine. ,
Required: False ,
}
{
vmConfigAgentVersion:
{
Description: The VM Config Agent full version. ,
Required: False ,
}
string ,
statuses:
{
Description: The resource status information. ,
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: Informational status level ,
Warning: Warning status level ,
Error: Error status level ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
status:
{
Description: The observed state of virtual machine instances ,
Required: False ,
}
{
errorCode:
{
Description: VirtualMachine provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the virtual machine instance ,
Enum:
{
Deallocated: Virtual machine deallocated ,
Deallocating: Virtual machine deallocating ,
Running: Virtual machine running ,
Starting: Virtual machine starting ,
Stopped: Virtual machine stopped ,
Stopping: Virtual machine stopping ,
Paused: Virtual machine paused ,
Saved: Virtual machine Saved, ,
Unknown: Power state of the virtual machine is unknown ,
}
,
Required: False ,
}
enum ,
provisioningStatus:
{
Description: Provisioning status of the virtual machine instance ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual machine instance ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
guestAgentInstallStatus:
{
Description: Guest agent install status. ,
Required: False ,
}
{
vmUuid:
{
Description: Specifies the VM's unique SMBIOS ID. ,
Required: False ,
}
string ,
status:
{
Description: The installation status of the hybrid machine agent installation. ,
Enum:
{
Succeeded: Installation succeeded ,
InProgress: Installation in progress ,
Failed: Installation failed ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
vmId:
{
Description: Unique identifier for the vm resource. ,
Required: False ,
}
string ,
resourceUid:
{
Description: Unique identifier defined by ARC to identify the guest of the VM. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_CreateOrUpdate (new)
Description :  The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hardwareProfile:
{
Description: HardwareProfile - Specifies the hardware settings for the virtual machine instance. ,
Required: False ,
}
{
vmSize:
{
Description: Enum of VM Sizes ,
Enum:
{
Default: Default virtual machine size ,
Standard_A2_v2: Standard A2 v2 virtual machine size ,
Standard_A4_v2: Standard A4 v2 virtual machine size ,
Standard_D2s_v3: Standard D2s v3 virtual machine size ,
Standard_D4s_v3: Standard D4s v3 virtual machine size ,
Standard_D8s_v3: Standard D8s v3 virtual machine size ,
Standard_D16s_v3: Standard D16s v3 virtual machine size ,
Standard_D32s_v3: Standard D32s v3 virtual machine size ,
Standard_DS2_v2: Standard DS2 v2 virtual machine size ,
Standard_DS3_v2: Standard DS3 v2 virtual machine size ,
Standard_DS4_v2: Standard DS4 v2 virtual machine size ,
Standard_DS5_v2: Standard DS5 v2 virtual machine size ,
Standard_DS13_v2: Standard DS13 v2 virtual machine size ,
Standard_K8S_v1: Standard K8S v1 virtual machine size ,
Standard_K8S2_v1: Standard K8S2 v1 virtual machine size ,
Standard_K8S3_v1: Standard K8S3 v1 virtual machine size ,
Standard_K8S4_v1: Standard K8S4 v1 virtual machine size ,
Standard_NK6: Standard NK6 virtual machine size ,
Standard_NK12: Standard NK12 virtual machine size ,
Standard_NV6: Standard NV6 virtual machine size ,
Standard_NV12: Standard NV12 virtual machine size ,
Standard_K8S5_v1: Standard K8S5 v1 virtual machine size ,
Custom: Custom virtual machine size ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: number of processors for the virtual machine instance ,
Format: int32 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: RAM in MB for the virtual machine instance ,
Format: int64 ,
Required: False ,
}
integer ,
dynamicMemoryConfig:
{
Description: Dynamic memory config ,
Required: False ,
}
{
maximumMemoryMB:
{
Description: Maximum memory in MB ,
Format: int64 ,
Required: False ,
}
integer ,
minimumMemoryMB:
{
Description: Minimum memory in MB ,
Format: int64 ,
Required: False ,
}
integer ,
targetMemoryBuffer:
{
Description: Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
virtualMachineGPUs:
{
Description: virtualMachineGPUs - list of gpus to be attached to the virtual machine instance ,
Required: False ,
}
[
{
assignmentType:
{
Description: GPU assignment type ,
Enum:
{
GpuDDA: Attach Graphics Processing Unit (GPU) using Discrete Device Assignment (DDA) ,
GpuP: Attach Graphics Processing Unit (GPU) using GPU Partitioning ,
}
,
Required: True ,
}
enum ,
partitionSizeMB:
{
Description: Size of gpu partition in MB for GPU-P ,
Format: int64 ,
Required: False ,
}
integer ,
gpuName:
{
Description: Name of the GPU ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkProfile:
{
Description: NetworkProfile - describes the network configuration the virtual machine instance ,
Required: False ,
}
{
networkInterfaces:
{
Description: NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
osProfile:
{
Description: OsProfile - describes the configuration of the operating system and sets login data ,
Required: False ,
}
{
adminPassword:
{
Description: AdminPassword - admin password ,
Format: password ,
Required: False ,
}
string ,
adminUsername:
{
Description: AdminUsername - admin username ,
Required: False ,
}
string ,
computerName:
{
Description: ComputerName - name of the compute ,
Required: False ,
}
string ,
linuxConfiguration:
{
Description: LinuxConfiguration - linux specific configuration values for the virtual machine instance ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: DisablePasswordAuthentication - whether password authentication should be disabled ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
windowsConfiguration:
{
Description: Windows Configuration for the virtual machine instance ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether to EnableAutomaticUpdates on the machine ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for Windows OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
timeZone:
{
Description: TimeZone for the virtual machine instance ,
Required: False ,
}
string ,
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
}
,
securityProfile:
{
Description: SecurityProfile - Specifies the security settings for the virtual machine instance. ,
Required: False ,
}
{
enableTPM:
{
Description: Enable TPM flag ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Uefi settings of the virtual machine instance ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine instance. ,
Required: False ,
}
boolean ,
}
,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function. ,
Enum:
{
TrustedLaunch: Trusted Launch security type ,
ConfidentialVM: Confidential VM security type ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: StorageProfile - contains information about the disks and storage information for the virtual machine instance ,
Required: False ,
}
{
dataDisks:
{
Description: adds data disks to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
imageReference:
{
Description: Which Image to use for the virtual machine instance ,
Required: False ,
}
{
id:
{
Description: The ARM ID for an image resource used by the virtual machine instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: VHD to attach as OS disk ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux. ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. NOTE: It can be set for only Confidential VMs. ,
Enum:
{
NonPersistedTPM: Non-persisted TPM encryption type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
vmConfigStoragePathId:
{
Description: Id of the storage container that hosts the VM configuration file ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
httpProxyConfig:
{
Description: HTTP Proxy configuration for the VM. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Format: password ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Format: password ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
vmAgent:
{
Description: The VM Config Agent running on the virtual machine. ,
Required: False ,
}
{
vmConfigAgentVersion:
{
Description: The VM Config Agent full version. ,
Required: False ,
}
string ,
statuses:
{
Description: The resource status information. ,
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: Informational status level ,
Warning: Warning status level ,
Error: Error status level ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
status:
{
Description: The observed state of virtual machine instances ,
Required: False ,
}
{
errorCode:
{
Description: VirtualMachine provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the virtual machine instance ,
Enum:
{
Deallocated: Virtual machine deallocated ,
Deallocating: Virtual machine deallocating ,
Running: Virtual machine running ,
Starting: Virtual machine starting ,
Stopped: Virtual machine stopped ,
Stopping: Virtual machine stopping ,
Paused: Virtual machine paused ,
Saved: Virtual machine Saved, ,
Unknown: Power state of the virtual machine is unknown ,
}
,
Required: False ,
}
enum ,
provisioningStatus:
{
Description: Provisioning status of the virtual machine instance ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual machine instance ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
guestAgentInstallStatus:
{
Description: Guest agent install status. ,
Required: False ,
}
{
vmUuid:
{
Description: Specifies the VM's unique SMBIOS ID. ,
Required: False ,
}
string ,
status:
{
Description: The installation status of the hybrid machine agent installation. ,
Enum:
{
Succeeded: Installation succeeded ,
InProgress: Installation in progress ,
Failed: Installation failed ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
vmId:
{
Description: Unique identifier for the vm resource. ,
Required: False ,
}
string ,
resourceUid:
{
Description: Unique identifier defined by ARC to identify the guest of the VM. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hardwareProfile:
{
Description: HardwareProfile - Specifies the hardware settings for the virtual machine instance. ,
Required: False ,
}
{
vmSize:
{
Description: Enum of VM Sizes ,
Enum:
{
Default: Default virtual machine size ,
Standard_A2_v2: Standard A2 v2 virtual machine size ,
Standard_A4_v2: Standard A4 v2 virtual machine size ,
Standard_D2s_v3: Standard D2s v3 virtual machine size ,
Standard_D4s_v3: Standard D4s v3 virtual machine size ,
Standard_D8s_v3: Standard D8s v3 virtual machine size ,
Standard_D16s_v3: Standard D16s v3 virtual machine size ,
Standard_D32s_v3: Standard D32s v3 virtual machine size ,
Standard_DS2_v2: Standard DS2 v2 virtual machine size ,
Standard_DS3_v2: Standard DS3 v2 virtual machine size ,
Standard_DS4_v2: Standard DS4 v2 virtual machine size ,
Standard_DS5_v2: Standard DS5 v2 virtual machine size ,
Standard_DS13_v2: Standard DS13 v2 virtual machine size ,
Standard_K8S_v1: Standard K8S v1 virtual machine size ,
Standard_K8S2_v1: Standard K8S2 v1 virtual machine size ,
Standard_K8S3_v1: Standard K8S3 v1 virtual machine size ,
Standard_K8S4_v1: Standard K8S4 v1 virtual machine size ,
Standard_NK6: Standard NK6 virtual machine size ,
Standard_NK12: Standard NK12 virtual machine size ,
Standard_NV6: Standard NV6 virtual machine size ,
Standard_NV12: Standard NV12 virtual machine size ,
Standard_K8S5_v1: Standard K8S5 v1 virtual machine size ,
Custom: Custom virtual machine size ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: number of processors for the virtual machine instance ,
Format: int32 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: RAM in MB for the virtual machine instance ,
Format: int64 ,
Required: False ,
}
integer ,
dynamicMemoryConfig:
{
Description: Dynamic memory config ,
Required: False ,
}
{
maximumMemoryMB:
{
Description: Maximum memory in MB ,
Format: int64 ,
Required: False ,
}
integer ,
minimumMemoryMB:
{
Description: Minimum memory in MB ,
Format: int64 ,
Required: False ,
}
integer ,
targetMemoryBuffer:
{
Description: Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
virtualMachineGPUs:
{
Description: virtualMachineGPUs - list of gpus to be attached to the virtual machine instance ,
Required: False ,
}
[
{
assignmentType:
{
Description: GPU assignment type ,
Enum:
{
GpuDDA: Attach Graphics Processing Unit (GPU) using Discrete Device Assignment (DDA) ,
GpuP: Attach Graphics Processing Unit (GPU) using GPU Partitioning ,
}
,
Required: True ,
}
enum ,
partitionSizeMB:
{
Description: Size of gpu partition in MB for GPU-P ,
Format: int64 ,
Required: False ,
}
integer ,
gpuName:
{
Description: Name of the GPU ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkProfile:
{
Description: NetworkProfile - describes the network configuration the virtual machine instance ,
Required: False ,
}
{
networkInterfaces:
{
Description: NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
osProfile:
{
Description: OsProfile - describes the configuration of the operating system and sets login data ,
Required: False ,
}
{
adminPassword:
{
Description: AdminPassword - admin password ,
Format: password ,
Required: False ,
}
string ,
adminUsername:
{
Description: AdminUsername - admin username ,
Required: False ,
}
string ,
computerName:
{
Description: ComputerName - name of the compute ,
Required: False ,
}
string ,
linuxConfiguration:
{
Description: LinuxConfiguration - linux specific configuration values for the virtual machine instance ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: DisablePasswordAuthentication - whether password authentication should be disabled ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
windowsConfiguration:
{
Description: Windows Configuration for the virtual machine instance ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether to EnableAutomaticUpdates on the machine ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for Windows OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
timeZone:
{
Description: TimeZone for the virtual machine instance ,
Required: False ,
}
string ,
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
}
,
securityProfile:
{
Description: SecurityProfile - Specifies the security settings for the virtual machine instance. ,
Required: False ,
}
{
enableTPM:
{
Description: Enable TPM flag ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Uefi settings of the virtual machine instance ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine instance. ,
Required: False ,
}
boolean ,
}
,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function. ,
Enum:
{
TrustedLaunch: Trusted Launch security type ,
ConfidentialVM: Confidential VM security type ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: StorageProfile - contains information about the disks and storage information for the virtual machine instance ,
Required: False ,
}
{
dataDisks:
{
Description: adds data disks to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
imageReference:
{
Description: Which Image to use for the virtual machine instance ,
Required: False ,
}
{
id:
{
Description: The ARM ID for an image resource used by the virtual machine instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: VHD to attach as OS disk ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux. ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. NOTE: It can be set for only Confidential VMs. ,
Enum:
{
NonPersistedTPM: Non-persisted TPM encryption type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
vmConfigStoragePathId:
{
Description: Id of the storage container that hosts the VM configuration file ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
httpProxyConfig:
{
Description: HTTP Proxy configuration for the VM. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Format: password ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Format: password ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
vmAgent:
{
Description: The VM Config Agent running on the virtual machine. ,
Required: False ,
}
{
vmConfigAgentVersion:
{
Description: The VM Config Agent full version. ,
Required: False ,
}
string ,
statuses:
{
Description: The resource status information. ,
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: Informational status level ,
Warning: Warning status level ,
Error: Error status level ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
status:
{
Description: The observed state of virtual machine instances ,
Required: False ,
}
{
errorCode:
{
Description: VirtualMachine provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the virtual machine instance ,
Enum:
{
Deallocated: Virtual machine deallocated ,
Deallocating: Virtual machine deallocating ,
Running: Virtual machine running ,
Starting: Virtual machine starting ,
Stopped: Virtual machine stopped ,
Stopping: Virtual machine stopping ,
Paused: Virtual machine paused ,
Saved: Virtual machine Saved, ,
Unknown: Power state of the virtual machine is unknown ,
}
,
Required: False ,
}
enum ,
provisioningStatus:
{
Description: Provisioning status of the virtual machine instance ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual machine instance ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
guestAgentInstallStatus:
{
Description: Guest agent install status. ,
Required: False ,
}
{
vmUuid:
{
Description: Specifies the VM's unique SMBIOS ID. ,
Required: False ,
}
string ,
status:
{
Description: The installation status of the hybrid machine agent installation. ,
Enum:
{
Succeeded: Installation succeeded ,
InProgress: Installation in progress ,
Failed: Installation failed ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
vmId:
{
Description: Unique identifier for the vm resource. ,
Required: False ,
}
string ,
resourceUid:
{
Description: Unique identifier defined by ARC to identify the guest of the VM. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The virtual machine instance resource definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hardwareProfile:
{
Description: HardwareProfile - Specifies the hardware settings for the virtual machine instance. ,
Required: False ,
}
{
vmSize:
{
Description: Enum of VM Sizes ,
Enum:
{
Default: Default virtual machine size ,
Standard_A2_v2: Standard A2 v2 virtual machine size ,
Standard_A4_v2: Standard A4 v2 virtual machine size ,
Standard_D2s_v3: Standard D2s v3 virtual machine size ,
Standard_D4s_v3: Standard D4s v3 virtual machine size ,
Standard_D8s_v3: Standard D8s v3 virtual machine size ,
Standard_D16s_v3: Standard D16s v3 virtual machine size ,
Standard_D32s_v3: Standard D32s v3 virtual machine size ,
Standard_DS2_v2: Standard DS2 v2 virtual machine size ,
Standard_DS3_v2: Standard DS3 v2 virtual machine size ,
Standard_DS4_v2: Standard DS4 v2 virtual machine size ,
Standard_DS5_v2: Standard DS5 v2 virtual machine size ,
Standard_DS13_v2: Standard DS13 v2 virtual machine size ,
Standard_K8S_v1: Standard K8S v1 virtual machine size ,
Standard_K8S2_v1: Standard K8S2 v1 virtual machine size ,
Standard_K8S3_v1: Standard K8S3 v1 virtual machine size ,
Standard_K8S4_v1: Standard K8S4 v1 virtual machine size ,
Standard_NK6: Standard NK6 virtual machine size ,
Standard_NK12: Standard NK12 virtual machine size ,
Standard_NV6: Standard NV6 virtual machine size ,
Standard_NV12: Standard NV12 virtual machine size ,
Standard_K8S5_v1: Standard K8S5 v1 virtual machine size ,
Custom: Custom virtual machine size ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: number of processors for the virtual machine instance ,
Format: int32 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: RAM in MB for the virtual machine instance ,
Format: int64 ,
Required: False ,
}
integer ,
dynamicMemoryConfig:
{
Description: Dynamic memory config ,
Required: False ,
}
{
maximumMemoryMB:
{
Description: Maximum memory in MB ,
Format: int64 ,
Required: False ,
}
integer ,
minimumMemoryMB:
{
Description: Minimum memory in MB ,
Format: int64 ,
Required: False ,
}
integer ,
targetMemoryBuffer:
{
Description: Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
virtualMachineGPUs:
{
Description: virtualMachineGPUs - list of gpus to be attached to the virtual machine instance ,
Required: False ,
}
[
{
assignmentType:
{
Description: GPU assignment type ,
Enum:
{
GpuDDA: Attach Graphics Processing Unit (GPU) using Discrete Device Assignment (DDA) ,
GpuP: Attach Graphics Processing Unit (GPU) using GPU Partitioning ,
}
,
Required: True ,
}
enum ,
partitionSizeMB:
{
Description: Size of gpu partition in MB for GPU-P ,
Format: int64 ,
Required: False ,
}
integer ,
gpuName:
{
Description: Name of the GPU ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkProfile:
{
Description: NetworkProfile - describes the network configuration the virtual machine instance ,
Required: False ,
}
{
networkInterfaces:
{
Description: NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
osProfile:
{
Description: OsProfile - describes the configuration of the operating system and sets login data ,
Required: False ,
}
{
adminPassword:
{
Description: AdminPassword - admin password ,
Format: password ,
Required: False ,
}
string ,
adminUsername:
{
Description: AdminUsername - admin username ,
Required: False ,
}
string ,
computerName:
{
Description: ComputerName - name of the compute ,
Required: False ,
}
string ,
linuxConfiguration:
{
Description: LinuxConfiguration - linux specific configuration values for the virtual machine instance ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: DisablePasswordAuthentication - whether password authentication should be disabled ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
windowsConfiguration:
{
Description: Windows Configuration for the virtual machine instance ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether to EnableAutomaticUpdates on the machine ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for Windows OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
timeZone:
{
Description: TimeZone for the virtual machine instance ,
Required: False ,
}
string ,
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
}
,
securityProfile:
{
Description: SecurityProfile - Specifies the security settings for the virtual machine instance. ,
Required: False ,
}
{
enableTPM:
{
Description: Enable TPM flag ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Uefi settings of the virtual machine instance ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine instance. ,
Required: False ,
}
boolean ,
}
,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function. ,
Enum:
{
TrustedLaunch: Trusted Launch security type ,
ConfidentialVM: Confidential VM security type ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: StorageProfile - contains information about the disks and storage information for the virtual machine instance ,
Required: False ,
}
{
dataDisks:
{
Description: adds data disks to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
imageReference:
{
Description: Which Image to use for the virtual machine instance ,
Required: False ,
}
{
id:
{
Description: The ARM ID for an image resource used by the virtual machine instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: VHD to attach as OS disk ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux. ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. NOTE: It can be set for only Confidential VMs. ,
Enum:
{
NonPersistedTPM: Non-persisted TPM encryption type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
vmConfigStoragePathId:
{
Description: Id of the storage container that hosts the VM configuration file ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
httpProxyConfig:
{
Description: HTTP Proxy configuration for the VM. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Format: password ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Format: password ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
vmAgent:
{
Description: The VM Config Agent running on the virtual machine. ,
Required: False ,
}
{
vmConfigAgentVersion:
{
Description: The VM Config Agent full version. ,
Required: False ,
}
string ,
statuses:
{
Description: The resource status information. ,
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: Informational status level ,
Warning: Warning status level ,
Error: Error status level ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
status:
{
Description: The observed state of virtual machine instances ,
Required: False ,
}
{
errorCode:
{
Description: VirtualMachine provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the virtual machine instance ,
Enum:
{
Deallocated: Virtual machine deallocated ,
Deallocating: Virtual machine deallocating ,
Running: Virtual machine running ,
Starting: Virtual machine starting ,
Stopped: Virtual machine stopped ,
Stopping: Virtual machine stopping ,
Paused: Virtual machine paused ,
Saved: Virtual machine Saved, ,
Unknown: Power state of the virtual machine is unknown ,
}
,
Required: False ,
}
enum ,
provisioningStatus:
{
Description: Provisioning status of the virtual machine instance ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual machine instance ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
guestAgentInstallStatus:
{
Description: Guest agent install status. ,
Required: False ,
}
{
vmUuid:
{
Description: Specifies the VM's unique SMBIOS ID. ,
Required: False ,
}
string ,
status:
{
Description: The installation status of the hybrid machine agent installation. ,
Enum:
{
Succeeded: Installation succeeded ,
InProgress: Installation in progress ,
Failed: Installation failed ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
vmId:
{
Description: Unique identifier for the vm resource. ,
Required: False ,
}
string ,
resourceUid:
{
Description: Unique identifier defined by ARC to identify the guest of the VM. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Update (new)
Description :  The operation to update a virtual machine instance.
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: Defines the resource properties for the update. ,
Required: False ,
}
{
hardwareProfile:
{
Description: HardwareProfile - Specifies the hardware settings for the virtual machine instance. ,
Required: False ,
}
{
vmSize:
{
Description: VM Size Enum ,
Enum:
{
Default: Default virtual machine size ,
Standard_A2_v2: Standard A2 v2 virtual machine size ,
Standard_A4_v2: Standard A4 v2 virtual machine size ,
Standard_D2s_v3: Standard D2s v3 virtual machine size ,
Standard_D4s_v3: Standard D4s v3 virtual machine size ,
Standard_D8s_v3: Standard D8s v3 virtual machine size ,
Standard_D16s_v3: Standard D16s v3 virtual machine size ,
Standard_D32s_v3: Standard D32s v3 virtual machine size ,
Standard_DS2_v2: Standard DS2 v2 virtual machine size ,
Standard_DS3_v2: Standard DS3 v2 virtual machine size ,
Standard_DS4_v2: Standard DS4 v2 virtual machine size ,
Standard_DS5_v2: Standard DS5 v2 virtual machine size ,
Standard_DS13_v2: Standard DS13 v2 virtual machine size ,
Standard_K8S_v1: Standard K8S v1 virtual machine size ,
Standard_K8S2_v1: Standard K8S2 v1 virtual machine size ,
Standard_K8S3_v1: Standard K8S3 v1 virtual machine size ,
Standard_K8S4_v1: Standard K8S4 v1 virtual machine size ,
Standard_NK6: Standard NK6 virtual machine size ,
Standard_NK12: Standard NK12 virtual machine size ,
Standard_NV6: Standard NV6 virtual machine size ,
Standard_NV12: Standard NV12 virtual machine size ,
Standard_K8S5_v1: Standard K8S5 v1 virtual machine size ,
Custom: Custom virtual machine size ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: number of processors for the virtual machine instance ,
Format: int32 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: RAM in MB for the virtual machine instance ,
Format: int64 ,
Required: False ,
}
integer ,
virtualMachineGPUs:
{
Description: virtualMachineGPUs - updated list of GPUs on the virtual machine instance ,
Required: False ,
}
[
{
assignmentType:
{
Description: GPU assignment type ,
Enum:
{
GpuDDA: Attach Graphics Processing Unit (GPU) using Discrete Device Assignment (DDA) ,
GpuP: Attach Graphics Processing Unit (GPU) using GPU Partitioning ,
}
,
Required: True ,
}
enum ,
partitionSizeMB:
{
Description: Size of gpu partition in MB for GPU-P ,
Format: int64 ,
Required: False ,
}
integer ,
gpuName:
{
Description: Name of the GPU ,
Required: False ,
}
string ,
}
,
]
,
}
,
storageProfile:
{
Description: StorageProfile - Specifies the storage settings for the virtual machine instance. ,
Required: False ,
}
{
dataDisks:
{
Description: adds data disks to the virtual machine instance for the update call ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkProfile:
{
Description: NetworkProfile - describes the network update configuration the virtual machine instance ,
Required: False ,
}
{
networkInterfaces:
{
Description: NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
osProfile:
{
Description: OsProfile - describes the update configuration of the operating system ,
Required: False ,
}
{
computerName:
{
Description: ComputerName - name of the computer ,
Required: False ,
}
string ,
linuxConfiguration:
{
Description: Linux configuration properties ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
windowsConfiguration:
{
Description: Windows configuration properties ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hardwareProfile:
{
Description: HardwareProfile - Specifies the hardware settings for the virtual machine instance. ,
Required: False ,
}
{
vmSize:
{
Description: Enum of VM Sizes ,
Enum:
{
Default: Default virtual machine size ,
Standard_A2_v2: Standard A2 v2 virtual machine size ,
Standard_A4_v2: Standard A4 v2 virtual machine size ,
Standard_D2s_v3: Standard D2s v3 virtual machine size ,
Standard_D4s_v3: Standard D4s v3 virtual machine size ,
Standard_D8s_v3: Standard D8s v3 virtual machine size ,
Standard_D16s_v3: Standard D16s v3 virtual machine size ,
Standard_D32s_v3: Standard D32s v3 virtual machine size ,
Standard_DS2_v2: Standard DS2 v2 virtual machine size ,
Standard_DS3_v2: Standard DS3 v2 virtual machine size ,
Standard_DS4_v2: Standard DS4 v2 virtual machine size ,
Standard_DS5_v2: Standard DS5 v2 virtual machine size ,
Standard_DS13_v2: Standard DS13 v2 virtual machine size ,
Standard_K8S_v1: Standard K8S v1 virtual machine size ,
Standard_K8S2_v1: Standard K8S2 v1 virtual machine size ,
Standard_K8S3_v1: Standard K8S3 v1 virtual machine size ,
Standard_K8S4_v1: Standard K8S4 v1 virtual machine size ,
Standard_NK6: Standard NK6 virtual machine size ,
Standard_NK12: Standard NK12 virtual machine size ,
Standard_NV6: Standard NV6 virtual machine size ,
Standard_NV12: Standard NV12 virtual machine size ,
Standard_K8S5_v1: Standard K8S5 v1 virtual machine size ,
Custom: Custom virtual machine size ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: number of processors for the virtual machine instance ,
Format: int32 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: RAM in MB for the virtual machine instance ,
Format: int64 ,
Required: False ,
}
integer ,
dynamicMemoryConfig:
{
Description: Dynamic memory config ,
Required: False ,
}
{
maximumMemoryMB:
{
Description: Maximum memory in MB ,
Format: int64 ,
Required: False ,
}
integer ,
minimumMemoryMB:
{
Description: Minimum memory in MB ,
Format: int64 ,
Required: False ,
}
integer ,
targetMemoryBuffer:
{
Description: Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
virtualMachineGPUs:
{
Description: virtualMachineGPUs - list of gpus to be attached to the virtual machine instance ,
Required: False ,
}
[
{
assignmentType:
{
Description: GPU assignment type ,
Enum:
{
GpuDDA: Attach Graphics Processing Unit (GPU) using Discrete Device Assignment (DDA) ,
GpuP: Attach Graphics Processing Unit (GPU) using GPU Partitioning ,
}
,
Required: True ,
}
enum ,
partitionSizeMB:
{
Description: Size of gpu partition in MB for GPU-P ,
Format: int64 ,
Required: False ,
}
integer ,
gpuName:
{
Description: Name of the GPU ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkProfile:
{
Description: NetworkProfile - describes the network configuration the virtual machine instance ,
Required: False ,
}
{
networkInterfaces:
{
Description: NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
osProfile:
{
Description: OsProfile - describes the configuration of the operating system and sets login data ,
Required: False ,
}
{
adminPassword:
{
Description: AdminPassword - admin password ,
Format: password ,
Required: False ,
}
string ,
adminUsername:
{
Description: AdminUsername - admin username ,
Required: False ,
}
string ,
computerName:
{
Description: ComputerName - name of the compute ,
Required: False ,
}
string ,
linuxConfiguration:
{
Description: LinuxConfiguration - linux specific configuration values for the virtual machine instance ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: DisablePasswordAuthentication - whether password authentication should be disabled ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
windowsConfiguration:
{
Description: Windows Configuration for the virtual machine instance ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether to EnableAutomaticUpdates on the machine ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for Windows OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
timeZone:
{
Description: TimeZone for the virtual machine instance ,
Required: False ,
}
string ,
provisionVMAgent:
{
Description: Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. ,
Required: False ,
}
boolean ,
provisionVMConfigAgent:
{
Description: Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. ,
Required: False ,
}
boolean ,
}
,
}
,
securityProfile:
{
Description: SecurityProfile - Specifies the security settings for the virtual machine instance. ,
Required: False ,
}
{
enableTPM:
{
Description: Enable TPM flag ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Uefi settings of the virtual machine instance ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine instance. ,
Required: False ,
}
boolean ,
}
,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function. ,
Enum:
{
TrustedLaunch: Trusted Launch security type ,
ConfidentialVM: Confidential VM security type ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: StorageProfile - contains information about the disks and storage information for the virtual machine instance ,
Required: False ,
}
{
dataDisks:
{
Description: adds data disks to the virtual machine instance ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
imageReference:
{
Description: Which Image to use for the virtual machine instance ,
Required: False ,
}
{
id:
{
Description: The ARM ID for an image resource used by the virtual machine instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: VHD to attach as OS disk ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux. ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. NOTE: It can be set for only Confidential VMs. ,
Enum:
{
NonPersistedTPM: Non-persisted TPM encryption type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
vmConfigStoragePathId:
{
Description: Id of the storage container that hosts the VM configuration file ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
httpProxyConfig:
{
Description: HTTP Proxy configuration for the VM. ,
Required: False ,
}
{
httpProxy:
{
Description: The HTTP proxy server endpoint to use. ,
Format: password ,
Required: False ,
}
string ,
httpsProxy:
{
Description: The HTTPS proxy server endpoint to use. ,
Format: password ,
Required: False ,
}
string ,
noProxy:
{
Description: The endpoints that should not go through proxy. ,
Required: False ,
}
[
string ,
]
,
trustedCa:
{
Description: Alternative CA cert to use for connecting to proxy servers. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
vmAgent:
{
Description: The VM Config Agent running on the virtual machine. ,
Required: False ,
}
{
vmConfigAgentVersion:
{
Description: The VM Config Agent full version. ,
Required: False ,
}
string ,
statuses:
{
Description: The resource status information. ,
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: Informational status level ,
Warning: Warning status level ,
Error: Error status level ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
status:
{
Description: The observed state of virtual machine instances ,
Required: False ,
}
{
errorCode:
{
Description: VirtualMachine provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
powerState:
{
Description: The power state of the virtual machine instance ,
Enum:
{
Deallocated: Virtual machine deallocated ,
Deallocating: Virtual machine deallocating ,
Running: Virtual machine running ,
Starting: Virtual machine starting ,
Stopped: Virtual machine stopped ,
Stopping: Virtual machine stopping ,
Paused: Virtual machine paused ,
Saved: Virtual machine Saved, ,
Unknown: Power state of the virtual machine is unknown ,
}
,
Required: False ,
}
enum ,
provisioningStatus:
{
Description: Provisioning status of the virtual machine instance ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual machine instance ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
guestAgentInstallStatus:
{
Description: Guest agent install status. ,
Required: False ,
}
{
vmUuid:
{
Description: Specifies the VM's unique SMBIOS ID. ,
Required: False ,
}
string ,
status:
{
Description: The installation status of the hybrid machine agent installation. ,
Enum:
{
Succeeded: Installation succeeded ,
InProgress: Installation in progress ,
Failed: Installation failed ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
vmId:
{
Description: Unique identifier for the vm resource. ,
Required: False ,
}
string ,
resourceUid:
{
Description: Unique identifier defined by ARC to identify the guest of the VM. ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Delete (new)
Description :  The operation to delete a virtual machine instance.
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AttestationStatuses_Get (new)
Description :  Implements AttestationStatus GET method.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
attestSecureBootEnabled:
{
Description: The status of whether secure boot is enabled. ,
Enum:
{
Enabled: Secure boot enabled ,
Disabled: Secure boot disabled ,
Unknown: Secure boot status is unknown ,
}
,
Required: False ,
}
enum ,
attestationCertValidated:
{
Description: The status of whether attestation certificate is validated. ,
Enum:
{
Valid: Attestation certificate is valid ,
Invalid: Attestation certificate is invalid ,
Unknown: Attestation certificate status is unknown ,
}
,
Required: False ,
}
enum ,
bootIntegrityValidated:
{
Description: The status of whether the list of boot integrity properties is validated. ,
Enum:
{
Valid: Boot integrity properties are valid ,
Invalid: Boot integrity properties are invalid ,
Unknown: Boot integrity properties status is unknown ,
}
,
Required: False ,
}
enum ,
linuxKernelVersion:
{
Description: kernel version string for Linux VM. ,
Required: False ,
}
string ,
healthStatus:
{
Description: The health status of attestation validation and parsing ,
Enum:
{
Pending: Attestation validation and parsing pending ,
Healthy: Attestation validation and parsing healthy ,
Unhealthy: Attestation validation and parsing unhealthy ,
Unknown: Attestation validation and parsing status is unknown ,
}
,
Required: False ,
}
enum ,
timestamp:
{
Description: The time stamp of the last time attestation token is validated by relying party service. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message of attestation validation and parsing ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
attestHardwarePlatform:
{
Description: The hardware platform information from attestation token. This only applies to Confidential VM. ,
Enum:
{
SEVSNP: AttestHWPlatform is Secure Encrypted Virtualization Secure Nested Paging (SEVSNP) ,
Unknown: AttestHWPlatform is unknown ,
}
,
Required: False ,
}
enum ,
attestDiskSecurityEncryptionType:
{
Description: The managed disk security encryption type from attestation token. This only applies to Confidential VM. ,
Enum:
{
NonPersistedTPM: Disk security encryption type is non-persisted Trusted Platform Module (TPM) ,
Unknown: Disk security encryption type is unknown ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestAgents_ListByVirtualMachineInstance (new)
Description :  Returns the list of GuestAgent of the given vm.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The GuestAgent items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
credentials:
{
Description: Username / Password Credentials to provision guest agent. ,
Required: False ,
}
{
username:
{
Description: The username to connect with the guest. ,
Required: False ,
}
string ,
password:
{
Description: The password to connect with the guest. ,
Format: password ,
Required: False ,
}
string ,
}
,
provisioningAction:
{
Description: The guest agent provisioning action. ,
Enum:
{
install: Install guest agent ,
uninstall: Uninstall guest agent ,
repair: Repair guest agent ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The guest agent status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestAgents_Get (new)
Description :  Implements GuestAgent GET method.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
credentials:
{
Description: Username / Password Credentials to provision guest agent. ,
Required: False ,
}
{
username:
{
Description: The username to connect with the guest. ,
Required: False ,
}
string ,
password:
{
Description: The password to connect with the guest. ,
Format: password ,
Required: False ,
}
string ,
}
,
provisioningAction:
{
Description: The guest agent provisioning action. ,
Enum:
{
install: Install guest agent ,
uninstall: Uninstall guest agent ,
repair: Repair guest agent ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The guest agent status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestAgents_Create (new)
Description :  Create Or Update GuestAgent.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
credentials:
{
Description: Username / Password Credentials to provision guest agent. ,
Required: False ,
}
{
username:
{
Description: The username to connect with the guest. ,
Required: False ,
}
string ,
password:
{
Description: The password to connect with the guest. ,
Format: password ,
Required: False ,
}
string ,
}
,
provisioningAction:
{
Description: The guest agent provisioning action. ,
Enum:
{
install: Install guest agent ,
uninstall: Uninstall guest agent ,
repair: Repair guest agent ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The guest agent status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
credentials:
{
Description: Username / Password Credentials to provision guest agent. ,
Required: False ,
}
{
username:
{
Description: The username to connect with the guest. ,
Required: False ,
}
string ,
password:
{
Description: The password to connect with the guest. ,
Format: password ,
Required: False ,
}
string ,
}
,
provisioningAction:
{
Description: The guest agent provisioning action. ,
Enum:
{
install: Install guest agent ,
uninstall: Uninstall guest agent ,
repair: Repair guest agent ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The guest agent status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Defines the GuestAgent. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
credentials:
{
Description: Username / Password Credentials to provision guest agent. ,
Required: False ,
}
{
username:
{
Description: The username to connect with the guest. ,
Required: False ,
}
string ,
password:
{
Description: The password to connect with the guest. ,
Format: password ,
Required: False ,
}
string ,
}
,
provisioningAction:
{
Description: The guest agent provisioning action. ,
Enum:
{
install: Install guest agent ,
uninstall: Uninstall guest agent ,
repair: Repair guest agent ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The guest agent status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestAgents_Delete (new)
Description :  Implements GuestAgent DELETE method.
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridIdentityMetadata_ListByVirtualMachineInstance (new)
Description :  Returns the list of HybridIdentityMetadata of the given vm.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HybridIdentityMetadata items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceUid:
{
Description: The unique identifier for the resource. ,
Required: False ,
}
string ,
publicKey:
{
Description: The Public Key. ,
Required: False ,
}
string ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridIdentityMetadata_Get (new)
Description :  Implements HybridIdentityMetadata GET method.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceUid:
{
Description: The unique identifier for the resource. ,
Required: False ,
}
string ,
publicKey:
{
Description: The Public Key. ,
Required: False ,
}
string ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the virtual machine instance. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Pause (new)
Description :  The operation to pause a virtual machine instance.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/pause
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Restart (new)
Description :  The operation to restart a virtual machine instance.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Save (new)
Description :  The operation to save a virtual machine instance.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/save
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Start (new)
Description :  The operation to start a virtual machine instance.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Stop (new)
Description :  The operation to stop a virtual machine instance.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GalleryImages_ListAll (new)
Description :  Lists all of the gallery images in the specified subscription. Use the nextLink property in the response to get the next page of gallery images.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/galleryImages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The GalleryImage items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
imagePath:
{
Description: location of the image the gallery image should be created from ,
Format: password ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image ,
Required: False ,
}
{
username:
{
Description: Username for accessing image repository ,
Required: True ,
}
string ,
password:
{
Description: Password for accessing image repository ,
Format: password ,
Required: True ,
}
string ,
}
,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of gallery images ,
Required: False ,
}
{
errorCode:
{
Description: GalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: provisioning status of the gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sourceVirtualMachineId:
{
Description: Resource ID of the source virtual machine from whose OS disk the gallery image is created. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LogicalNetworks_ListAll (new)
Description :  Lists all of the logical networks in the specified subscription. Use the nextLink property in the response to get the next page of logical networks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/logicalNetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LogicalNetwork items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpOptions:
{
Description: DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options. ,
Required: False ,
}
{
dnsServers:
{
Description: The list of DNS servers IP addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
subnets:
{
Description: Subnet - list of subnets under the logical network ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
ipAllocationMethod:
{
Description: IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic' ,
Enum:
{
Dynamic: Dynamic IP allocation method ,
Static: Static IP allocation method ,
}
,
Required: False ,
}
enum ,
ipConfigurationReferences:
{
Description: IPConfigurationReferences - list of IPConfigurationReferences ,
Required: False ,
}
[
{
ID:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the logical network. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: Route table resource. ,
Required: False ,
}
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name - name of the subnet ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
ipPools:
{
Description: network associated pool of IP Addresses ,
Required: False ,
}
[
{
name:
{
Description: Name of the IP-Pool ,
Required: False ,
}
string ,
ipPoolType:
{
Description: Type of the IP Pool [vm, vippool] ,
Enum:
{
vm: Virtual Machine IP Pool ,
vippool: VIP Pool ,
}
,
Required: False ,
}
enum ,
start:
{
Description: Start of the IP address pool ,
Required: False ,
}
string ,
end:
{
Description: End of the IP address pool ,
Required: False ,
}
string ,
info:
{
Description: IPPool info ,
Required: False ,
}
{
used:
{
Description: Number of IP addresses allocated from the IP Pool ,
Required: False ,
}
string ,
available:
{
Description: Number of IP addresses available in the IP Pool ,
Required: False ,
}
string ,
}
,
}
,
]
,
vlan:
{
Description: Vlan to use for the subnet ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the logical network. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
vmSwitchName:
{
Description: name of the network switch to be used for VMs ,
Required: False ,
}
string ,
status:
{
Description: The observed state of logical networks ,
Required: False ,
}
{
errorCode:
{
Description: LogicalNetwork provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Logical network provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the logical network ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the logical network [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MarketplaceGalleryImages_ListAll (new)
Description :  Lists all of the marketplace gallery images in the specified subscription. Use the nextLink property in the response to get the next page of marketplace gallery images.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MarketplaceGalleryImage items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for marketplace gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the marketplace gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of marketplace gallery images ,
Required: False ,
}
{
errorCode:
{
Description: MarketplaceGalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of marketplace gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkInterfaces_ListAll (new)
Description :  Lists all of the network interfaces in the specified subscription. Use the nextLink property in the response to get the next page of network interfaces.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/networkInterfaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkInterface items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IPConfigurations - A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
properties:
{
Description: InterfaceIPConfigurationPropertiesFormat properties of IP configuration. ,
Required: False ,
}
{
gateway:
{
Description: Gateway for network interface ,
Required: False ,
}
string ,
prefixLength:
{
Description: prefixLength for network interface ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: PrivateIPAddress - Private IP address of the IP configuration. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet - Name of Subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
macAddress:
{
Description: MacAddress - The MAC address of the network interface. ,
Required: False ,
}
string ,
dnsSettings:
{
Description: DNS Settings for the interface ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS server IP Addresses for the interface ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the network interface. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of network interfaces ,
Required: False ,
}
{
errorCode:
{
Description: NetworkInterface provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Network interface provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the network interface ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the network interface [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the network interface. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityGroups_ListAll (new)
Description :  Gets all network security groups in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/networkSecurityGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkSecurityGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
networkInterfaces:
{
Description: A collection of references to network interfaces that are currently using this NSG. ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to logical networks that are currently using this NSG ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageContainers_ListAll (new)
Description :  Lists all of the storage containers in the specified subscription. Use the nextLink property in the response to get the next page of storage containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/storageContainers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The StorageContainer items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
path:
{
Description: Path of the storage container on the disk ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the storage container. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of storage containers ,
Required: False ,
}
{
errorCode:
{
Description: StorageContainer provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
availableSizeMB:
{
Description: Amount of space available on the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
containerSizeMB:
{
Description: Total size of the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningStatus:
{
Description: Storage container's provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the storage container ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the storage container [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualHardDisks_ListAll (new)
Description :  Lists all of the virtual hard disks in the specified subscription. Use the nextLink property in the response to get the next page of virtual hard disks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/virtualHardDisks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VirtualHardDisk items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
blockSizeBytes:
{
Description: Block size in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeGB:
{
Description: Size of the disk in GB ,
Format: int64 ,
Required: False ,
}
integer ,
dynamic:
{
Description: Boolean for enabling dynamic sizing on the virtual hard disk ,
Required: False ,
}
boolean ,
logicalSectorBytes:
{
Description: Logical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
physicalSectorBytes:
{
Description: Physical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
downloadUrl:
{
Description: URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly. ,
Format: password ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
diskFileFormat:
{
Description: The format of the actual VHD file [vhd, vhdx] ,
Enum:
{
vhdx: VHDX file format ,
vhd: VHD file format ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the virtual hard disk. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
containerId:
{
Description: Storage ContainerID of the storage container to be used for VHD ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The observed state of virtual hard disks ,
Required: False ,
}
{
errorCode:
{
Description: VirtualHardDisk provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of the vhd ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual hard disk ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the virtual hard disk ,
Required: False ,
}
{
downloadedSizeInMB:
{
Description: The downloaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
uploadStatus:
{
Description: The upload status of the virtual hard disk ,
Required: False ,
}
{
uploadedSizeInMB:
{
Description: The uploaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
errorCode:
{
Description: VirtualHardDisk upload error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive upload error message ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GalleryImages_ListByResourceGroup (new)
Description :  Lists all of the gallery images in the specified resource group. Use the nextLink property in the response to get the next page of gallery images.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The GalleryImage items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
imagePath:
{
Description: location of the image the gallery image should be created from ,
Format: password ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image ,
Required: False ,
}
{
username:
{
Description: Username for accessing image repository ,
Required: True ,
}
string ,
password:
{
Description: Password for accessing image repository ,
Format: password ,
Required: True ,
}
string ,
}
,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of gallery images ,
Required: False ,
}
{
errorCode:
{
Description: GalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: provisioning status of the gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sourceVirtualMachineId:
{
Description: Resource ID of the source virtual machine from whose OS disk the gallery image is created. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GalleryImages_Get (new)
Description :  Gets a gallery image
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages/{galleryImageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: Name of the gallery image ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
imagePath:
{
Description: location of the image the gallery image should be created from ,
Format: password ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image ,
Required: False ,
}
{
username:
{
Description: Username for accessing image repository ,
Required: True ,
}
string ,
password:
{
Description: Password for accessing image repository ,
Format: password ,
Required: True ,
}
string ,
}
,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of gallery images ,
Required: False ,
}
{
errorCode:
{
Description: GalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: provisioning status of the gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sourceVirtualMachineId:
{
Description: Resource ID of the source virtual machine from whose OS disk the gallery image is created. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GalleryImages_CreateOrUpdate (new)
Description :  The operation to create or update a gallery image. Please note some properties can be set only during gallery image creation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages/{galleryImageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: Name of the gallery image ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
imagePath:
{
Description: location of the image the gallery image should be created from ,
Format: password ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image ,
Required: False ,
}
{
username:
{
Description: Username for accessing image repository ,
Required: True ,
}
string ,
password:
{
Description: Password for accessing image repository ,
Format: password ,
Required: True ,
}
string ,
}
,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of gallery images ,
Required: False ,
}
{
errorCode:
{
Description: GalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: provisioning status of the gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sourceVirtualMachineId:
{
Description: Resource ID of the source virtual machine from whose OS disk the gallery image is created. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
imagePath:
{
Description: location of the image the gallery image should be created from ,
Format: password ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image ,
Required: False ,
}
{
username:
{
Description: Username for accessing image repository ,
Required: True ,
}
string ,
password:
{
Description: Password for accessing image repository ,
Format: password ,
Required: True ,
}
string ,
}
,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of gallery images ,
Required: False ,
}
{
errorCode:
{
Description: GalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: provisioning status of the gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sourceVirtualMachineId:
{
Description: Resource ID of the source virtual machine from whose OS disk the gallery image is created. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The gallery images resource definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
imagePath:
{
Description: location of the image the gallery image should be created from ,
Format: password ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image ,
Required: False ,
}
{
username:
{
Description: Username for accessing image repository ,
Required: True ,
}
string ,
password:
{
Description: Password for accessing image repository ,
Format: password ,
Required: True ,
}
string ,
}
,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of gallery images ,
Required: False ,
}
{
errorCode:
{
Description: GalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: provisioning status of the gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sourceVirtualMachineId:
{
Description: Resource ID of the source virtual machine from whose OS disk the gallery image is created. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GalleryImages_Update (new)
Description :  The operation to update a gallery image.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages/{galleryImageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: Name of the gallery image ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
imagePath:
{
Description: location of the image the gallery image should be created from ,
Format: password ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image ,
Required: False ,
}
{
username:
{
Description: Username for accessing image repository ,
Required: True ,
}
string ,
password:
{
Description: Password for accessing image repository ,
Format: password ,
Required: True ,
}
string ,
}
,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of gallery images ,
Required: False ,
}
{
errorCode:
{
Description: GalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: provisioning status of the gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sourceVirtualMachineId:
{
Description: Resource ID of the source virtual machine from whose OS disk the gallery image is created. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GalleryImages_Delete (new)
Description :  The operation to delete a gallery image.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages/{galleryImageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: Name of the gallery image ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LogicalNetworks_ListByResourceGroup (new)
Description :  Lists all of the logical networks in the specified resource group. Use the nextLink property in the response to get the next page of logical networks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LogicalNetwork items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpOptions:
{
Description: DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options. ,
Required: False ,
}
{
dnsServers:
{
Description: The list of DNS servers IP addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
subnets:
{
Description: Subnet - list of subnets under the logical network ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
ipAllocationMethod:
{
Description: IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic' ,
Enum:
{
Dynamic: Dynamic IP allocation method ,
Static: Static IP allocation method ,
}
,
Required: False ,
}
enum ,
ipConfigurationReferences:
{
Description: IPConfigurationReferences - list of IPConfigurationReferences ,
Required: False ,
}
[
{
ID:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the logical network. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: Route table resource. ,
Required: False ,
}
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name - name of the subnet ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
ipPools:
{
Description: network associated pool of IP Addresses ,
Required: False ,
}
[
{
name:
{
Description: Name of the IP-Pool ,
Required: False ,
}
string ,
ipPoolType:
{
Description: Type of the IP Pool [vm, vippool] ,
Enum:
{
vm: Virtual Machine IP Pool ,
vippool: VIP Pool ,
}
,
Required: False ,
}
enum ,
start:
{
Description: Start of the IP address pool ,
Required: False ,
}
string ,
end:
{
Description: End of the IP address pool ,
Required: False ,
}
string ,
info:
{
Description: IPPool info ,
Required: False ,
}
{
used:
{
Description: Number of IP addresses allocated from the IP Pool ,
Required: False ,
}
string ,
available:
{
Description: Number of IP addresses available in the IP Pool ,
Required: False ,
}
string ,
}
,
}
,
]
,
vlan:
{
Description: Vlan to use for the subnet ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the logical network. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
vmSwitchName:
{
Description: name of the network switch to be used for VMs ,
Required: False ,
}
string ,
status:
{
Description: The observed state of logical networks ,
Required: False ,
}
{
errorCode:
{
Description: LogicalNetwork provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Logical network provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the logical network ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the logical network [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LogicalNetworks_Get (new)
Description :  The operation to get a logical network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
logicalNetworkName:
{
Description: Name of the logical network ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpOptions:
{
Description: DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options. ,
Required: False ,
}
{
dnsServers:
{
Description: The list of DNS servers IP addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
subnets:
{
Description: Subnet - list of subnets under the logical network ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
ipAllocationMethod:
{
Description: IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic' ,
Enum:
{
Dynamic: Dynamic IP allocation method ,
Static: Static IP allocation method ,
}
,
Required: False ,
}
enum ,
ipConfigurationReferences:
{
Description: IPConfigurationReferences - list of IPConfigurationReferences ,
Required: False ,
}
[
{
ID:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the logical network. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: Route table resource. ,
Required: False ,
}
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name - name of the subnet ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
ipPools:
{
Description: network associated pool of IP Addresses ,
Required: False ,
}
[
{
name:
{
Description: Name of the IP-Pool ,
Required: False ,
}
string ,
ipPoolType:
{
Description: Type of the IP Pool [vm, vippool] ,
Enum:
{
vm: Virtual Machine IP Pool ,
vippool: VIP Pool ,
}
,
Required: False ,
}
enum ,
start:
{
Description: Start of the IP address pool ,
Required: False ,
}
string ,
end:
{
Description: End of the IP address pool ,
Required: False ,
}
string ,
info:
{
Description: IPPool info ,
Required: False ,
}
{
used:
{
Description: Number of IP addresses allocated from the IP Pool ,
Required: False ,
}
string ,
available:
{
Description: Number of IP addresses available in the IP Pool ,
Required: False ,
}
string ,
}
,
}
,
]
,
vlan:
{
Description: Vlan to use for the subnet ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the logical network. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
vmSwitchName:
{
Description: name of the network switch to be used for VMs ,
Required: False ,
}
string ,
status:
{
Description: The observed state of logical networks ,
Required: False ,
}
{
errorCode:
{
Description: LogicalNetwork provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Logical network provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the logical network ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the logical network [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LogicalNetworks_CreateOrUpdate (new)
Description :  The operation to create or update a logical network. Please note some properties can be set only during logical network creation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
logicalNetworkName:
{
Description: Name of the logical network ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpOptions:
{
Description: DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options. ,
Required: False ,
}
{
dnsServers:
{
Description: The list of DNS servers IP addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
subnets:
{
Description: Subnet - list of subnets under the logical network ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
ipAllocationMethod:
{
Description: IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic' ,
Enum:
{
Dynamic: Dynamic IP allocation method ,
Static: Static IP allocation method ,
}
,
Required: False ,
}
enum ,
ipConfigurationReferences:
{
Description: IPConfigurationReferences - list of IPConfigurationReferences ,
Required: False ,
}
[
{
ID:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the logical network. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: Route table resource. ,
Required: False ,
}
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name - name of the subnet ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
ipPools:
{
Description: network associated pool of IP Addresses ,
Required: False ,
}
[
{
name:
{
Description: Name of the IP-Pool ,
Required: False ,
}
string ,
ipPoolType:
{
Description: Type of the IP Pool [vm, vippool] ,
Enum:
{
vm: Virtual Machine IP Pool ,
vippool: VIP Pool ,
}
,
Required: False ,
}
enum ,
start:
{
Description: Start of the IP address pool ,
Required: False ,
}
string ,
end:
{
Description: End of the IP address pool ,
Required: False ,
}
string ,
info:
{
Description: IPPool info ,
Required: False ,
}
{
used:
{
Description: Number of IP addresses allocated from the IP Pool ,
Required: False ,
}
string ,
available:
{
Description: Number of IP addresses available in the IP Pool ,
Required: False ,
}
string ,
}
,
}
,
]
,
vlan:
{
Description: Vlan to use for the subnet ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the logical network. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
vmSwitchName:
{
Description: name of the network switch to be used for VMs ,
Required: False ,
}
string ,
status:
{
Description: The observed state of logical networks ,
Required: False ,
}
{
errorCode:
{
Description: LogicalNetwork provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Logical network provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the logical network ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the logical network [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpOptions:
{
Description: DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options. ,
Required: False ,
}
{
dnsServers:
{
Description: The list of DNS servers IP addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
subnets:
{
Description: Subnet - list of subnets under the logical network ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
ipAllocationMethod:
{
Description: IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic' ,
Enum:
{
Dynamic: Dynamic IP allocation method ,
Static: Static IP allocation method ,
}
,
Required: False ,
}
enum ,
ipConfigurationReferences:
{
Description: IPConfigurationReferences - list of IPConfigurationReferences ,
Required: False ,
}
[
{
ID:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the logical network. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: Route table resource. ,
Required: False ,
}
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name - name of the subnet ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
ipPools:
{
Description: network associated pool of IP Addresses ,
Required: False ,
}
[
{
name:
{
Description: Name of the IP-Pool ,
Required: False ,
}
string ,
ipPoolType:
{
Description: Type of the IP Pool [vm, vippool] ,
Enum:
{
vm: Virtual Machine IP Pool ,
vippool: VIP Pool ,
}
,
Required: False ,
}
enum ,
start:
{
Description: Start of the IP address pool ,
Required: False ,
}
string ,
end:
{
Description: End of the IP address pool ,
Required: False ,
}
string ,
info:
{
Description: IPPool info ,
Required: False ,
}
{
used:
{
Description: Number of IP addresses allocated from the IP Pool ,
Required: False ,
}
string ,
available:
{
Description: Number of IP addresses available in the IP Pool ,
Required: False ,
}
string ,
}
,
}
,
]
,
vlan:
{
Description: Vlan to use for the subnet ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the logical network. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
vmSwitchName:
{
Description: name of the network switch to be used for VMs ,
Required: False ,
}
string ,
status:
{
Description: The observed state of logical networks ,
Required: False ,
}
{
errorCode:
{
Description: LogicalNetwork provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Logical network provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the logical network ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the logical network [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The logical network resource definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpOptions:
{
Description: DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options. ,
Required: False ,
}
{
dnsServers:
{
Description: The list of DNS servers IP addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
subnets:
{
Description: Subnet - list of subnets under the logical network ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
ipAllocationMethod:
{
Description: IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic' ,
Enum:
{
Dynamic: Dynamic IP allocation method ,
Static: Static IP allocation method ,
}
,
Required: False ,
}
enum ,
ipConfigurationReferences:
{
Description: IPConfigurationReferences - list of IPConfigurationReferences ,
Required: False ,
}
[
{
ID:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the logical network. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: Route table resource. ,
Required: False ,
}
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name - name of the subnet ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
ipPools:
{
Description: network associated pool of IP Addresses ,
Required: False ,
}
[
{
name:
{
Description: Name of the IP-Pool ,
Required: False ,
}
string ,
ipPoolType:
{
Description: Type of the IP Pool [vm, vippool] ,
Enum:
{
vm: Virtual Machine IP Pool ,
vippool: VIP Pool ,
}
,
Required: False ,
}
enum ,
start:
{
Description: Start of the IP address pool ,
Required: False ,
}
string ,
end:
{
Description: End of the IP address pool ,
Required: False ,
}
string ,
info:
{
Description: IPPool info ,
Required: False ,
}
{
used:
{
Description: Number of IP addresses allocated from the IP Pool ,
Required: False ,
}
string ,
available:
{
Description: Number of IP addresses available in the IP Pool ,
Required: False ,
}
string ,
}
,
}
,
]
,
vlan:
{
Description: Vlan to use for the subnet ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the logical network. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
vmSwitchName:
{
Description: name of the network switch to be used for VMs ,
Required: False ,
}
string ,
status:
{
Description: The observed state of logical networks ,
Required: False ,
}
{
errorCode:
{
Description: LogicalNetwork provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Logical network provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the logical network ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the logical network [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LogicalNetworks_Update (new)
Description :  The operation to update a logical network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
logicalNetworkName:
{
Description: Name of the logical network ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpOptions:
{
Description: DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options. ,
Required: False ,
}
{
dnsServers:
{
Description: The list of DNS servers IP addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
subnets:
{
Description: Subnet - list of subnets under the logical network ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the subnet. ,
Required: False ,
}
{
addressPrefix:
{
Description: The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6. ,
Required: False ,
}
string ,
addressPrefixes:
{
Description: List of address prefixes for the subnet. ,
Required: False ,
}
[
string ,
]
,
ipAllocationMethod:
{
Description: IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic' ,
Enum:
{
Dynamic: Dynamic IP allocation method ,
Static: Static IP allocation method ,
}
,
Required: False ,
}
enum ,
ipConfigurationReferences:
{
Description: IPConfigurationReferences - list of IPConfigurationReferences ,
Required: False ,
}
[
{
ID:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the logical network. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
routeTable:
{
Description: Route table resource. ,
Required: False ,
}
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the route table. ,
Required: False ,
}
{
routes:
{
Description: Collection of routes contained within a route table. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the route. ,
Required: False ,
}
{
addressPrefix:
{
Description: The destination CIDR to which the route applies. ,
Required: False ,
}
string ,
nextHopIpAddress:
{
Description: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Name - name of the subnet ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
ipPools:
{
Description: network associated pool of IP Addresses ,
Required: False ,
}
[
{
name:
{
Description: Name of the IP-Pool ,
Required: False ,
}
string ,
ipPoolType:
{
Description: Type of the IP Pool [vm, vippool] ,
Enum:
{
vm: Virtual Machine IP Pool ,
vippool: VIP Pool ,
}
,
Required: False ,
}
enum ,
start:
{
Description: Start of the IP address pool ,
Required: False ,
}
string ,
end:
{
Description: End of the IP address pool ,
Required: False ,
}
string ,
info:
{
Description: IPPool info ,
Required: False ,
}
{
used:
{
Description: Number of IP addresses allocated from the IP Pool ,
Required: False ,
}
string ,
available:
{
Description: Number of IP addresses available in the IP Pool ,
Required: False ,
}
string ,
}
,
}
,
]
,
vlan:
{
Description: Vlan to use for the subnet ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the logical network. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
vmSwitchName:
{
Description: name of the network switch to be used for VMs ,
Required: False ,
}
string ,
status:
{
Description: The observed state of logical networks ,
Required: False ,
}
{
errorCode:
{
Description: LogicalNetwork provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Logical network provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the logical network ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the logical network [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LogicalNetworks_Delete (new)
Description :  The operation to delete a logical network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
logicalNetworkName:
{
Description: Name of the logical network ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MarketplaceGalleryImages_ListByResourceGroup (new)
Description :  Lists all of the marketplace gallery images in the specified resource group. Use the nextLink property in the response to get the next page of marketplace gallery images.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MarketplaceGalleryImage items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for marketplace gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the marketplace gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of marketplace gallery images ,
Required: False ,
}
{
errorCode:
{
Description: MarketplaceGalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of marketplace gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MarketplaceGalleryImages_Get (new)
Description :  Gets a marketplace gallery image
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/{marketplaceGalleryImageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
marketplaceGalleryImageName:
{
Description: Name of the marketplace gallery image ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for marketplace gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the marketplace gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of marketplace gallery images ,
Required: False ,
}
{
errorCode:
{
Description: MarketplaceGalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of marketplace gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MarketplaceGalleryImages_CreateOrUpdate (new)
Description :  The operation to create or update a marketplace gallery image. Please note some properties can be set only during marketplace gallery image creation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/{marketplaceGalleryImageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
marketplaceGalleryImageName:
{
Description: Name of the marketplace gallery image ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for marketplace gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the marketplace gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of marketplace gallery images ,
Required: False ,
}
{
errorCode:
{
Description: MarketplaceGalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of marketplace gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for marketplace gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the marketplace gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of marketplace gallery images ,
Required: False ,
}
{
errorCode:
{
Description: MarketplaceGalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of marketplace gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The marketplace gallery image resource definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for marketplace gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the marketplace gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of marketplace gallery images ,
Required: False ,
}
{
errorCode:
{
Description: MarketplaceGalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of marketplace gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MarketplaceGalleryImages_Update (new)
Description :  The operation to update a marketplace gallery image.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/{marketplaceGalleryImageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
marketplaceGalleryImageName:
{
Description: Name of the marketplace gallery image ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
containerId:
{
Description: Storage ContainerID of the storage container to be used for marketplace gallery image ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Operating system type that the gallery image uses [Windows, Linux] ,
Enum:
{
Windows: Windows operating system ,
Linux: Linux operating system ,
}
,
Required: True ,
}
enum ,
cloudInitDataSource:
{
Description: Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure] ,
Enum:
{
NoCloud: NoCloud is used as the datasource ,
Azure: Azure is used as the datasource ,
}
,
Required: False ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: False ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Specifies information about the gallery image version that you want to create or update. ,
Required: False ,
}
{
name:
{
Description: This is the version of the gallery image. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
{
sizeInMB:
{
Description: This property indicates the size of the VHD to be created. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the marketplace gallery image. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of marketplace gallery images ,
Required: False ,
}
{
errorCode:
{
Description: MarketplaceGalleryImage provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of marketplace gallery image ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the gallery image ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the gallery image ,
Required: False ,
}
{
downloadSizeInMB:
{
Description: The downloaded sized of the image in MB ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MarketplaceGalleryImages_Delete (new)
Description :  The operation to delete a marketplace gallery image.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/{marketplaceGalleryImageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
marketplaceGalleryImageName:
{
Description: Name of the marketplace gallery image ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkInterfaces_ListByResourceGroup (new)
Description :  Lists all of the network interfaces in the specified resource group. Use the nextLink property in the response to get the next page of network interfaces.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkInterface items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IPConfigurations - A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
properties:
{
Description: InterfaceIPConfigurationPropertiesFormat properties of IP configuration. ,
Required: False ,
}
{
gateway:
{
Description: Gateway for network interface ,
Required: False ,
}
string ,
prefixLength:
{
Description: prefixLength for network interface ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: PrivateIPAddress - Private IP address of the IP configuration. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet - Name of Subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
macAddress:
{
Description: MacAddress - The MAC address of the network interface. ,
Required: False ,
}
string ,
dnsSettings:
{
Description: DNS Settings for the interface ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS server IP Addresses for the interface ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the network interface. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of network interfaces ,
Required: False ,
}
{
errorCode:
{
Description: NetworkInterface provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Network interface provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the network interface ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the network interface [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the network interface. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkInterfaces_Get (new)
Description :  Gets a network interface
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces/{networkInterfaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkInterfaceName:
{
Description: Name of the network interface ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IPConfigurations - A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
properties:
{
Description: InterfaceIPConfigurationPropertiesFormat properties of IP configuration. ,
Required: False ,
}
{
gateway:
{
Description: Gateway for network interface ,
Required: False ,
}
string ,
prefixLength:
{
Description: prefixLength for network interface ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: PrivateIPAddress - Private IP address of the IP configuration. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet - Name of Subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
macAddress:
{
Description: MacAddress - The MAC address of the network interface. ,
Required: False ,
}
string ,
dnsSettings:
{
Description: DNS Settings for the interface ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS server IP Addresses for the interface ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the network interface. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of network interfaces ,
Required: False ,
}
{
errorCode:
{
Description: NetworkInterface provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Network interface provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the network interface ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the network interface [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the network interface. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkInterfaces_CreateOrUpdate (new)
Description :  The operation to create or update a network interface. Please note some properties can be set only during network interface creation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces/{networkInterfaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkInterfaceName:
{
Description: Name of the network interface ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IPConfigurations - A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
properties:
{
Description: InterfaceIPConfigurationPropertiesFormat properties of IP configuration. ,
Required: False ,
}
{
gateway:
{
Description: Gateway for network interface ,
Required: False ,
}
string ,
prefixLength:
{
Description: prefixLength for network interface ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: PrivateIPAddress - Private IP address of the IP configuration. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet - Name of Subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
macAddress:
{
Description: MacAddress - The MAC address of the network interface. ,
Required: False ,
}
string ,
dnsSettings:
{
Description: DNS Settings for the interface ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS server IP Addresses for the interface ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the network interface. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of network interfaces ,
Required: False ,
}
{
errorCode:
{
Description: NetworkInterface provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Network interface provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the network interface ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the network interface [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the network interface. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IPConfigurations - A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
properties:
{
Description: InterfaceIPConfigurationPropertiesFormat properties of IP configuration. ,
Required: False ,
}
{
gateway:
{
Description: Gateway for network interface ,
Required: False ,
}
string ,
prefixLength:
{
Description: prefixLength for network interface ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: PrivateIPAddress - Private IP address of the IP configuration. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet - Name of Subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
macAddress:
{
Description: MacAddress - The MAC address of the network interface. ,
Required: False ,
}
string ,
dnsSettings:
{
Description: DNS Settings for the interface ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS server IP Addresses for the interface ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the network interface. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of network interfaces ,
Required: False ,
}
{
errorCode:
{
Description: NetworkInterface provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Network interface provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the network interface ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the network interface [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the network interface. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The network interface resource definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IPConfigurations - A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
properties:
{
Description: InterfaceIPConfigurationPropertiesFormat properties of IP configuration. ,
Required: False ,
}
{
gateway:
{
Description: Gateway for network interface ,
Required: False ,
}
string ,
prefixLength:
{
Description: prefixLength for network interface ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: PrivateIPAddress - Private IP address of the IP configuration. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet - Name of Subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
macAddress:
{
Description: MacAddress - The MAC address of the network interface. ,
Required: False ,
}
string ,
dnsSettings:
{
Description: DNS Settings for the interface ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS server IP Addresses for the interface ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the network interface. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of network interfaces ,
Required: False ,
}
{
errorCode:
{
Description: NetworkInterface provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Network interface provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the network interface ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the network interface [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the network interface. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkInterfaces_Update (new)
Description :  The operation to update a network interface.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces/{networkInterfaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkInterfaceName:
{
Description: Name of the network interface ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ipConfigurations:
{
Description: IPConfigurations - A list of IPConfigurations of the network interface. ,
Required: False ,
}
[
{
name:
{
Description: Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. ,
Required: False ,
}
string ,
properties:
{
Description: InterfaceIPConfigurationPropertiesFormat properties of IP configuration. ,
Required: False ,
}
{
gateway:
{
Description: Gateway for network interface ,
Required: False ,
}
string ,
prefixLength:
{
Description: prefixLength for network interface ,
Required: False ,
}
string ,
privateIPAddress:
{
Description: PrivateIPAddress - Private IP address of the IP configuration. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet - Name of Subnet bound to the IP configuration. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
macAddress:
{
Description: MacAddress - The MAC address of the network interface. ,
Required: False ,
}
string ,
dnsSettings:
{
Description: DNS Settings for the interface ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS server IP Addresses for the interface ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the network interface. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of network interfaces ,
Required: False ,
}
{
errorCode:
{
Description: NetworkInterface provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Network interface provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the network interface ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the network interface [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
networkSecurityGroup:
{
Description: NetworkSecurityGroup - Network Security Group attached to the network interface. ,
Required: False ,
}
{
id:
{
Description: The ARM ID for a Network Security Group. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkInterfaces_Delete (new)
Description :  The operation to delete a network interface.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces/{networkInterfaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkInterfaceName:
{
Description: Name of the network interface ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityGroups_ListByResourceGroup (new)
Description :  Gets all network security groups in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkSecurityGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
networkInterfaces:
{
Description: A collection of references to network interfaces that are currently using this NSG. ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to logical networks that are currently using this NSG ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityGroups_Get (new)
Description :  Gets the specified network security group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkSecurityGroupName:
{
Description: Name of the network security group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
networkInterfaces:
{
Description: A collection of references to network interfaces that are currently using this NSG. ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to logical networks that are currently using this NSG ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityGroups_CreateOrUpdate (new)
Description :  Creates or updates a network security group in the specified resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkSecurityGroupName:
{
Description: Name of the network security group ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
networkInterfaces:
{
Description: A collection of references to network interfaces that are currently using this NSG. ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to logical networks that are currently using this NSG ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
networkInterfaces:
{
Description: A collection of references to network interfaces that are currently using this NSG. ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to logical networks that are currently using this NSG ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NetworkSecurityGroup resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
networkInterfaces:
{
Description: A collection of references to network interfaces that are currently using this NSG. ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to logical networks that are currently using this NSG ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityGroups_UpdateTags (new)
Description :  Updates a network security group tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkSecurityGroupName:
{
Description: Name of the network security group ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
networkInterfaces:
{
Description: A collection of references to network interfaces that are currently using this NSG. ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Network Interface. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
subnets:
{
Description: A collection of references to logical networks that are currently using this NSG ,
Required: False ,
}
[
{
id:
{
Description: The ARM ID for a Logical Network. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the network security group resource. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityGroups_Delete (new)
Description :  Deletes the specified network security group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkSecurityGroupName:
{
Description: Name of the network security group ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityRules_ListByNetworkSecurityGroup (new)
Description :  Gets all security rules in a Network Security Group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}/securityRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkSecurityGroupName:
{
Description: Name of the network security group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SecurityRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: Transmission Control Protocol ,
Udp: User Datagram Protocol ,
Icmp: Internet Control Message Protocol ,
*: Wildcard rule for all protocols ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: Network traffic is allowed ,
Deny: Network traffic is denied ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: Rule is evaluated on incoming traffic ,
Outbound: Rule is evaluated on outgoing traffic ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the SR ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityRules_Get (new)
Description :  Gets the specified security rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkSecurityGroupName:
{
Description: Name of the network security group ,
Required: True ,
}
string ,
securityRuleName:
{
Description: Name of the security rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: Transmission Control Protocol ,
Udp: User Datagram Protocol ,
Icmp: Internet Control Message Protocol ,
*: Wildcard rule for all protocols ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: Network traffic is allowed ,
Deny: Network traffic is denied ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: Rule is evaluated on incoming traffic ,
Outbound: Rule is evaluated on outgoing traffic ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the SR ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityRules_CreateOrUpdate (new)
Description :  Creates or updates a security rule in the specified resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkSecurityGroupName:
{
Description: Name of the network security group ,
Required: True ,
}
string ,
securityRuleName:
{
Description: Name of the security rule. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: Transmission Control Protocol ,
Udp: User Datagram Protocol ,
Icmp: Internet Control Message Protocol ,
*: Wildcard rule for all protocols ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: Network traffic is allowed ,
Deny: Network traffic is denied ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: Rule is evaluated on incoming traffic ,
Outbound: Rule is evaluated on outgoing traffic ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the SR ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: Transmission Control Protocol ,
Udp: User Datagram Protocol ,
Icmp: Internet Control Message Protocol ,
*: Wildcard rule for all protocols ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: Network traffic is allowed ,
Deny: Network traffic is denied ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: Rule is evaluated on incoming traffic ,
Outbound: Rule is evaluated on outgoing traffic ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the SR ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Security Rule resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: A description for this rule. Restricted to 140 chars. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
Tcp: Transmission Control Protocol ,
Udp: User Datagram Protocol ,
Icmp: Internet Control Message Protocol ,
*: Wildcard rule for all protocols ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
[
string ,
]
,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
Allow: Network traffic is allowed ,
Deny: Network traffic is denied ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. ,
Enum:
{
Inbound: Rule is evaluated on incoming traffic ,
Outbound: Rule is evaluated on outgoing traffic ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the SR ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityRules_Delete (new)
Description :  Deletes the specified security rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkSecurityGroupName:
{
Description: Name of the network security group ,
Required: True ,
}
string ,
securityRuleName:
{
Description: Name of the security rule. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageContainers_ListByResourceGroup (new)
Description :  Lists all of the storage containers in the specified resource group. Use the nextLink property in the response to get the next page of storage containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The StorageContainer items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
path:
{
Description: Path of the storage container on the disk ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the storage container. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of storage containers ,
Required: False ,
}
{
errorCode:
{
Description: StorageContainer provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
availableSizeMB:
{
Description: Amount of space available on the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
containerSizeMB:
{
Description: Total size of the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningStatus:
{
Description: Storage container's provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the storage container ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the storage container [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageContainers_Get (new)
Description :  Gets a storage container
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers/{storageContainerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageContainerName:
{
Description: Name of the storage container ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
path:
{
Description: Path of the storage container on the disk ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the storage container. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of storage containers ,
Required: False ,
}
{
errorCode:
{
Description: StorageContainer provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
availableSizeMB:
{
Description: Amount of space available on the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
containerSizeMB:
{
Description: Total size of the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningStatus:
{
Description: Storage container's provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the storage container ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the storage container [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageContainers_CreateOrUpdate (new)
Description :  The operation to create or update a storage container. Please note some properties can be set only during storage container creation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers/{storageContainerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageContainerName:
{
Description: Name of the storage container ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
path:
{
Description: Path of the storage container on the disk ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the storage container. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of storage containers ,
Required: False ,
}
{
errorCode:
{
Description: StorageContainer provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
availableSizeMB:
{
Description: Amount of space available on the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
containerSizeMB:
{
Description: Total size of the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningStatus:
{
Description: Storage container's provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the storage container ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the storage container [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
path:
{
Description: Path of the storage container on the disk ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the storage container. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of storage containers ,
Required: False ,
}
{
errorCode:
{
Description: StorageContainer provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
availableSizeMB:
{
Description: Amount of space available on the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
containerSizeMB:
{
Description: Total size of the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningStatus:
{
Description: Storage container's provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the storage container ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the storage container [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The storage container resource definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
path:
{
Description: Path of the storage container on the disk ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the storage container. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of storage containers ,
Required: False ,
}
{
errorCode:
{
Description: StorageContainer provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
availableSizeMB:
{
Description: Amount of space available on the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
containerSizeMB:
{
Description: Total size of the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningStatus:
{
Description: Storage container's provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the storage container ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the storage container [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageContainers_Update (new)
Description :  The operation to update a storage container.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers/{storageContainerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageContainerName:
{
Description: Name of the storage container ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
path:
{
Description: Path of the storage container on the disk ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the storage container. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The observed state of storage containers ,
Required: False ,
}
{
errorCode:
{
Description: StorageContainer provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
availableSizeMB:
{
Description: Amount of space available on the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
containerSizeMB:
{
Description: Total size of the disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningStatus:
{
Description: Storage container's provisioning status ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the storage container ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the storage container [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageContainers_Delete (new)
Description :  The operation to delete a storage container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers/{storageContainerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageContainerName:
{
Description: Name of the storage container ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualHardDisks_ListByResourceGroup (new)
Description :  Lists all of the virtual hard disks in the specified resource group. Use the nextLink property in the response to get the next page of virtual hard disks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VirtualHardDisk items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
blockSizeBytes:
{
Description: Block size in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeGB:
{
Description: Size of the disk in GB ,
Format: int64 ,
Required: False ,
}
integer ,
dynamic:
{
Description: Boolean for enabling dynamic sizing on the virtual hard disk ,
Required: False ,
}
boolean ,
logicalSectorBytes:
{
Description: Logical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
physicalSectorBytes:
{
Description: Physical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
downloadUrl:
{
Description: URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly. ,
Format: password ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
diskFileFormat:
{
Description: The format of the actual VHD file [vhd, vhdx] ,
Enum:
{
vhdx: VHDX file format ,
vhd: VHD file format ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the virtual hard disk. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
containerId:
{
Description: Storage ContainerID of the storage container to be used for VHD ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The observed state of virtual hard disks ,
Required: False ,
}
{
errorCode:
{
Description: VirtualHardDisk provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of the vhd ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual hard disk ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the virtual hard disk ,
Required: False ,
}
{
downloadedSizeInMB:
{
Description: The downloaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
uploadStatus:
{
Description: The upload status of the virtual hard disk ,
Required: False ,
}
{
uploadedSizeInMB:
{
Description: The uploaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
errorCode:
{
Description: VirtualHardDisk upload error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive upload error message ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualHardDisks_Get (new)
Description :  Gets a virtual hard disk
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks/{virtualHardDiskName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualHardDiskName:
{
Description: Name of the virtual hard disk ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
blockSizeBytes:
{
Description: Block size in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeGB:
{
Description: Size of the disk in GB ,
Format: int64 ,
Required: False ,
}
integer ,
dynamic:
{
Description: Boolean for enabling dynamic sizing on the virtual hard disk ,
Required: False ,
}
boolean ,
logicalSectorBytes:
{
Description: Logical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
physicalSectorBytes:
{
Description: Physical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
downloadUrl:
{
Description: URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly. ,
Format: password ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
diskFileFormat:
{
Description: The format of the actual VHD file [vhd, vhdx] ,
Enum:
{
vhdx: VHDX file format ,
vhd: VHD file format ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the virtual hard disk. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
containerId:
{
Description: Storage ContainerID of the storage container to be used for VHD ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The observed state of virtual hard disks ,
Required: False ,
}
{
errorCode:
{
Description: VirtualHardDisk provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of the vhd ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual hard disk ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the virtual hard disk ,
Required: False ,
}
{
downloadedSizeInMB:
{
Description: The downloaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
uploadStatus:
{
Description: The upload status of the virtual hard disk ,
Required: False ,
}
{
uploadedSizeInMB:
{
Description: The uploaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
errorCode:
{
Description: VirtualHardDisk upload error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive upload error message ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualHardDisks_CreateOrUpdate (new)
Description :  The operation to create or update a virtual hard disk. Please note some properties can be set only during virtual hard disk creation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks/{virtualHardDiskName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualHardDiskName:
{
Description: Name of the virtual hard disk ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
blockSizeBytes:
{
Description: Block size in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeGB:
{
Description: Size of the disk in GB ,
Format: int64 ,
Required: False ,
}
integer ,
dynamic:
{
Description: Boolean for enabling dynamic sizing on the virtual hard disk ,
Required: False ,
}
boolean ,
logicalSectorBytes:
{
Description: Logical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
physicalSectorBytes:
{
Description: Physical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
downloadUrl:
{
Description: URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly. ,
Format: password ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
diskFileFormat:
{
Description: The format of the actual VHD file [vhd, vhdx] ,
Enum:
{
vhdx: VHDX file format ,
vhd: VHD file format ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the virtual hard disk. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
containerId:
{
Description: Storage ContainerID of the storage container to be used for VHD ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The observed state of virtual hard disks ,
Required: False ,
}
{
errorCode:
{
Description: VirtualHardDisk provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of the vhd ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual hard disk ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the virtual hard disk ,
Required: False ,
}
{
downloadedSizeInMB:
{
Description: The downloaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
uploadStatus:
{
Description: The upload status of the virtual hard disk ,
Required: False ,
}
{
uploadedSizeInMB:
{
Description: The uploaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
errorCode:
{
Description: VirtualHardDisk upload error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive upload error message ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
blockSizeBytes:
{
Description: Block size in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeGB:
{
Description: Size of the disk in GB ,
Format: int64 ,
Required: False ,
}
integer ,
dynamic:
{
Description: Boolean for enabling dynamic sizing on the virtual hard disk ,
Required: False ,
}
boolean ,
logicalSectorBytes:
{
Description: Logical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
physicalSectorBytes:
{
Description: Physical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
downloadUrl:
{
Description: URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly. ,
Format: password ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
diskFileFormat:
{
Description: The format of the actual VHD file [vhd, vhdx] ,
Enum:
{
vhdx: VHDX file format ,
vhd: VHD file format ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the virtual hard disk. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
containerId:
{
Description: Storage ContainerID of the storage container to be used for VHD ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The observed state of virtual hard disks ,
Required: False ,
}
{
errorCode:
{
Description: VirtualHardDisk provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of the vhd ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual hard disk ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the virtual hard disk ,
Required: False ,
}
{
downloadedSizeInMB:
{
Description: The downloaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
uploadStatus:
{
Description: The upload status of the virtual hard disk ,
Required: False ,
}
{
uploadedSizeInMB:
{
Description: The uploaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
errorCode:
{
Description: VirtualHardDisk upload error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive upload error message ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The virtual hard disk resource definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
blockSizeBytes:
{
Description: Block size in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeGB:
{
Description: Size of the disk in GB ,
Format: int64 ,
Required: False ,
}
integer ,
dynamic:
{
Description: Boolean for enabling dynamic sizing on the virtual hard disk ,
Required: False ,
}
boolean ,
logicalSectorBytes:
{
Description: Logical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
physicalSectorBytes:
{
Description: Physical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
downloadUrl:
{
Description: URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly. ,
Format: password ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
diskFileFormat:
{
Description: The format of the actual VHD file [vhd, vhdx] ,
Enum:
{
vhdx: VHDX file format ,
vhd: VHD file format ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the virtual hard disk. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
containerId:
{
Description: Storage ContainerID of the storage container to be used for VHD ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The observed state of virtual hard disks ,
Required: False ,
}
{
errorCode:
{
Description: VirtualHardDisk provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of the vhd ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual hard disk ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the virtual hard disk ,
Required: False ,
}
{
downloadedSizeInMB:
{
Description: The downloaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
uploadStatus:
{
Description: The upload status of the virtual hard disk ,
Required: False ,
}
{
uploadedSizeInMB:
{
Description: The uploaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
errorCode:
{
Description: VirtualHardDisk upload error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive upload error message ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualHardDisks_Update (new)
Description :  The operation to update a virtual hard disk.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks/{virtualHardDiskName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualHardDiskName:
{
Description: Name of the virtual hard disk ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
blockSizeBytes:
{
Description: Block size in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
diskSizeGB:
{
Description: Size of the disk in GB ,
Format: int64 ,
Required: False ,
}
integer ,
dynamic:
{
Description: Boolean for enabling dynamic sizing on the virtual hard disk ,
Required: False ,
}
boolean ,
logicalSectorBytes:
{
Description: Logical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
physicalSectorBytes:
{
Description: Physical sector in bytes ,
Format: int32 ,
Required: False ,
}
integer ,
downloadUrl:
{
Description: URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly. ,
Format: password ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: Generation 1 (V1) hypervisor ,
V2: Generation 2 (V2) hypervisor ,
}
,
Required: False ,
}
enum ,
diskFileFormat:
{
Description: The format of the actual VHD file [vhd, vhdx] ,
Enum:
{
vhdx: VHDX file format ,
vhd: VHD file format ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the virtual hard disk. ,
Enum:
{
Succeeded: Provisioning has succeeded ,
Failed: Provisioning has failed ,
InProgress: Provisioning is in progress ,
Accepted: Provisioning has been accepted ,
Deleting: Deletion of the resource is in progress ,
Canceled: Provisioning has been canceled ,
}
,
Required: False ,
}
enum ,
containerId:
{
Description: Storage ContainerID of the storage container to be used for VHD ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The observed state of virtual hard disks ,
Required: False ,
}
{
errorCode:
{
Description: VirtualHardDisk provisioning error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive error message ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: Provisioning status of the vhd ,
Required: False ,
}
{
operationId:
{
Description: The ID of the operation performed on the virtual hard disk ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: The download status of the virtual hard disk ,
Required: False ,
}
{
downloadedSizeInMB:
{
Description: The downloaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
uploadStatus:
{
Description: The upload status of the virtual hard disk ,
Required: False ,
}
{
uploadedSizeInMB:
{
Description: The uploaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
errorCode:
{
Description: VirtualHardDisk upload error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive upload error message ,
Required: False ,
}
string ,
}
,
}
,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: Custom extended location type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualHardDisks_Delete (new)
Description :  The operation to delete a virtual hard disk.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks/{virtualHardDiskName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualHardDiskName:
{
Description: Name of the virtual hard disk ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualHardDisks_Upload (new)
Description :  The operation to upload a virtual hard disk.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks/{virtualHardDiskName}/upload
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualHardDiskName:
{
Description: Name of the virtual hard disk ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
azureManagedDiskUploadUrl:
{
Description: The Azure managed disk SAS URL to upload the virtual hard disk to. ,
Format: password ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
virtualHardDiskId:
{
Description: The ARM ID for a Virtual Hard Disk. ,
Format: arm-id ,
Required: False ,
}
string ,
uploadStatus:
{
Description: The upload status of the virtual hard disk ,
Required: False ,
}
{
uploadedSizeInMB:
{
Description: The uploaded sized of the virtual hard disk in MB ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] ,
Enum:
{
Succeeded: Operation succeeded ,
Failed: Operation failed ,
InProgress: Operation is in progress ,
}
,
Required: False ,
}
enum ,
progressPercentage:
{
Description: The progress of the operation in percentage ,
Format: int64 ,
Required: False ,
}
integer ,
errorCode:
{
Description: VirtualHardDisk upload error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive upload error message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureStackHCI/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}