Sites - Get Site

Service:

Azure Migrate

API Version:

2020-01-01

Method to get a site.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/VMwareSites/{siteName}?api-version=2020-01-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
siteName	path	True	string	Site name.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	VMwareSite	OK

Examples

Get VMware site

Sample request

HTTP

GET https://management.azure.com/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.OffAzure/VMwareSites/pajind_site1?api-version=2020-01-01

Sample response

Status code:

200

{
  "id": "/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.OffAzure/VMwareSites/pajind_site1",
  "name": "pajind_site1",
  "type": "Microsoft.OffAzure/vmwaresites",
  "eTag": null,
  "location": "",
  "properties": {
    "servicePrincipalIdentityDetails": {
      "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
      "applicationId": "e9f013df-2a2a-4871-b766-e79867f30348",
      "objectId": "2cd492bc-7ef3-4ee0-b301-59a88108b47b",
      "audience": "https://72f988bf-86f1-41af-91ab-2d7cd011db47/MaheshSite17ac9agentauthaadapp",
      "aadAuthority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47",
      "rawCertData": "string"
    },
    "agentDetails": {
      "id": "6cf06006-b736-5081-9a10-41aa2f87bd84-agent",
      "version": null,
      "lastHeartBeatUtc": null,
      "keyVaultUri": "string",
      "keyVaultId": "string"
    },
    "serviceEndpoint": "https://localhost",
    "discoverySolutionId": "string",
    "applianceName": "string"
  }
}

Definitions

Name	Description
SiteAgentProperties	Class for site agent properties.
SiteProperties	Class for site properties.
SiteSpnProperties	Class for site properties.
VMwareSite	Site REST Resource.

SiteAgentProperties

Object

Class for site agent properties.

Name	Type	Description
id	string	ID of the agent.
keyVaultId	string	Key vault ARM Id.
keyVaultUri	string	Key vault URI.
lastHeartBeatUtc	string (date-time)	Last heartbeat time of the agent in UTC.
version	string	Version of the agent.

SiteProperties

Object

Class for site properties.

Name	Type	Description
agentDetails	SiteAgentProperties	On-premises agent details.
applianceName	string	Appliance Name.
discoverySolutionId	string	ARM ID of migration hub solution for SDS.
serviceEndpoint	string	Service endpoint.
servicePrincipalIdentityDetails	SiteSpnProperties	Service principal identity details used by agent for communication to the service.

SiteSpnProperties

Object

Class for site properties.

Name	Type	Description
aadAuthority	string	AAD Authority URL which was used to request the token for the service principal.
applicationId	string	Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
audience	string	Intended audience for the service principal.
objectId	string	Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.
rawCertData	string	Raw certificate data for building certificate expiry flows.
tenantId	string	Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.

VMwareSite

Object

Site REST Resource.

Name	Type	Description
eTag	string	eTag for concurrency control.
id	string	Resource Id.
location	string	Azure location in which Sites is created.
name	string	Name of the VMware site.
properties	SiteProperties	Nested properties of VMWare site.
tags	object
type	string	Type of resource. Type = Microsoft.OffAzure/VMWareSites.