swagger: '2.0'
info:
version: 2020-08-01-preview
title: Microsoft Azure AccessControlClient AccessConnector HypervSitesController API
schemes:
- https
tags:
- name: HypervSitesController
paths:
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}:
get:
operationId: microsoftAzureHypervsitescontrollerGet
tags:
- HypervSitesController
description: Get a HypervSite
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/HypervSite'
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
HypervSitesController_Get_MaximumSet_Gen:
$ref: ./examples/HypervSitesController_Get_MaximumSet_Gen.json
summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename
put:
operationId: microsoftAzureHypervsitescontrollerCreate
tags:
- HypervSitesController
description: Create a HypervSite
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: body
in: body
description: Resource create parameters.
required: true
schema:
$ref: '#/definitions/HypervSite'
responses:
'200':
description: ARM update operation completed successfully.
schema:
$ref: '#/definitions/HypervSite'
'201':
description: ARM create operation completed successfully.
schema:
$ref: '#/definitions/HypervSite'
headers:
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
HypervSitesController_Create_MaximumSet_Gen:
$ref: ./examples/HypervSitesController_Create_MaximumSet_Gen.json
summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename
patch:
operationId: microsoftAzureHypervsitescontrollerUpdate
tags:
- HypervSitesController
description: Update a HypervSite
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: body
in: body
description: The resource properties to be updated.
required: true
schema:
$ref: '#/definitions/HypervSiteUpdate'
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/HypervSite'
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
HypervSitesController_Update_MaximumSet_Gen:
$ref: ./examples/HypervSitesController_Update_MaximumSet_Gen.json
summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename
delete:
operationId: microsoftAzureHypervsitescontrollerDelete
tags:
- HypervSitesController
description: Delete a HypervSite
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource deleted successfully.
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
HypervSitesController_Delete_MaximumSet_Gen:
$ref: ./examples/HypervSitesController_Delete_MaximumSet_Gen.json
summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/computeErrorSummary
: post:
operationId: microsoftAzureHypervsitescontrollerComputeerrorsummary
tags:
- HypervSitesController
description: Method to get site error summary.
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: body
in: body
description: The content of the action request
required: true
schema:
type: object
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/SiteErrorSummary'
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
HypervSitesController_ComputeErrorSummary_MaximumSet_Gen:
$ref: ./examples/HypervSitesController_ComputeErrorSummary_MaximumSet_Gen.json
summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename Computeerrorsummary
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/computeusage
: post:
operationId: microsoftAzureHypervsitescontrollerComputeusage
tags:
- HypervSitesController
description: Get a hyperv site usage.
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: body
in: body
description: The content of the action request
required: true
schema:
type: object
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/HypervSiteUsage'
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
HypervSitesController_Computeusage_MaximumSet_Gen:
$ref: ./examples/HypervSitesController_Computeusage_MaximumSet_Gen.json
summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename Computeusage
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportApplications
: post:
operationId: microsoftAzureHypervsitescontrollerExportapplications
tags:
- HypervSitesController
description: Method to generate report containing
machine and the deep discovery of the application installed in the machine.
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: body
in: body
description: The content of the action request
required: true
schema:
type: object
responses:
'200':
description: ARM operation completed successfully.
schema:
type: object
'202':
description: Resource operation accepted.
headers:
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
x-ms-examples:
HypervSitesController_ExportApplications_MaximumSet_Gen:
$ref: ./examples/HypervSitesController_ExportApplications_MaximumSet_Gen.json
summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename Exportapplications
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportMachineErrors
: post:
operationId: microsoftAzureHypervsitescontrollerExportmachineerrors
tags:
- HypervSitesController
description: Method to generate report containing
machine and the errors encountered during guest discovery of the machine.
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: body
in: body
description: The content of the action request
required: true
schema:
$ref: '#/definitions/ExportMachineErrorsRequest'
responses:
'200':
description: ARM operation completed successfully.
schema:
type: object
'202':
description: Resource operation accepted.
headers:
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
x-ms-examples:
HypervSitesController_ExportMachineErrors_MaximumSet_Gen:
$ref: ./examples/HypervSitesController_ExportMachineErrors_MaximumSet_Gen.json
summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename Exportmachineerrors
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/listHealthSummary
: post:
operationId: microsoftAzureHypervsitescontrollerListhealthsummary
tags:
- HypervSitesController
description: Method to get site health summary.
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/SiteHealthSummaryCollection'
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
HypervSitesController_ListHealthSummary_MaximumSet_Gen:
$ref: ./examples/HypervSitesController_ListHealthSummary_MaximumSet_Gen.json
summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename Listhealthsummary
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/summary
: post:
operationId: microsoftAzureHypervsitescontrollerSummary
tags:
- HypervSitesController
description: Method to get site usage.
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/HypervSiteUsage'
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
HypervSitesController_Summary_MaximumSet_Gen:
$ref: ./examples/HypervSitesController_Summary_MaximumSet_Gen.json
summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename Summary
definitions:
HypervSiteUpdateProperties:
type: object
description: The updatable properties of the HypervSite.
properties:
servicePrincipalIdentityDetails:
$ref: '#/definitions/SiteSpnProperties'
description: "Gets or sets the service principal identity details used by agent for\ncommunication\n to the service."
agentDetails:
$ref: '#/definitions/SiteAgentProperties'
description: Gets or sets the on-premises agent details.
applianceName:
type: string
description: Gets or sets the Appliance Name.
discoverySolutionId:
type: string
description: Gets or sets the ARM ID of migration hub solution for SDS.
provisioningState:
$ref: '#/definitions/ProvisioningState'
description: The status of the last operation.
SiteSpnProperties:
type: object
description: Class for site properties.
properties:
tenantId:
type: string
description: "Gets or sets the tenant Id for the service principal with which the\non-premise\n management/data plane components would communicate with\nour Azure services."
applicationId:
type: string
description: "Gets or sets the application/client Id for the service principal with which\nthe\n on-premise management/data plane components would communicate\nwith our Azure \n services."
objectId:
type: string
description: "Gets or sets the object Id of the service principal with which the on-premise\n\n management/data plane components would communicate with our Azure\nservices."
audience:
type: string
description: Gets or sets the intended audience for the service principal.
aadAuthority:
type: string
description: "Gets or sets the AAD Authority URL which was used to request the token for\nthe\n service principal."
rawCertData:
type: string
description: Gets or sets the raw certificate data for building certificate expiry flows.
DiscoveryScopes:
type: string
description: Discovery scopes
enum:
- AppsAndRoles
- DependencyMap
- StaticData
- SQLServerConnectionInfo
x-ms-enum:
name: DiscoveryScopes
modelAsString: true
values:
- name: AppsAndRoles
value: AppsAndRoles
description: AppsAndRoles value.
- name: DependencyMap
value: DependencyMap
description: DependencyMap value.
- name: StaticData
value: StaticData
description: StaticData value.
- name: SQLServerConnectionInfo
value: SQLServerConnectionInfo
description: SQLServerConnectionInfo value.
SiteHealthSummaryFabricLayoutUpdateSourcesItem:
type: string
description: SiteHealthSummary FabricLayout UpdateSources
enum:
- RefreshFabricLayout
- RefreshFabricLayoutGuest
- RefreshFabricLayoutDependencyMap
x-ms-enum:
name: SiteHealthSummaryFabricLayoutUpdateSourcesItem
modelAsString: true
values:
- name: RefreshFabricLayout
value: RefreshFabricLayout
description: RefreshFabricLayout value.
- name: RefreshFabricLayoutGuest
value: RefreshFabricLayoutGuest
description: RefreshFabricLayoutGuest value.
- name: RefreshFabricLayoutDependencyMap
value: RefreshFabricLayoutDependencyMap
description: RefreshFabricLayoutDependencyMap value.
HypervSite:
type: object
description: A HyperV SiteResource
properties:
properties:
$ref: '#/definitions/SiteProperties'
description: The resource-specific properties for this resource.
x-ms-client-flatten: true
x-ms-mutability:
- read
- create
allOf:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
SiteHealthSummary:
type: object
description: The properties of ServerSiteResource.
properties:
applianceName:
type: string
description: Gets the appliance name.
readOnly: true
errorMessage:
type: string
description: Gets the error message.
readOnly: true
summaryMessage:
type: string
description: Gets the summary message.
readOnly: true
errorId:
type: integer
format: int64
description: Gets the error Id.
readOnly: true
errorCode:
type: string
description: Gets the error code.
readOnly: true
affectedObjectsCount:
type: integer
format: int64
description: Gets or sets the count of affected objects.
hitCount:
type: integer
format: int64
description: Gets or sets the hit count of the error.
severity:
type: string
description: Gets the severity of error.
readOnly: true
remediationGuidance:
type: string
description: Gets the remediation guidance.
readOnly: true
affectedResourceType:
type: string
description: Gets the affected resource type.
readOnly: true
affectedResources:
type: array
description: Gets or sets the affected resources.
items:
type: string
fabricLayoutUpdateSources:
type: array
description: Gets or sets sources of the exception.
items:
$ref: '#/definitions/SiteHealthSummaryFabricLayoutUpdateSourcesItem'
ProvisioningState:
type: string
description: The status of the current operation.
enum:
- Created
- Updated
- Running
- Completed
- Failed
- Succeeded
- Canceled
x-ms-enum:
name: ProvisioningState
modelAsString: true
values:
- name: Created
value: Created
description: Created value.
- name: Updated
value: Updated
description: Updated value.
- name: Running
value: Running
description: Running value.
- name: Completed
value: Completed
description: Completed value.
- name: Failed
value: Failed
description: Failed value.
- name: Succeeded
value: Succeeded
description: Succeeded value.
- name: Canceled
value: Canceled
description: Canceled value.
SiteProperties:
type: object
description: The properties of VMwareSiteResource
properties:
masterSiteId:
type: string
description: Gets the Master Site this site is linked to.
readOnly: true
servicePrincipalIdentityDetails:
$ref: '#/definitions/SiteSpnProperties'
description: "Gets or sets the service principal identity details used by agent for\ncommunication\n to the service."
agentDetails:
$ref: '#/definitions/SiteAgentProperties'
description: Gets or sets the on-premises agent details.
applianceName:
type: string
description: Gets or sets the Appliance Name.
discoverySolutionId:
type: string
description: Gets or sets the ARM ID of migration hub solution for SDS.
serviceEndpoint:
type: string
description: Gets the service endpoint.
readOnly: true
provisioningState:
$ref: '#/definitions/ProvisioningState'
description: The status of the last operation.
DiscoveryScopeErrorSummary:
type: object
description: The site error summary model.
properties:
affectedResourceType:
type: string
description: Gets or sets the affected resource type.
affectedObjectsCount:
type: integer
format: int64
description: Count of affected objects.
discoveryScope:
$ref: '#/definitions/DiscoveryScopes'
description: Gets or sets the count of affected objects.
required:
- affectedResourceType
- affectedObjectsCount
- discoveryScope
SiteAgentProperties:
type: object
description: Class for site agent properties.
properties:
id:
type: string
description: Gets the ID of the agent.
readOnly: true
version:
type: string
description: Gets the version of the agent.
readOnly: true
lastHeartBeatUtc:
type: string
format: date-time
description: Gets the last heartbeat time of the agent in UTC.
readOnly: true
keyVaultUri:
type: string
description: Gets or sets the key vault URI.
keyVaultId:
type: string
description: Gets or sets the key vault ARM Id.
SiteHealthSummaryCollection:
type: object
description: Collection of SiteHealthSummary.
properties:
value:
type: array
description: Gets the list of SiteHealthSummary.
items:
$ref: '#/definitions/SiteHealthSummary'
x-ms-identifiers:
- applianceName
nextLink:
type: string
description: Gets the value of next link.
readOnly: true
required:
- value
HypervSiteUsage:
type: object
description: Hyper-V site usage.
properties:
machineCount:
type: integer
format: int32
description: Gets or sets the number of machines discovered in the site.
runAsAccountCount:
type: integer
format: int32
description: Gets or sets the number of run as accounts in the site.
hostCount:
type: integer
format: int32
description: Gets or sets the number of hosts part of the site.
clusterCount:
type: integer
format: int32
description: Gets or sets the number of clusters part of the site.
HypervSiteUpdate:
type: object
description: The type used for update operations of the HypervSite.
properties:
tags:
type: object
description: Resource tags.
additionalProperties:
type: string
properties:
$ref: '#/definitions/HypervSiteUpdateProperties'
x-ms-client-flatten: true
SiteErrorSummary:
type: object
description: Site error summary.
properties:
applianceName:
type: string
description: Appliance Name.
discoveryScopeErrorSummaries:
$ref: '#/definitions/DiscoveryScopeErrorSummary'
description: Gets the error message.
nextLink:
type: string
description: The link to fetch more models.
required:
- applianceName
- discoveryScopeErrorSummaries
ExportMachineErrorsProperties:
type: string
description: Export Machine Errors Properties
enum:
- AppsAndRoles
- DependencyMap
- StaticData
- SQLServerConnectionInfo
x-ms-enum:
name: ExportMachineErrorsProperties
modelAsString: true
values:
- name: AppsAndRoles
value: AppsAndRoles
description: AppsAndRoles value.
- name: DependencyMap
value: DependencyMap
description: DependencyMap value.
- name: StaticData
value: StaticData
description: StaticData value.
- name: SQLServerConnectionInfo
value: SQLServerConnectionInfo
description: SQLServerConnectionInfo value.
RequestExportMachineErrorsProperties:
type: object
description: The Properties class for export machine errors request body.
properties:
discoveryScope:
$ref: '#/definitions/ExportMachineErrorsProperties'
description: Gets or sets the discovery scope.
ExportMachineErrorsRequest:
type: object
description: The body of export machine errors request.
properties:
properties:
$ref: '#/definitions/RequestExportMachineErrorsProperties'
description: Gets or sets the properties.
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'