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: string ,
resourceUri: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
hardwareProfile:
{
vmSize: enum ,
processors: integer ,
memoryMB: integer ,
dynamicMemoryConfig:
{
maximumMemoryMB: integer ,
minimumMemoryMB: integer ,
targetMemoryBuffer: integer ,
}
,
virtualMachineGPUs:
[
{
assignmentType: enum ,
partitionSizeMB: integer ,
gpuName: string ,
}
,
]
,
}
,
networkProfile:
{
networkInterfaces:
[
{
id: string ,
}
,
]
,
}
,
osProfile:
{
adminPassword: string ,
adminUsername: string ,
computerName: string ,
linuxConfiguration:
{
disablePasswordAuthentication: boolean ,
ssh:
{
publicKeys:
[
{
path: string ,
keyData: string ,
}
,
]
,
}
,
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
windowsConfiguration:
{
enableAutomaticUpdates: boolean ,
ssh:
{
publicKeys:
[
{
path: string ,
keyData: string ,
}
,
]
,
}
,
timeZone: string ,
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
}
,
securityProfile:
{
enableTPM: boolean ,
uefiSettings:
{
secureBootEnabled: boolean ,
}
,
securityType: enum ,
}
,
storageProfile:
{
dataDisks:
[
{
id: string ,
}
,
]
,
imageReference:
{
id: string ,
}
,
osDisk:
{
id: string ,
osType: enum ,
managedDisk:
{
securityProfile:
{
securityEncryptionType: enum ,
}
,
}
,
}
,
vmConfigStoragePathId: string ,
}
,
httpProxyConfig:
{
httpProxy: string ,
httpsProxy: string ,
noProxy:
[
string ,
]
,
trustedCa: string ,
}
,
provisioningState: enum ,
instanceView:
{
vmAgent:
{
vmConfigAgentVersion: string ,
statuses:
[
{
code: string ,
level: enum ,
displayStatus: string ,
message: string ,
time: string ,
}
,
]
,
}
,
}
,
status:
{
errorCode: string ,
errorMessage: string ,
powerState: enum ,
provisioningStatus:
{
operationId: string ,
status: enum ,
}
,
}
,
guestAgentInstallStatus:
{
vmUuid: string ,
status: enum ,
lastStatusChange: string ,
agentVersion: string ,
errorDetails:
[
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
}
,
vmId: string ,
resourceUid: string ,
}
,
extendedLocation:
{
name: string ,
type: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default
{
api-version: string ,
resourceUri: string ,
}

⚐ Response (200)

{
properties:
{
hardwareProfile:
{
vmSize: enum ,
processors: integer ,
memoryMB: integer ,
dynamicMemoryConfig:
{
maximumMemoryMB: integer ,
minimumMemoryMB: integer ,
targetMemoryBuffer: integer ,
}
,
virtualMachineGPUs:
[
{
assignmentType: enum ,
partitionSizeMB: integer ,
gpuName: string ,
}
,
]
,
}
,
networkProfile:
{
networkInterfaces:
[
{
id: string ,
}
,
]
,
}
,
osProfile:
{
adminPassword: string ,
adminUsername: string ,
computerName: string ,
linuxConfiguration:
{
disablePasswordAuthentication: boolean ,
ssh:
{
publicKeys:
[
{
path: string ,
keyData: string ,
}
,
]
,
}
,
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
windowsConfiguration:
{
enableAutomaticUpdates: boolean ,
ssh:
{
publicKeys:
[
{
path: string ,
keyData: string ,
}
,
]
,
}
,
timeZone: string ,
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
}
,
securityProfile:
{
enableTPM: boolean ,
uefiSettings:
{
secureBootEnabled: boolean ,
}
,
securityType: enum ,
}
,
storageProfile:
{
dataDisks:
[
{
id: string ,
}
,
]
,
imageReference:
{
id: string ,
}
,
osDisk:
{
id: string ,
osType: enum ,
managedDisk:
{
securityProfile:
{
securityEncryptionType: enum ,
}
,
}
,
}
,
vmConfigStoragePathId: string ,
}
,
httpProxyConfig:
{
httpProxy: string ,
httpsProxy: string ,
noProxy:
[
string ,
]
,
trustedCa: string ,
}
,
provisioningState: enum ,
instanceView:
{
vmAgent:
{
vmConfigAgentVersion: string ,
statuses:
[
{
code: string ,
level: enum ,
displayStatus: string ,
message: string ,
time: string ,
}
,
]
,
}
,
}
,
status:
{
errorCode: string ,
errorMessage: string ,
powerState: enum ,
provisioningStatus:
{
operationId: string ,
status: enum ,
}
,
}
,
guestAgentInstallStatus:
{
vmUuid: string ,
status: enum ,
lastStatusChange: string ,
agentVersion: string ,
errorDetails:
[
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
}
,
vmId: string ,
resourceUid: string ,
}
,
extendedLocation:
{
name: string ,
type: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceUri: string ,
resource:
{
properties:
{
hardwareProfile:
{
vmSize: enum ,
processors: integer ,
memoryMB: integer ,
dynamicMemoryConfig:
{
maximumMemoryMB: integer ,
minimumMemoryMB: integer ,
targetMemoryBuffer: integer ,
}
,
virtualMachineGPUs:
[
{
assignmentType: enum ,
partitionSizeMB: integer ,
gpuName: string ,
}
,
]
,
}
,
networkProfile:
{
networkInterfaces:
[
{
id: string ,
}
,
]
,
}
,
osProfile:
{
adminPassword: string ,
adminUsername: string ,
computerName: string ,
linuxConfiguration:
{
disablePasswordAuthentication: boolean ,
ssh:
{
publicKeys:
[
{
path: string ,
keyData: string ,
}
,
]
,
}
,
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
windowsConfiguration:
{
enableAutomaticUpdates: boolean ,
ssh:
{
publicKeys:
[
{
path: string ,
keyData: string ,
}
,
]
,
}
,
timeZone: string ,
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
}
,
securityProfile:
{
enableTPM: boolean ,
uefiSettings:
{
secureBootEnabled: boolean ,
}
,
securityType: enum ,
}
,
storageProfile:
{
dataDisks:
[
{
id: string ,
}
,
]
,
imageReference:
{
id: string ,
}
,
osDisk:
{
id: string ,
osType: enum ,
managedDisk:
{
securityProfile:
{
securityEncryptionType: enum ,
}
,
}
,
}
,
vmConfigStoragePathId: string ,
}
,
httpProxyConfig:
{
httpProxy: string ,
httpsProxy: string ,
noProxy:
[
string ,
]
,
trustedCa: string ,
}
,
provisioningState: enum ,
instanceView:
{
vmAgent:
{
vmConfigAgentVersion: string ,
statuses:
[
{
code: string ,
level: enum ,
displayStatus: string ,
message: string ,
time: string ,
}
,
]
,
}
,
}
,
status:
{
errorCode: string ,
errorMessage: string ,
powerState: enum ,
provisioningStatus:
{
operationId: string ,
status: enum ,
}
,
}
,
guestAgentInstallStatus:
{
vmUuid: string ,
status: enum ,
lastStatusChange: string ,
agentVersion: string ,
errorDetails:
[
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
}
,
vmId: string ,
resourceUid: string ,
}
,
extendedLocation:
{
name: string ,
type: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
hardwareProfile:
{
vmSize: enum ,
processors: integer ,
memoryMB: integer ,
dynamicMemoryConfig:
{
maximumMemoryMB: integer ,
minimumMemoryMB: integer ,
targetMemoryBuffer: integer ,
}
,
virtualMachineGPUs:
[
{
assignmentType: enum ,
partitionSizeMB: integer ,
gpuName: string ,
}
,
]
,
}
,
networkProfile:
{
networkInterfaces:
[
{
id: string ,
}
,
]
,
}
,
osProfile:
{
adminPassword: string ,
adminUsername: string ,
computerName: string ,
linuxConfiguration:
{
disablePasswordAuthentication: boolean ,
ssh:
{
publicKeys:
[
{
path: string ,
keyData: string ,
}
,
]
,
}
,
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
windowsConfiguration:
{
enableAutomaticUpdates: boolean ,
ssh:
{
publicKeys:
[
{
path: string ,
keyData: string ,
}
,
]
,
}
,
timeZone: string ,
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
}
,
securityProfile:
{
enableTPM: boolean ,
uefiSettings:
{
secureBootEnabled: boolean ,
}
,
securityType: enum ,
}
,
storageProfile:
{
dataDisks:
[
{
id: string ,
}
,
]
,
imageReference:
{
id: string ,
}
,
osDisk:
{
id: string ,
osType: enum ,
managedDisk:
{
securityProfile:
{
securityEncryptionType: enum ,
}
,
}
,
}
,
vmConfigStoragePathId: string ,
}
,
httpProxyConfig:
{
httpProxy: string ,
httpsProxy: string ,
noProxy:
[
string ,
]
,
trustedCa: string ,
}
,
provisioningState: enum ,
instanceView:
{
vmAgent:
{
vmConfigAgentVersion: string ,
statuses:
[
{
code: string ,
level: enum ,
displayStatus: string ,
message: string ,
time: string ,
}
,
]
,
}
,
}
,
status:
{
errorCode: string ,
errorMessage: string ,
powerState: enum ,
provisioningStatus:
{
operationId: string ,
status: enum ,
}
,
}
,
guestAgentInstallStatus:
{
vmUuid: string ,
status: enum ,
lastStatusChange: string ,
agentVersion: string ,
errorDetails:
[
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
}
,
vmId: string ,
resourceUid: string ,
}
,
extendedLocation:
{
name: string ,
type: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after: integer ,
}
,
$schema:
{
properties:
{
hardwareProfile:
{
vmSize: enum ,
processors: integer ,
memoryMB: integer ,
dynamicMemoryConfig:
{
maximumMemoryMB: integer ,
minimumMemoryMB: integer ,
targetMemoryBuffer: integer ,
}
,
virtualMachineGPUs:
[
{
assignmentType: enum ,
partitionSizeMB: integer ,
gpuName: string ,
}
,
]
,
}
,
networkProfile:
{
networkInterfaces:
[
{
id: string ,
}
,
]
,
}
,
osProfile:
{
adminPassword: string ,
adminUsername: string ,
computerName: string ,
linuxConfiguration:
{
disablePasswordAuthentication: boolean ,
ssh:
{
publicKeys:
[
{
path: string ,
keyData: string ,
}
,
]
,
}
,
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
windowsConfiguration:
{
enableAutomaticUpdates: boolean ,
ssh:
{
publicKeys:
[
{
path: string ,
keyData: string ,
}
,
]
,
}
,
timeZone: string ,
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
}
,
securityProfile:
{
enableTPM: boolean ,
uefiSettings:
{
secureBootEnabled: boolean ,
}
,
securityType: enum ,
}
,
storageProfile:
{
dataDisks:
[
{
id: string ,
}
,
]
,
imageReference:
{
id: string ,
}
,
osDisk:
{
id: string ,
osType: enum ,
managedDisk:
{
securityProfile:
{
securityEncryptionType: enum ,
}
,
}
,
}
,
vmConfigStoragePathId: string ,
}
,
httpProxyConfig:
{
httpProxy: string ,
httpsProxy: string ,
noProxy:
[
string ,
]
,
trustedCa: string ,
}
,
provisioningState: enum ,
instanceView:
{
vmAgent:
{
vmConfigAgentVersion: string ,
statuses:
[
{
code: string ,
level: enum ,
displayStatus: string ,
message: string ,
time: string ,
}
,
]
,
}
,
}
,
status:
{
errorCode: string ,
errorMessage: string ,
powerState: enum ,
provisioningStatus:
{
operationId: string ,
status: enum ,
}
,
}
,
guestAgentInstallStatus:
{
vmUuid: string ,
status: enum ,
lastStatusChange: string ,
agentVersion: string ,
errorDetails:
[
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
}
,
vmId: string ,
resourceUid: string ,
}
,
extendedLocation:
{
name: string ,
type: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceUri: string ,
properties:
{
properties:
{
hardwareProfile:
{
vmSize: enum ,
processors: integer ,
memoryMB: integer ,
virtualMachineGPUs:
[
{
assignmentType: enum ,
partitionSizeMB: integer ,
gpuName: string ,
}
,
]
,
}
,
storageProfile:
{
dataDisks:
[
{
id: string ,
}
,
]
,
}
,
networkProfile:
{
networkInterfaces:
[
{
id: string ,
}
,
]
,
}
,
osProfile:
{
computerName: string ,
linuxConfiguration:
{
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
windowsConfiguration:
{
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
}
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
hardwareProfile:
{
vmSize: enum ,
processors: integer ,
memoryMB: integer ,
dynamicMemoryConfig:
{
maximumMemoryMB: integer ,
minimumMemoryMB: integer ,
targetMemoryBuffer: integer ,
}
,
virtualMachineGPUs:
[
{
assignmentType: enum ,
partitionSizeMB: integer ,
gpuName: string ,
}
,
]
,
}
,
networkProfile:
{
networkInterfaces:
[
{
id: string ,
}
,
]
,
}
,
osProfile:
{
adminPassword: string ,
adminUsername: string ,
computerName: string ,
linuxConfiguration:
{
disablePasswordAuthentication: boolean ,
ssh:
{
publicKeys:
[
{
path: string ,
keyData: string ,
}
,
]
,
}
,
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
windowsConfiguration:
{
enableAutomaticUpdates: boolean ,
ssh:
{
publicKeys:
[
{
path: string ,
keyData: string ,
}
,
]
,
}
,
timeZone: string ,
provisionVMAgent: boolean ,
provisionVMConfigAgent: boolean ,
}
,
}
,
securityProfile:
{
enableTPM: boolean ,
uefiSettings:
{
secureBootEnabled: boolean ,
}
,
securityType: enum ,
}
,
storageProfile:
{
dataDisks:
[
{
id: string ,
}
,
]
,
imageReference:
{
id: string ,
}
,
osDisk:
{
id: string ,
osType: enum ,
managedDisk:
{
securityProfile:
{
securityEncryptionType: enum ,
}
,
}
,
}
,
vmConfigStoragePathId: string ,
}
,
httpProxyConfig:
{
httpProxy: string ,
httpsProxy: string ,
noProxy:
[
string ,
]
,
trustedCa: string ,
}
,
provisioningState: enum ,
instanceView:
{
vmAgent:
{
vmConfigAgentVersion: string ,
statuses:
[
{
code: string ,
level: enum ,
displayStatus: string ,
message: string ,
time: string ,
}
,
]
,
}
,
}
,
status:
{
errorCode: string ,
errorMessage: string ,
powerState: enum ,
provisioningStatus:
{
operationId: string ,
status: enum ,
}
,
}
,
guestAgentInstallStatus:
{
vmUuid: string ,
status: enum ,
lastStatusChange: string ,
agentVersion: string ,
errorDetails:
[
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
}
,
vmId: string ,
resourceUid: string ,
}
,
extendedLocation:
{
name: string ,
type: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceUri: string ,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default
{
api-version: string ,
resourceUri: string ,
}

⚐ Response (200)

{
properties:
{
attestSecureBootEnabled: enum ,
attestationCertValidated: enum ,
bootIntegrityValidated: enum ,
linuxKernelVersion: string ,
healthStatus: enum ,
timestamp: string ,
errorMessage: string ,
provisioningState: enum ,
attestHardwarePlatform: enum ,
attestDiskSecurityEncryptionType: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceUri: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
credentials:
{
username: string ,
password: string ,
}
,
provisioningAction: enum ,
status: string ,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default
{
api-version: string ,
resourceUri: string ,
}

⚐ Response (200)

{
properties:
{
credentials:
{
username: string ,
password: string ,
}
,
provisioningAction: enum ,
status: string ,
provisioningState: enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default
{
api-version: string ,
resourceUri: string ,
resource:
{
properties:
{
credentials:
{
username: string ,
password: string ,
}
,
provisioningAction: enum ,
status: string ,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
credentials:
{
username: string ,
password: string ,
}
,
provisioningAction: enum ,
status: string ,
provisioningState: enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after: integer ,
}
,
$schema:
{
properties:
{
credentials:
{
username: string ,
password: string ,
}
,
provisioningAction: enum ,
status: string ,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default
{
api-version: string ,
resourceUri: string ,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceUri: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
resourceUid: string ,
publicKey: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default
{
api-version: string ,
resourceUri: string ,
}

⚐ Response (200)

{
properties:
{
resourceUid: string ,
publicKey: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
}
,
provisioningState: