Microsoft.OffAzure (preview:2024-05-01)

2024/12/06 • 200 new methods

Operations_List (new)
Description List the operations for the provider
Reference Link ¶

⚼ Request

GET:  /providers/Microsoft.OffAzure/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
isDataAction: boolean ,
display:
{
provider: string ,
resource: string ,
operation: string ,
description: string ,
}
,
origin: enum ,
actionType: enum ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervSites_ListBySubscription (new)
Description Get all the hyperv sites in the subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/hypervSites
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
masterSiteId: string ,
servicePrincipalIdentityDetails:
{
tenantId: string ,
applicationId: string ,
objectId: string ,
audience: string ,
aadAuthority: string ,
rawCertData: string ,
}
,
agentDetails:
{
id: string ,
version: string ,
lastHeartBeatUtc: string ,
keyVaultUri: string ,
keyVaultId: string ,
}
,
applianceName: string ,
discoverySolutionId: string ,
serviceEndpoint: string ,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ImportSitesController_ListBySubscription (new)
Description List ImportSite resources by subscription ID
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/importSites
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
discoverySolutionId: string ,
masterSiteId: string ,
serviceEndpoint: string ,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MasterSitesController_ListBySubscription (new)
Description List MasterSite resources by subscription ID
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/masterSites
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
publicNetworkAccess: enum ,
allowMultipleSites: boolean ,
sites:
[
string ,
]
,
customerStorageAccountArmId: string ,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
provisioningState: enum ,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
nestedSites:
[
string ,
]
,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ServerSitesController_ListBySubscription (new)
Description List ServerSiteResource resources by subscription ID
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/serverSites
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
masterSiteId: string ,
servicePrincipalIdentityDetails:
{
tenantId: string ,
applicationId: string ,
objectId: string ,
audience: string ,
aadAuthority: string ,
rawCertData: string ,
}
,
agentDetails:
{
id: string ,
version: string ,
lastHeartBeatUtc: string ,
keyVaultUri: string ,
keyVaultId: string ,
}
,
applianceName: string ,
discoverySolutionId: string ,
serviceEndpoint: string ,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
SitesController_ListBySubscription (new)
Description Get all the vmware sites in the subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/vmwareSites
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
masterSiteId: string ,
servicePrincipalIdentityDetails:
{
tenantId: string ,
applicationId: string ,
objectId: string ,
audience: string ,
aadAuthority: string ,
rawCertData: string ,
}
,
agentDetails:
{
id: string ,
version: string ,
lastHeartBeatUtc: string ,
keyVaultUri: string ,
keyVaultId: string ,
}
,
applianceName: string ,
discoverySolutionId: string ,
serviceEndpoint: string ,
provisioningState: enum ,
}
,
eTag: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervSites_ListByResourceGroup (new)
Description Get all the hyperv sites in the subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
masterSiteId: string ,
servicePrincipalIdentityDetails:
{
tenantId: string ,
applicationId: string ,
objectId: string ,
audience: string ,
aadAuthority: string ,
rawCertData: string ,
}
,
agentDetails:
{
id: string ,
version: string ,
lastHeartBeatUtc: string ,
keyVaultUri: string ,
keyVaultId: string ,
}
,
applianceName: string ,
discoverySolutionId: string ,
serviceEndpoint: string ,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervSitesController_Get (new)
Description Get a HypervSite
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
}

⚐ Response (200)

{
properties:
{
masterSiteId: string ,
servicePrincipalIdentityDetails:
{
tenantId: string ,
applicationId: string ,
objectId: string ,
audience: string ,
aadAuthority: string ,
rawCertData: string ,
}
,
agentDetails:
{
id: string ,
version: string ,
lastHeartBeatUtc: string ,
keyVaultUri: string ,
keyVaultId: string ,
}
,
applianceName: string ,
discoverySolutionId: string ,
serviceEndpoint: string ,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervSitesController_Create (new)
Description Create a HypervSite
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
body:
{
properties:
{
masterSiteId: string ,
servicePrincipalIdentityDetails:
{
tenantId: string ,
applicationId: string ,
objectId: string ,
audience: string ,
aadAuthority: string ,
rawCertData: string ,
}
,
agentDetails:
{
id: string ,
version: string ,
lastHeartBeatUtc: string ,
keyVaultUri: string ,
keyVaultId: string ,
}
,
applianceName: string ,
discoverySolutionId: string ,
serviceEndpoint: string ,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
masterSiteId: string ,
servicePrincipalIdentityDetails:
{
tenantId: string ,
applicationId: string ,
objectId: string ,
audience: string ,
aadAuthority: string ,
rawCertData: string ,
}
,
agentDetails:
{
id: string ,
version: string ,
lastHeartBeatUtc: string ,
keyVaultUri: string ,
keyVaultId: string ,
}
,
applianceName: string ,
discoverySolutionId: string ,
serviceEndpoint: string ,
provisioningState: enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after: integer ,
}
,
$schema:
{
properties:
{
masterSiteId: string ,
servicePrincipalIdentityDetails:
{
tenantId: string ,
applicationId: string ,
objectId: string ,
audience: string ,
aadAuthority: string ,
rawCertData: string ,
}
,
agentDetails:
{
id: string ,
version: string ,
lastHeartBeatUtc: string ,
keyVaultUri: string ,
keyVaultId: string ,
}
,
applianceName: string ,
discoverySolutionId: string ,
serviceEndpoint: string ,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervSitesController_Update (new)
Description Update a HypervSite
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
body:
{
tags: object ,
properties:
{
servicePrincipalIdentityDetails:
{
tenantId: string ,
applicationId: string ,
objectId: string ,
audience: string ,
aadAuthority: string ,
rawCertData: string ,
}
,
agentDetails:
{
id: string ,
version: string ,
lastHeartBeatUtc: string ,
keyVaultUri: string ,
keyVaultId: string ,
}
,
applianceName: string ,
discoverySolutionId: string ,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
masterSiteId: string ,
servicePrincipalIdentityDetails:
{
tenantId: string ,
applicationId: string ,
objectId: string ,
audience: string ,
aadAuthority: string ,
rawCertData: string ,
}
,
agentDetails:
{
id: string ,
version: string ,
lastHeartBeatUtc: string ,
keyVaultUri: string ,
keyVaultId: string ,
}
,
applianceName: string ,
discoverySolutionId: string ,
serviceEndpoint: string ,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervSitesController_Delete (new)
Description Delete a HypervSite
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervDependencyMapController_ClientGroupMembers (new)
Description API to list client group members for the selected client group.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clientGroupMembers
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
mapRequest:
{
machineId: string ,
processGroupName: string ,
processName: string ,
startTime: string ,
endTime: string ,
filters:
{
machineIds:
[
string ,
]
,
processIds:
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervClusterController_ListByHypervSite (new)
Description List HypervCluster resources by HypervSite
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
filter: string ,
siteName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
createdTimestamp: string ,
updatedTimestamp: string ,
fqdn: string ,
functionalLevel: integer ,
status: string ,
runAsAccountId: string ,
hostFqdnList:
[
string ,
]
,
errors:
[
{
message: string ,
messageParameters: object ,
applianceName: string ,
id: integer ,
code: string ,
possibleCauses: string ,
recommendedAction: string ,
severity: string ,
summaryMessage: string ,
source: enum ,
updatedTimeStamp: string ,
runAsAccountId: string ,
discoveryScope: enum ,
}
,
]
,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervClusterController_GetCluster (new)
Description Method to get a Hyper-V cluster.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters/{clusterName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
clusterName: string ,
}

⚐ Response (200)

{
properties:
{
createdTimestamp: string ,
updatedTimestamp: string ,
fqdn: string ,
functionalLevel: integer ,
status: string ,
runAsAccountId: string ,
hostFqdnList:
[
string ,
]
,
errors:
[
{
message: string ,
messageParameters: object ,
applianceName: string ,
id: integer ,
code: string ,
possibleCauses: string ,
recommendedAction: string ,
severity: string ,
summaryMessage: string ,
source: enum ,
updatedTimeStamp: string ,
runAsAccountId: string ,
discoveryScope: enum ,
}
,
]
,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervClusterController_CreateCluster (new)
Description Method to create or update a Hyper-V cluster.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters/{clusterName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
clusterName: string ,
body:
{
properties:
{
createdTimestamp: string ,
updatedTimestamp: string ,
fqdn: string ,
functionalLevel: integer ,
status: string ,
runAsAccountId: string ,
hostFqdnList:
[
string ,
]
,
errors:
[
{
message: string ,
messageParameters: object ,
applianceName: string ,
id: integer ,
code: string ,
possibleCauses: string ,
recommendedAction: string ,
severity: string ,
summaryMessage: string ,
source: enum ,
updatedTimeStamp: string ,
runAsAccountId: string ,
discoveryScope: enum ,
}
,
]
,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
createdTimestamp: string ,
updatedTimestamp: string ,
fqdn: string ,
functionalLevel: integer ,
status: string ,
runAsAccountId: string ,
hostFqdnList:
[
string ,
]
,
errors:
[
{
message: string ,
messageParameters: object ,
applianceName: string ,
id: integer ,
code: string ,
possibleCauses: string ,
recommendedAction: string ,
severity: string ,
summaryMessage: string ,
source: enum ,
updatedTimeStamp: string ,
runAsAccountId: string ,
discoveryScope: enum ,
}
,
]
,
provisioningState: enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after: integer ,
}
,
$schema:
{
properties:
{
createdTimestamp: string ,
updatedTimestamp: string ,
fqdn: string ,
functionalLevel: integer ,
status: string ,
runAsAccountId: string ,
hostFqdnList:
[
string ,
]
,
errors:
[
{
message: string ,
messageParameters: object ,
applianceName: string ,
id: integer ,
code: string ,
possibleCauses: string ,
recommendedAction: string ,
severity: string ,
summaryMessage: string ,
source: enum ,
updatedTimeStamp: string ,
runAsAccountId: string ,
discoveryScope: enum ,
}
,
]
,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervClusterController_Delete (new)
Description Delete a HypervCluster
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters/{clusterName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
clusterName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervSitesController_ComputeErrorSummary (new)
Description Method to get site error summary.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/computeErrorSummary
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
body: object ,
}

⚐ Response (200)

{
applianceName: string ,
discoveryScopeErrorSummaries:
{
affectedResourceType: string ,
affectedObjectsCount: integer ,
discoveryScope: enum ,
}
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervSitesController_Computeusage (new)
Description Get a hyperv site usage.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/computeusage
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
body: object ,
}

⚐ Response (200)

{
machineCount: integer ,
runAsAccountCount: integer ,
hostCount: integer ,
clusterCount: integer ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervSitesController_ExportApplications (new)
Description Method to generate report containing machine and the deep discovery of the application installed in the machine.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportApplications
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
body: object ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervDependencyMapController_ExportDependencies (new)
Description API to generate report containing agentless dependencies.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportDependencies
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
requestBody:
{
startTime: string ,
endTime: string ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervSitesController_ExportMachineErrors (new)
Description Method to generate report containing machine and the errors encountered during guest discovery of the machine.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportMachineErrors
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
body:
{
properties:
{
discoveryScope: enum ,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervDependencyMapController_GenerateCoarseMap (new)
Description API to generate coarse map for the list of machines.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/generateCoarseMap
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
mapRequest:
{
startTime: string ,
endTime: string ,
filters:
{
machineIds:
[
string ,
]
,
processIds:
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervDependencyMapController_GenerateDetailedMap (new)
Description API to generate detailed map for a selected machine.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/generateDetailedMap
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
mapRequest:
{
machineId: string ,
startTime: string ,
endTime: string ,
filters:
{
machineIds:
[
string ,
]
,
processIds:
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervHostController_ListByHypervSite (new)
Description List HypervHost resources by HypervSite
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
filter: string ,
siteName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
createdTimestamp: string ,
updatedTimestamp: string ,
fqdn: string ,
runAsAccountId: string ,
version: string ,
errors:
[
{
message: string ,
messageParameters: object ,
applianceName: string ,
id: integer ,
code: string ,
possibleCauses: string ,
recommendedAction: string ,
severity: string ,
summaryMessage: string ,
source: enum ,
updatedTimeStamp: string ,
runAsAccountId: string ,
discoveryScope: enum ,
}
,
]
,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervHostController_Get (new)
Description Get a HypervHost
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts/{hostName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
hostName: string ,
}

⚐ Response (200)

{
properties:
{
createdTimestamp: string ,
updatedTimestamp: string ,
fqdn: string ,
runAsAccountId: string ,
version: string ,
errors:
[
{
message: string ,
messageParameters: object ,
applianceName: string ,
id: integer ,
code: string ,
possibleCauses: string ,
recommendedAction: string ,
severity: string ,
summaryMessage: string ,
source: enum ,
updatedTimeStamp: string ,
runAsAccountId: string ,
discoveryScope: enum ,
}
,
]
,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervHostController_Create (new)
Description Create a HypervHost
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts/{hostName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
hostName: string ,
body:
{
properties:
{
createdTimestamp: string ,
updatedTimestamp: string ,
fqdn: string ,
runAsAccountId: string ,
version: string ,
errors:
[
{
message: string ,
messageParameters: object ,
applianceName: string ,
id: integer ,
code: string ,
possibleCauses: string ,
recommendedAction: string ,
severity: string ,
summaryMessage: string ,
source: enum ,
updatedTimeStamp: string ,
runAsAccountId: string ,
discoveryScope: enum ,
}
,
]
,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
createdTimestamp: string ,
updatedTimestamp: string ,
fqdn: string ,
runAsAccountId: string ,
version: string ,
errors:
[
{
message: string ,
messageParameters: object ,
applianceName: string ,
id: integer ,
code: string ,
possibleCauses: string ,
recommendedAction: string ,
severity: string ,
summaryMessage: string ,
source: enum ,
updatedTimeStamp: string ,
runAsAccountId: string ,
discoveryScope: enum ,
}
,
]
,
provisioningState: enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after: integer ,
}
,
$schema:
{
properties:
{
createdTimestamp: string ,
updatedTimestamp: string ,
fqdn: string ,
runAsAccountId: string ,
version: string ,
errors:
[
{
message: string ,
messageParameters: object ,
applianceName: string ,
id: integer ,
code: string ,
possibleCauses: string ,
recommendedAction: string ,
severity: string ,
summaryMessage: string ,
source: enum ,
updatedTimeStamp: string ,
runAsAccountId: string ,
discoveryScope: enum ,
}
,
]
,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervHostController_Delete (new)
Description Delete a HypervHost
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts/{hostName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
hostName: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervJobs_ListByHypervSite (new)
Description List HypervJob resources by HypervSite
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/jobs
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
status: string ,
startTime: string ,
endTime: string ,
displayName: string ,
clientRequestId: string ,
activityId: string ,
errors:
[
{
code: string ,
message: string ,
possibleCauses: string ,
recommendedAction: string ,
severity: string ,
isAgentReportedError: boolean ,
agentErrorCode: string ,
agentErrorMessage: string ,
agentErrorPossibleCauses: string ,
agentErrorRecommendedAction: string ,
}
,
]
,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervJobs_Get (new)
Description Get a HypervJob
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/jobs/{jobName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
jobName: string ,
}

⚐ Response (200)

{
properties:
{
status: string ,
startTime: string ,
endTime: string ,
displayName: string ,
clientRequestId: string ,
activityId: string ,
errors:
[
{
code: string ,
message: string ,
possibleCauses: string ,
recommendedAction: string ,
severity: string ,
isAgentReportedError: boolean ,
agentErrorCode: string ,
agentErrorMessage: string ,
agentErrorPossibleCauses: string ,
agentErrorRecommendedAction: string ,
}
,
]
,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervSitesController_ListHealthSummary (new)
Description Method to get site health summary.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/listHealthSummary
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
siteName: string ,
}

⚐ Response (200)

{
value:
[
{
applianceName: string ,
errorMessage: string ,
summaryMessage: string ,
errorId: integer ,
errorCode: string ,
affectedObjectsCount: integer ,
hitCount: integer ,
severity: string ,
remediationGuidance: string ,
affectedResourceType: string ,
affectedResources:
[
string ,
]
,
fabricLayoutUpdateSources:
[
string ,
]
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HypervMachinesController_ListByHypervSite (new)
Description List HypervMachine resources by HypervSite
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
filter: string ,
top: integer ,
continuationToken: string ,
totalRecordCount: integer ,
siteName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
instanceUuid: string ,
hostFqdn: string ,
hostId: string ,
generation: integer ,
version: string ,
highAvailability: enum ,
clusterFqdn: string ,
clusterId: string ,
maxMemoryMb: integer ,
isDynamicMemoryEnabled: boolean ,
disks:
[
{
instanceId: string ,
vhdId: string ,
maxSizeInBytes: integer ,
name: string ,
diskType: string ,
lun: integer ,
path: string ,
}
,
]
,
networkAdapters:
[
{
networkId: string ,
subnetName: string ,
staticIpAddress: string ,
nicType: string ,
nicId: string ,
macAddress: string ,
ipAddressList:
[
string ,
]
,
networkName: string ,
ipAddressType: string ,
}
,
]
,
managementServerType: string ,
secureBootTemplateId: string ,
secureBootEnabled: boolean ,
secureBootTemplate: string ,
tpmEnabled: boolean ,
ksdEnabled: boolean ,
shieldingRequested: boolean ,
dataProtectionRequested: boolean ,
encryptStateAndVmMigrationTraffic: boolean ,
virtualizationBasedSecurityOptOut: boolean ,
powerStatus: string ,
vmFqdn: string ,
vmConfigurationFileLocation: string ,
firmware: string ,
guestOsDetails:
{
osType: string ,
osName: string ,
osVersion: string ,
osArchitecture: string ,
}
,
numberOfApplications: integer ,
guestDetailsDiscoveryTimestamp: string ,
isGuestDetailsDiscoveryInProgress: boolean ,
dependencyMapping: string ,
dependencyMappingStartTime: string ,
dependencyMappingEndTime: string ,
runAsAccountId: string ,
applianceNames:
[
string ,
]
,
errors:
[
{
message: