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:
{
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). ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervSites_ListBySubscription (new)
Description :  Get all the hyperv sites in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/hypervSites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HypervSite items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportSitesController_ListBySubscription (new)
Description :  List ImportSite resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/importSites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ImportSite items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MasterSitesController_ListBySubscription (new)
Description :  List MasterSite resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/masterSites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MasterSite items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Gets or sets the state of public network access. ,
Enum:
{
NotSpecified: NotSpecified value. ,
Enabled: Enabled value. ,
Disabled: Disabled value. ,
}
,
Required: False ,
}
enum ,
allowMultipleSites:
{
Description: Gets or sets a value indicating whether multiple sites per site type are allowed. ,
Required: False ,
}
boolean ,
sites:
{
Description: Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name. ,
Required: False ,
}
[
string ,
]
,
customerStorageAccountArmId:
{
Description: Gets or sets a value for customer storage account ARM id. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: array of group ids ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: private endpoints ,
Required: False ,
}
{
id:
{
Description: id name ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: private endpoints connection state ,
Required: False ,
}
{
status:
{
Description: state status ,
Enum:
{
Approved: Approved value. ,
Pending: Pending value. ,
Rejected: Rejected value. ,
Disconnected: Disconnected value. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: description string ,
Required: False ,
}
string ,
actionsRequired:
{
Description: actions required ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nestedSites:
{
Description: Gets the nested sites under Master Site. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_ListBySubscription (new)
Description :  List ServerSiteResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/serverSites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ServerSiteResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_ListBySubscription (new)
Description :  Get all the vmware sites in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/vmwareSites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VmwareSite items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HypervSite items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervSitesController_Get (new)
Description :  Get a HypervSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervSitesController_Create (new)
Description :  Create a HypervSite
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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: A HyperV SiteResource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervSitesController_Update (new)
Description :  Update a HypervSite
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The updatable properties of the HypervSite. ,
Required: False ,
}
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervSitesController_Delete (new)
Description :  Delete a HypervSite
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
machineId:
{
Description: id of machine ,
Required: False ,
}
string ,
processGroupName:
{
Description: process group name ,
Required: False ,
}
string ,
processName:
{
Description: name of process ,
Required: False ,
}
string ,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
filters:
{
Description: optional filters ,
Required: False ,
}
{
machineIds:
{
Description: array of machine ids ,
Required: False ,
}
[
string ,
]
,
processIds:
{
Description: array of process Ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HypervCluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Gets the timestamp marking Hyper-V cluster creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the Hyper-V cluster. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the Hyper-V cluster. ,
Required: False ,
}
string ,
functionalLevel:
{
Description: Gets the functional level of the Hyper-V cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Gets the status of the Hyper-V cluster. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets Run as account ID of the Hyper-V cluster. ,
Required: False ,
}
string ,
hostFqdnList:
{
Description: Gets or sets list of hosts (FQDN) currently being tracked by the cluster. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
clusterName:
{
Description: Cluster ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Gets the timestamp marking Hyper-V cluster creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the Hyper-V cluster. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the Hyper-V cluster. ,
Required: False ,
}
string ,
functionalLevel:
{
Description: Gets the functional level of the Hyper-V cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Gets the status of the Hyper-V cluster. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets Run as account ID of the Hyper-V cluster. ,
Required: False ,
}
string ,
hostFqdnList:
{
Description: Gets or sets list of hosts (FQDN) currently being tracked by the cluster. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
clusterName:
{
Description: Cluster ARM name ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Gets the timestamp marking Hyper-V cluster creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the Hyper-V cluster. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the Hyper-V cluster. ,
Required: False ,
}
string ,
functionalLevel:
{
Description: Gets the functional level of the Hyper-V cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Gets the status of the Hyper-V cluster. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets Run as account ID of the Hyper-V cluster. ,
Required: False ,
}
string ,
hostFqdnList:
{
Description: Gets or sets list of hosts (FQDN) currently being tracked by the cluster. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Gets the timestamp marking Hyper-V cluster creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the Hyper-V cluster. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the Hyper-V cluster. ,
Required: False ,
}
string ,
functionalLevel:
{
Description: Gets the functional level of the Hyper-V cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Gets the status of the Hyper-V cluster. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets Run as account ID of the Hyper-V cluster. ,
Required: False ,
}
string ,
hostFqdnList:
{
Description: Gets or sets list of hosts (FQDN) currently being tracked by the cluster. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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: A cluster resource belonging to a site resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Gets the timestamp marking Hyper-V cluster creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the Hyper-V cluster. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the Hyper-V cluster. ,
Required: False ,
}
string ,
functionalLevel:
{
Description: Gets the functional level of the Hyper-V cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Gets the status of the Hyper-V cluster. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets Run as account ID of the Hyper-V cluster. ,
Required: False ,
}
string ,
hostFqdnList:
{
Description: Gets or sets list of hosts (FQDN) currently being tracked by the cluster. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervClusterController_Delete (new)
Description :  Delete a HypervCluster
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
clusterName:
{
Description: Cluster ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
applianceName:
{
Description: Appliance Name. ,
Required: True ,
}
string ,
discoveryScopeErrorSummaries:
{
Description: Gets the error message. ,
Required: True ,
}
{
affectedResourceType:
{
Description: Gets or sets the affected resource type. ,
Required: True ,
}
string ,
affectedObjectsCount:
{
Description: Count of affected objects. ,
Format: int64 ,
Required: True ,
}
integer ,
discoveryScope:
{
Description: Gets or sets the count of affected objects. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
}
,
Required: True ,
}
enum ,
}
,
nextLink:
{
Description: The link to fetch more models. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
machineCount:
{
Description: Gets or sets the number of machines discovered in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsAccountCount:
{
Description: Gets or sets the number of run as accounts in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
hostCount:
{
Description: Gets or sets the number of hosts part of the site. ,
Format: int32 ,
Required: False ,
}
integer ,
clusterCount:
{
Description: Gets or sets the number of clusters part of the site. ,
Format: int32 ,
Required: False ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
requestBody:
{
Description: The content of the action request ,
Required: True ,
}
{
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
discoveryScope:
{
Description: Gets or sets the discovery scope. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
filters:
{
Description: optional filters ,
Required: False ,
}
{
machineIds:
{
Description: array of machine ids ,
Required: False ,
}
[
string ,
]
,
processIds:
{
Description: array of process Ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
machineId:
{
Description: id of machine ,
Required: False ,
}
string ,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
filters:
{
Description: optional filters ,
Required: False ,
}
{
machineIds:
{
Description: array of machine ids ,
Required: False ,
}
[
string ,
]
,
processIds:
{
Description: array of process Ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervHostController_ListByHypervSite (new)
Description :  List HypervHost resources by HypervSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HypervHost items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Gets the timestamp marking Hyper-V host creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the Hyper-V host. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the Hyper-V host. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the Hyper-V host. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the Hyper-V host. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervHostController_Get (new)
Description :  Get a HypervHost
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts/{hostName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
hostName:
{
Description: Host name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Gets the timestamp marking Hyper-V host creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the Hyper-V host. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the Hyper-V host. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the Hyper-V host. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the Hyper-V host. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervHostController_Create (new)
Description :  Create a HypervHost
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts/{hostName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
hostName:
{
Description: Host name ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Gets the timestamp marking Hyper-V host creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the Hyper-V host. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the Hyper-V host. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the Hyper-V host. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the Hyper-V host. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Gets the timestamp marking Hyper-V host creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the Hyper-V host. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the Hyper-V host. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the Hyper-V host. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the Hyper-V host. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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: A host resource belonging to a site resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Gets the timestamp marking Hyper-V host creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the Hyper-V host. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the Hyper-V host. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the Hyper-V host. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the Hyper-V host. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervHostController_Delete (new)
Description :  Delete a HypervHost
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts/{hostName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
hostName:
{
Description: Host name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HypervJob items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
status:
{
Description: Gets operation status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets operation start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets operation end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the display name of the Job. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id used in the operation execution context. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id used in the operation execution context. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
isAgentReportedError:
{
Description: Gets a value indicating whether the error originated from a agent or not. ,
Required: False ,
}
boolean ,
agentErrorCode:
{
Description: Gets the agent error code. ,
Required: False ,
}
string ,
agentErrorMessage:
{
Description: Gets the error message from the agent. ,
Required: False ,
}
string ,
agentErrorPossibleCauses:
{
Description: Gets possible causes for the agent error. ,
Required: False ,
}
string ,
agentErrorRecommendedAction:
{
Description: Gets the recommended action for the agent error. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervJobs_Get (new)
Description :  Get a HypervJob
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/jobs/{jobName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
jobName:
{
Description: Job name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
status:
{
Description: Gets operation status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets operation start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets operation end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the display name of the Job. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id used in the operation execution context. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id used in the operation execution context. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
isAgentReportedError:
{
Description: Gets a value indicating whether the error originated from a agent or not. ,
Required: False ,
}
boolean ,
agentErrorCode:
{
Description: Gets the agent error code. ,
Required: False ,
}
string ,
agentErrorMessage:
{
Description: Gets the error message from the agent. ,
Required: False ,
}
string ,
agentErrorPossibleCauses:
{
Description: Gets possible causes for the agent error. ,
Required: False ,
}
string ,
agentErrorRecommendedAction:
{
Description: Gets the recommended action for the agent error. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of SiteHealthSummary. ,
Required: True ,
}
[
{
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the summary message. ,
Required: False ,
}
string ,
errorId:
{
Description: Gets the error Id. ,
Format: int64 ,
Required: False ,
}
integer ,
errorCode:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
affectedObjectsCount:
{
Description: Gets or sets the count of affected objects. ,
Format: int64 ,
Required: False ,
}
integer ,
hitCount:
{
Description: Gets or sets the hit count of the error. ,
Format: int64 ,
Required: False ,
}
integer ,
severity:
{
Description: Gets the severity of error. ,
Required: False ,
}
string ,
remediationGuidance:
{
Description: Gets the remediation guidance. ,
Required: False ,
}
string ,
affectedResourceType:
{
Description: Gets the affected resource type. ,
Required: False ,
}
string ,
affectedResources:
{
Description: Gets or sets the affected resources. ,
Required: False ,
}
[
string ,
]
,
fabricLayoutUpdateSources:
{
Description: Gets or sets sources of the exception. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: Gets the value of next link. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervMachinesController_ListByHypervSite (new)
Description :  List HypervMachine resources by HypervSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HypervMachine items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
instanceUuid:
{
Description: On-premise Instance UUID of the machine. ,
Required: False ,
}
string ,
hostFqdn:
{
Description: Host FQDN/IPAddress. ,
Required: False ,
}
string ,
hostId:
{
Description: Host ARM ID. ,
Required: False ,
}
string ,
generation:
{
Description: Generation of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: VM version. ,
Required: False ,
}
string ,
highAvailability:
{
Description: Value indicating whether the VM is highly available. ,
Enum:
{
Unknown: Unknown value. ,
No: No value. ,
Yes: Yes value. ,
}
,
Required: False ,
}
enum ,
clusterFqdn:
{
Description: Cluster FQDN/IPAddress. ,
Required: False ,
}
string ,
clusterId:
{
Description: Cluster ARM ID. ,
Required: False ,
}
string ,
maxMemoryMb:
{
Description: Max memory of the virtual machine in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicMemoryEnabled:
{
Description: Value indicating whether dynamic memory is enabled for the VM. ,
Required: False ,
}
boolean ,
disks:
{
Description: Disks attached to the machine. ,
Required: False ,
}
[
{
instanceId:
{
Description: Id of the disk. ,
Required: False ,
}
string ,
vhdId:
{
Description: VHD Id of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: Gets or sets Bytes allocated for the disk. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets Name of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: Gets or sets Type of the disk. ,
Required: False ,
}
string ,
lun:
{
Description: Gets or sets LUN of the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets Path of the disk. ,
Required: False ,
}
string ,
}
,
]
,
networkAdapters:
{
Description: Network adapters attached to the machine. ,
Required: False ,
}
[
{
networkId:
{
Description: Network Id. ,
Required: False ,
}
string ,
subnetName:
{
Description: Name of the VM subnet within the virtual network the NIC is attached to. ,
Required: False ,
}
string ,
staticIpAddress:
{
Description: Static IP address. ,
Required: False ,
}
string ,
nicType:
{
Description: Mac address of the NIC. ,
Required: False ,
}
string ,
nicId:
{
Description: Gets or sets the NIC Id. ,
Required: False ,
}
string ,
macAddress:
{
Description: Gets or sets Mac address of the NIC. ,
Required: False ,
}
string ,
ipAddressList:
{
Description: Gets IP addresses for the machine. ,
Required: False ,
}
[
string ,
]
,
networkName:
{
Description: Gets or sets Network Name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: Gets or sets Type of the IP address. ,
Required: False ,
}
string ,
}
,
]
,
managementServerType:
{
Description: Management server type captured as a string representation of the {Microsoft.Azure.FDS.WebRole.HyperVMachineBase.HyperVMachineBaseProperties.ManagementServerType} enumeration. ,
Required: False ,
}
string ,
secureBootTemplateId:
{
Description: Gets or sets the SecureBootTemplateId setting of the VM. ,
Required: False ,
}
string ,
secureBootEnabled:
{
Description: Gets or sets a value indicating whether Secure boot is enabled for the VM. ,
Required: False ,
}
boolean ,
secureBootTemplate:
{
Description: Gets or sets the SecureBootTemplateId setting of the VM. ,
Required: False ,
}
string ,
tpmEnabled:
{
Description: Gets or sets a value indicating whether trusted platform module is enabled on the VM. ,
Required: False ,
}
boolean ,
ksdEnabled:
{
Description: Gets or sets a value indicating whether key storage device is enabled on the VM. ,
Required: False ,
}
boolean ,
shieldingRequested:
{
Description: Gets or sets a value indicating whether shielding is enabled for the VM. ,
Required: False ,
}
boolean ,
dataProtectionRequested:
{
Description: Gets or sets a value indicating whether data protection is requested for a VM. ,
Required: False ,
}
boolean ,
encryptStateAndVmMigrationTraffic:
{
Description: Gets or sets a value indicating whether encryption of state and migration traffic is enabled for the VM. ,
Required: False ,
}
boolean ,
virtualizationBasedSecurityOptOut:
{
Description: Gets or sets a value indicating whether VM virtualization based security is enabled for the VM. ,
Required: False ,
}
boolean ,
powerStatus:
{
Description: Gets the Machine power status. ,
Required: False ,
}
string ,
vmFqdn:
{
Description: Gets the VM FQDN. ,
Required: False ,
}
string ,
vmConfigurationFileLocation:
{
Description: Gets the Root location of the VM configuration file. ,
Required: False ,
}
string ,
firmware:
{
Description: Gets or sets the firmware. ,
Required: False ,
}
string ,
guestOsDetails:
{
Description: Operating System Details extracted from the guest bu executing script inside the guest VM. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
numberOfApplications:
{
Description: Number of applications installed in the guest VM. ,
Format: int32 ,
Required: False ,
}
integer ,
guestDetailsDiscoveryTimestamp:
{
Description: The last time at which the Guest Details was discovered or the error while discovering guest details based discovery of the machine. ,
Format: date-time ,
Required: False ,
}
string ,
isGuestDetailsDiscoveryInProgress:
{
Description: Whether Refresh Fabric Layout Guest Details has been completed once. Portal will show discovery in progress, if this value is true. ,
Required: False ,
}
boolean ,
dependencyMapping:
{
Description: Gets or sets if dependency mapping feature is enabled or not for the VM. ,
Required: False ,
}
string ,
dependencyMappingStartTime:
{
Description: Gets or sets when dependency mapping collection is last started. ,
Format: date-time ,
Required: False ,
}
string ,
dependencyMappingEndTime:
{
Description: Gets or sets when dependency mapping collection was last disabled. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the machine. ,
Required: False ,
}
string ,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Errors for machine. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationDiscovery:
{
Description: Gets the data related to application discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
dependencyMapDiscovery:
{
Description: Gets the data related to dependency map discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
staticDiscovery:
{
Description: Gets the data related to static discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
sqlDiscovery:
{
Description: Gets the data related to SQL discovery. ,
Required: False ,
}
{
successfullyDiscoveredServerCount:
{
Description: successfully Discovered ServerCount ,
Format: int32 ,
Required: False ,
}
integer ,
totalServerCount:
{
Description: total Server Count ,
Format: int32 ,
Required: False ,
}
integer ,
sqlMetadataHydratedRunAsAccountId:
{
Description: sql Metadata Hydrated RunAsAccountId ,
Required: False ,
}
string ,
sqlMetadataDiscoveryPipe:
{
Description: sql Metadata DiscoveryPipe ,
Enum:
{
Unknown: Unknown value. ,
VMware: VMware value. ,
PowerShell: PowerShell value. ,
SSH: SSH value. ,
CIM: CIM value. ,
Other: Other value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: discovery Scope Status ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
webAppDiscovery:
{
Description: Gets the data related to Web application discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
oracleDiscovery:
{
Description: Gets the data related to Oracle discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalDatabaseCount:
{
Description: Gets or sets number of successfully discovered databases. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
springBootDiscovery:
{
Description: Gets the data related to SpringBoot discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplicationCount:
{
Description: Gets or sets number of successfully discovered applications. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
iisDiscovery:
{
Description: Gets the data related to iis discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
tomcatDiscovery:
{
Description: Gets the data related to tomcat discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
appsAndRoles:
{
Description: Apps And Roles of the Server. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: double ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the Display name of the machine. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Value indicating whether VM is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the marking machine creation. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the resource. ,
Required: False ,
}
object ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
arcDiscovery:
{
Description: Gets the data related to Azure arc discovery. ,
Required: False ,
}
{
status:
{
Description: AzureArc status indicates whether arc discovery has successfully completed or not. ,
Enum:
{
Unknown: Unknown value. ,
NotEnabled: Not enabled value. ,
Enabled: Enabled value. ,
}
,
Required: True ,
}
enum ,
machineResourceId:
{
Description: Machine Resource Id. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervMachinesController_Get (new)
Description :  Get a HypervMachine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: HypervMachine name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
instanceUuid:
{
Description: On-premise Instance UUID of the machine. ,
Required: False ,
}
string ,
hostFqdn:
{
Description: Host FQDN/IPAddress. ,
Required: False ,
}
string ,
hostId:
{
Description: Host ARM ID. ,
Required: False ,
}
string ,
generation:
{
Description: Generation of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: VM version. ,
Required: False ,
}
string ,
highAvailability:
{
Description: Value indicating whether the VM is highly available. ,
Enum:
{
Unknown: Unknown value. ,
No: No value. ,
Yes: Yes value. ,
}
,
Required: False ,
}
enum ,
clusterFqdn:
{
Description: Cluster FQDN/IPAddress. ,
Required: False ,
}
string ,
clusterId:
{
Description: Cluster ARM ID. ,
Required: False ,
}
string ,
maxMemoryMb:
{
Description: Max memory of the virtual machine in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicMemoryEnabled:
{
Description: Value indicating whether dynamic memory is enabled for the VM. ,
Required: False ,
}
boolean ,
disks:
{
Description: Disks attached to the machine. ,
Required: False ,
}
[
{
instanceId:
{
Description: Id of the disk. ,
Required: False ,
}
string ,
vhdId:
{
Description: VHD Id of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: Gets or sets Bytes allocated for the disk. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets Name of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: Gets or sets Type of the disk. ,
Required: False ,
}
string ,
lun:
{
Description: Gets or sets LUN of the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets Path of the disk. ,
Required: False ,
}
string ,
}
,
]
,
networkAdapters:
{
Description: Network adapters attached to the machine. ,
Required: False ,
}
[
{
networkId:
{
Description: Network Id. ,
Required: False ,
}
string ,
subnetName:
{
Description: Name of the VM subnet within the virtual network the NIC is attached to. ,
Required: False ,
}
string ,
staticIpAddress:
{
Description: Static IP address. ,
Required: False ,
}
string ,
nicType:
{
Description: Mac address of the NIC. ,
Required: False ,
}
string ,
nicId:
{
Description: Gets or sets the NIC Id. ,
Required: False ,
}
string ,
macAddress:
{
Description: Gets or sets Mac address of the NIC. ,
Required: False ,
}
string ,
ipAddressList:
{
Description: Gets IP addresses for the machine. ,
Required: False ,
}
[
string ,
]
,
networkName:
{
Description: Gets or sets Network Name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: Gets or sets Type of the IP address. ,
Required: False ,
}
string ,
}
,
]
,
managementServerType:
{
Description: Management server type captured as a string representation of the {Microsoft.Azure.FDS.WebRole.HyperVMachineBase.HyperVMachineBaseProperties.ManagementServerType} enumeration. ,
Required: False ,
}
string ,
secureBootTemplateId:
{
Description: Gets or sets the SecureBootTemplateId setting of the VM. ,
Required: False ,
}
string ,
secureBootEnabled:
{
Description: Gets or sets a value indicating whether Secure boot is enabled for the VM. ,
Required: False ,
}
boolean ,
secureBootTemplate:
{
Description: Gets or sets the SecureBootTemplateId setting of the VM. ,
Required: False ,
}
string ,
tpmEnabled:
{
Description: Gets or sets a value indicating whether trusted platform module is enabled on the VM. ,
Required: False ,
}
boolean ,
ksdEnabled:
{
Description: Gets or sets a value indicating whether key storage device is enabled on the VM. ,
Required: False ,
}
boolean ,
shieldingRequested:
{
Description: Gets or sets a value indicating whether shielding is enabled for the VM. ,
Required: False ,
}
boolean ,
dataProtectionRequested:
{
Description: Gets or sets a value indicating whether data protection is requested for a VM. ,
Required: False ,
}
boolean ,
encryptStateAndVmMigrationTraffic:
{
Description: Gets or sets a value indicating whether encryption of state and migration traffic is enabled for the VM. ,
Required: False ,
}
boolean ,
virtualizationBasedSecurityOptOut:
{
Description: Gets or sets a value indicating whether VM virtualization based security is enabled for the VM. ,
Required: False ,
}
boolean ,
powerStatus:
{
Description: Gets the Machine power status. ,
Required: False ,
}
string ,
vmFqdn:
{
Description: Gets the VM FQDN. ,
Required: False ,
}
string ,
vmConfigurationFileLocation:
{
Description: Gets the Root location of the VM configuration file. ,
Required: False ,
}
string ,
firmware:
{
Description: Gets or sets the firmware. ,
Required: False ,
}
string ,
guestOsDetails:
{
Description: Operating System Details extracted from the guest bu executing script inside the guest VM. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
numberOfApplications:
{
Description: Number of applications installed in the guest VM. ,
Format: int32 ,
Required: False ,
}
integer ,
guestDetailsDiscoveryTimestamp:
{
Description: The last time at which the Guest Details was discovered or the error while discovering guest details based discovery of the machine. ,
Format: date-time ,
Required: False ,
}
string ,
isGuestDetailsDiscoveryInProgress:
{
Description: Whether Refresh Fabric Layout Guest Details has been completed once. Portal will show discovery in progress, if this value is true. ,
Required: False ,
}
boolean ,
dependencyMapping:
{
Description: Gets or sets if dependency mapping feature is enabled or not for the VM. ,
Required: False ,
}
string ,
dependencyMappingStartTime:
{
Description: Gets or sets when dependency mapping collection is last started. ,
Format: date-time ,
Required: False ,
}
string ,
dependencyMappingEndTime:
{
Description: Gets or sets when dependency mapping collection was last disabled. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the machine. ,
Required: False ,
}
string ,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Errors for machine. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationDiscovery:
{
Description: Gets the data related to application discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
dependencyMapDiscovery:
{
Description: Gets the data related to dependency map discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
staticDiscovery:
{
Description: Gets the data related to static discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
sqlDiscovery:
{
Description: Gets the data related to SQL discovery. ,
Required: False ,
}
{
successfullyDiscoveredServerCount:
{
Description: successfully Discovered ServerCount ,
Format: int32 ,
Required: False ,
}
integer ,
totalServerCount:
{
Description: total Server Count ,
Format: int32 ,
Required: False ,
}
integer ,
sqlMetadataHydratedRunAsAccountId:
{
Description: sql Metadata Hydrated RunAsAccountId ,
Required: False ,
}
string ,
sqlMetadataDiscoveryPipe:
{
Description: sql Metadata DiscoveryPipe ,
Enum:
{
Unknown: Unknown value. ,
VMware: VMware value. ,
PowerShell: PowerShell value. ,
SSH: SSH value. ,
CIM: CIM value. ,
Other: Other value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: discovery Scope Status ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
webAppDiscovery:
{
Description: Gets the data related to Web application discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
oracleDiscovery:
{
Description: Gets the data related to Oracle discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalDatabaseCount:
{
Description: Gets or sets number of successfully discovered databases. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
springBootDiscovery:
{
Description: Gets the data related to SpringBoot discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplicationCount:
{
Description: Gets or sets number of successfully discovered applications. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
iisDiscovery:
{
Description: Gets the data related to iis discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
tomcatDiscovery:
{
Description: Gets the data related to tomcat discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
appsAndRoles:
{
Description: Apps And Roles of the Server. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: double ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the Display name of the machine. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Value indicating whether VM is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the marking machine creation. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the resource. ,
Required: False ,
}
object ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
arcDiscovery:
{
Description: Gets the data related to Azure arc discovery. ,
Required: False ,
}
{
status:
{
Description: AzureArc status indicates whether arc discovery has successfully completed or not. ,
Enum:
{
Unknown: Unknown value. ,
NotEnabled: Not enabled value. ,
Enabled: Enabled value. ,
}
,
Required: True ,
}
enum ,
machineResourceId:
{
Description: Machine Resource Id. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervMachinesController_Update (new)
Description :  Update a HypervMachine
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: HypervMachine name ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The updatable properties of the HypervMachine. ,
Required: False ,
}
{
firmware:
{
Description: Gets or sets the firmware. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the machine. ,
Required: False ,
}
string ,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: double ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the resource. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
instanceUuid:
{
Description: On-premise Instance UUID of the machine. ,
Required: False ,
}
string ,
hostFqdn:
{
Description: Host FQDN/IPAddress. ,
Required: False ,
}
string ,
hostId:
{
Description: Host ARM ID. ,
Required: False ,
}
string ,
generation:
{
Description: Generation of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: VM version. ,
Required: False ,
}
string ,
highAvailability:
{
Description: Value indicating whether the VM is highly available. ,
Enum:
{
Unknown: Unknown value. ,
No: No value. ,
Yes: Yes value. ,
}
,
Required: False ,
}
enum ,
clusterFqdn:
{
Description: Cluster FQDN/IPAddress. ,
Required: False ,
}
string ,
clusterId:
{
Description: Cluster ARM ID. ,
Required: False ,
}
string ,
maxMemoryMb:
{
Description: Max memory of the virtual machine in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
isDynamicMemoryEnabled:
{
Description: Value indicating whether dynamic memory is enabled for the VM. ,
Required: False ,
}
boolean ,
disks:
{
Description: Disks attached to the machine. ,
Required: False ,
}
[
{
instanceId:
{
Description: Id of the disk. ,
Required: False ,
}
string ,
vhdId:
{
Description: VHD Id of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: Gets or sets Bytes allocated for the disk. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets Name of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: Gets or sets Type of the disk. ,
Required: False ,
}
string ,
lun:
{
Description: Gets or sets LUN of the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets Path of the disk. ,
Required: False ,
}
string ,
}
,
]
,
networkAdapters:
{
Description: Network adapters attached to the machine. ,
Required: False ,
}
[
{
networkId:
{
Description: Network Id. ,
Required: False ,
}
string ,
subnetName:
{
Description: Name of the VM subnet within the virtual network the NIC is attached to. ,
Required: False ,
}
string ,
staticIpAddress:
{
Description: Static IP address. ,
Required: False ,
}
string ,
nicType:
{
Description: Mac address of the NIC. ,
Required: False ,
}
string ,
nicId:
{
Description: Gets or sets the NIC Id. ,
Required: False ,
}
string ,
macAddress:
{
Description: Gets or sets Mac address of the NIC. ,
Required: False ,
}
string ,
ipAddressList:
{
Description: Gets IP addresses for the machine. ,
Required: False ,
}
[
string ,
]
,
networkName:
{
Description: Gets or sets Network Name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: Gets or sets Type of the IP address. ,
Required: False ,
}
string ,
}
,
]
,
managementServerType:
{
Description: Management server type captured as a string representation of the {Microsoft.Azure.FDS.WebRole.HyperVMachineBase.HyperVMachineBaseProperties.ManagementServerType} enumeration. ,
Required: False ,
}
string ,
secureBootTemplateId:
{
Description: Gets or sets the SecureBootTemplateId setting of the VM. ,
Required: False ,
}
string ,
secureBootEnabled:
{
Description: Gets or sets a value indicating whether Secure boot is enabled for the VM. ,
Required: False ,
}
boolean ,
secureBootTemplate:
{
Description: Gets or sets the SecureBootTemplateId setting of the VM. ,
Required: False ,
}
string ,
tpmEnabled:
{
Description: Gets or sets a value indicating whether trusted platform module is enabled on the VM. ,
Required: False ,
}
boolean ,
ksdEnabled:
{
Description: Gets or sets a value indicating whether key storage device is enabled on the VM. ,
Required: False ,
}
boolean ,
shieldingRequested:
{
Description: Gets or sets a value indicating whether shielding is enabled for the VM. ,
Required: False ,
}
boolean ,
dataProtectionRequested:
{
Description: Gets or sets a value indicating whether data protection is requested for a VM. ,
Required: False ,
}
boolean ,
encryptStateAndVmMigrationTraffic:
{
Description: Gets or sets a value indicating whether encryption of state and migration traffic is enabled for the VM. ,
Required: False ,
}
boolean ,
virtualizationBasedSecurityOptOut:
{
Description: Gets or sets a value indicating whether VM virtualization based security is enabled for the VM. ,
Required: False ,
}
boolean ,
powerStatus:
{
Description: Gets the Machine power status. ,
Required: False ,
}
string ,
vmFqdn:
{
Description: Gets the VM FQDN. ,
Required: False ,
}
string ,
vmConfigurationFileLocation:
{
Description: Gets the Root location of the VM configuration file. ,
Required: False ,
}
string ,
firmware:
{
Description: Gets or sets the firmware. ,
Required: False ,
}
string ,
guestOsDetails:
{
Description: Operating System Details extracted from the guest bu executing script inside the guest VM. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
numberOfApplications:
{
Description: Number of applications installed in the guest VM. ,
Format: int32 ,
Required: False ,
}
integer ,
guestDetailsDiscoveryTimestamp:
{
Description: The last time at which the Guest Details was discovered or the error while discovering guest details based discovery of the machine. ,
Format: date-time ,
Required: False ,
}
string ,
isGuestDetailsDiscoveryInProgress:
{
Description: Whether Refresh Fabric Layout Guest Details has been completed once. Portal will show discovery in progress, if this value is true. ,
Required: False ,
}
boolean ,
dependencyMapping:
{
Description: Gets or sets if dependency mapping feature is enabled or not for the VM. ,
Required: False ,
}
string ,
dependencyMappingStartTime:
{
Description: Gets or sets when dependency mapping collection is last started. ,
Format: date-time ,
Required: False ,
}
string ,
dependencyMappingEndTime:
{
Description: Gets or sets when dependency mapping collection was last disabled. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the machine. ,
Required: False ,
}
string ,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Errors for machine. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationDiscovery:
{
Description: Gets the data related to application discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
dependencyMapDiscovery:
{
Description: Gets the data related to dependency map discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
staticDiscovery:
{
Description: Gets the data related to static discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
sqlDiscovery:
{
Description: Gets the data related to SQL discovery. ,
Required: False ,
}
{
successfullyDiscoveredServerCount:
{
Description: successfully Discovered ServerCount ,
Format: int32 ,
Required: False ,
}
integer ,
totalServerCount:
{
Description: total Server Count ,
Format: int32 ,
Required: False ,
}
integer ,
sqlMetadataHydratedRunAsAccountId:
{
Description: sql Metadata Hydrated RunAsAccountId ,
Required: False ,
}
string ,
sqlMetadataDiscoveryPipe:
{
Description: sql Metadata DiscoveryPipe ,
Enum:
{
Unknown: Unknown value. ,
VMware: VMware value. ,
PowerShell: PowerShell value. ,
SSH: SSH value. ,
CIM: CIM value. ,
Other: Other value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: discovery Scope Status ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
webAppDiscovery:
{
Description: Gets the data related to Web application discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
oracleDiscovery:
{
Description: Gets the data related to Oracle discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalDatabaseCount:
{
Description: Gets or sets number of successfully discovered databases. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
springBootDiscovery:
{
Description: Gets the data related to SpringBoot discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplicationCount:
{
Description: Gets or sets number of successfully discovered applications. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
iisDiscovery:
{
Description: Gets the data related to iis discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
tomcatDiscovery:
{
Description: Gets the data related to tomcat discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
appsAndRoles:
{
Description: Apps And Roles of the Server. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: double ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the Display name of the machine. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Value indicating whether VM is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the marking machine creation. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the resource. ,
Required: False ,
}
object ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
arcDiscovery:
{
Description: Gets the data related to Azure arc discovery. ,
Required: False ,
}
{
status:
{
Description: AzureArc status indicates whether arc discovery has successfully completed or not. ,
Enum:
{
Unknown: Unknown value. ,
NotEnabled: Not enabled value. ,
Enabled: Enabled value. ,
}
,
Required: True ,
}
enum ,
machineResourceId:
{
Description: Machine Resource Id. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervSoftwareInventoriesController_GetMachineSoftwareInventory (new)
Description :  Method to get a machines software inventory like applications and roles.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}/softwareInventories/{default}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: HypervMachine name ,
Required: True ,
}
string ,
default:
{
Description: Default value. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
appsAndRoles:
{
Description: Apps And Roles of the machine entity. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervSoftwareInventoriesController_ListByHypervMachine (new)
Description :  List HypervVmSoftwareInventory resources by HypervMachine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}/softwareinventories
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: HypervMachine name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HypervVmSoftwareInventory items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
appsAndRoles:
{
Description: Apps And Roles of the machine entity. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervOperationsStatusController_GetHypervOperationsStatus (new)
Description :  Method to get operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/operationsStatus/{operationStatusName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
operationStatusName:
{
Description: Operation status Arm Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the start time. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Operation status properties ,
Required: False ,
}
{
result:
{
Description: Gets or sets the result or output of the workflow. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervRunAsAccountsController_ListByHypervSite (new)
Description :  List HypervRunAsAccountResource resources by HypervSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/runAsAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HypervRunAsAccountResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the run as account. ,
Required: False ,
}
string ,
credentialType:
{
Description: Gets the credential type of the run as account. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Timestamp marking run as account creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp marking last updated on the run as account. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the appliance name of the run as account. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervRunAsAccountsController_Get (new)
Description :  Get a HypervRunAsAccountResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/runAsAccounts/{accountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
accountName:
{
Description: RunAsAccounts name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the run as account. ,
Required: False ,
}
string ,
credentialType:
{
Description: Gets the credential type of the run as account. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Timestamp marking run as account creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp marking last updated on the run as account. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the appliance name of the run as account. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervDependencyMapController_ServerGroupMembers (new)
Description :  API to list server group members for the selected server group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/serverGroupMembers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
serverPort:
{
Description: port of server ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
filters:
{
Description: optional filters ,
Required: False ,
}
{
machineIds:
{
Description: array of machine ids ,
Required: False ,
}
[
string ,
]
,
processIds:
{
Description: array of process Ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervSitesController_Summary (new)
Description :  Method to get site usage.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/summary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
machineCount:
{
Description: Gets or sets the number of machines discovered in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsAccountCount:
{
Description: Gets or sets the number of run as accounts in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
hostCount:
{
Description: Gets or sets the number of hosts part of the site. ,
Format: int32 ,
Required: False ,
}
integer ,
clusterCount:
{
Description: Gets or sets the number of clusters part of the site. ,
Format: int32 ,
Required: False ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervDependencyMapController_UpdateDependencyMapStatus (new)
Description :  Method to enable disable dependency map status for machines in a site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/updateDependencyMapStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
machines:
{
Description: Gets or sets the machine collection. ,
Required: False ,
}
[
{
machineId:
{
Description: Gets or sets the ARM id of the machine. ,
Required: False ,
}
string ,
isDependencyMapToBeEnabled:
{
Description: Gets or sets a value indicating whether dependency mapping is to be enabled or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervMachinesController_UpdateProperties (new)
Description :  Method to update custom properties for HYPERV machines in a site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/updateProperties
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
metaData:
{
Description: The content of the action request ,
Required: True ,
}
{
value:
{
Description: The list of Machine MetaData. ,
Required: True ,
}
[
{
machineArmId:
{
Description: arm id of the machine. ,
Required: True ,
}
string ,
dependencyMapping:
{
Description: value representing state of dependency mapping (enabled/disabled). ,
Required: True ,
}
string ,
tags:
{
Description: machine tags ,
Required: True ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportSitesController_ListByResourceGroup (new)
Description :  Get all import sites.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ImportSite items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportSitesController_Get (new)
Description :  Get a ImportSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportSitesController_Create (new)
Description :  Create a ImportSite
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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: A ImportSite ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportSitesController_Update (new)
Description :  Update a ImportSite
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The updatable properties of the ImportSite. ,
Required: False ,
}
{
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportSitesController_Delete (new)
Description :  Delete a ImportSite
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportSitesController_DeleteImportedMachines (new)
Description :  Deletes the imported machines for site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteImportedMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
jobArmId:
{
Description: Gets or sets the job ARM ID. ,
Required: False ,
}
string ,
uri:
{
Description: Gets or sets the SAS URI. ,
Required: False ,
}
string ,
importType:
{
Description: Gets or sets the import type. ,
Enum:
{
AzureMigrateCSV: AzureMigrateCSV value. ,
RVToolsXlsx: RVToolsXlsx value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportJobsController_ListDeletejobs (new)
Description :  Method to get all delete import machines job for the given site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteJobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DeleteImportMachinesJob items on this page ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
blobName:
{
Description: blob name ,
Required: False ,
}
string ,
errorSasUri:
{
Description: error Sas Uri ,
Required: False ,
}
string ,
jobState:
{
Description: job State ,
Enum:
{
Unknown: Unknown value. ,
Verified: Verified value. ,
VerifiedWithErrors: VerifiedWithErrors value. ,
Completed: Completed value. ,
Failed: Failed value. ,
}
,
Required: False ,
}
enum ,
numberOfMachinesDeleted:
{
Description: number Of Machines Deleted ,
Format: int32 ,
Required: False ,
}
integer ,
deletionConfirmation:
{
Description: deletion Confirmation ,
Required: False ,
}
boolean ,
errors:
{
Description: errors list ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Gets or sets the Job status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the Job start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the Job end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the Display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportJobsController_GetDeletejob (new)
Description :  Gets the delete imported machines job with the given job name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteJobs/{jobName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
jobName:
{
Description: Job Arm Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
blobName:
{
Description: blob name ,
Required: False ,
}
string ,
errorSasUri:
{
Description: error Sas Uri ,
Required: False ,
}
string ,
jobState:
{
Description: job State ,
Enum:
{
Unknown: Unknown value. ,
Verified: Verified value. ,
VerifiedWithErrors: VerifiedWithErrors value. ,
Completed: Completed value. ,
Failed: Failed value. ,
}
,
Required: False ,
}
enum ,
numberOfMachinesDeleted:
{
Description: number Of Machines Deleted ,
Format: int32 ,
Required: False ,
}
integer ,
deletionConfirmation:
{
Description: deletion Confirmation ,
Required: False ,
}
boolean ,
errors:
{
Description: errors list ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Gets or sets the Job status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the Job start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the Job end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the Display name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportJobsController_ListExportjobs (new)
Description :  Method to get all export import machines job for the given site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportJobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ExportImportedMachinesJob items on this page ,
Required: False ,
}
[
{
type:
{
Description: Type name for export job. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the export machines job properties. ,
Required: False ,
}
{
blobName:
{
Description: blob name ,
Required: False ,
}
string ,
sasUri:
{
Description: sas uri ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the relative ARM name to get job. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Job ID. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the Job status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the Job start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the Job end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the Display name. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportJobsController_GetExportjob (new)
Description :  Gets the export imported machines job with the given job name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportJobs/{jobName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
jobName:
{
Description: Job Arm Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: Type name for export job. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the export machines job properties. ,
Required: False ,
}
{
blobName:
{
Description: blob name ,
Required: False ,
}
string ,
sasUri:
{
Description: sas uri ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the relative ARM name to get job. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Job ID. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the Job status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the Job start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the Job end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the Display name. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportSitesController_ExportUri (new)
Description :  Method to export a site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportUri
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
jobArmId:
{
Description: Gets or sets the job ARM ID. ,
Required: False ,
}
string ,
uri:
{
Description: Gets or sets the SAS URI. ,
Required: False ,
}
string ,
importType:
{
Description: Gets or sets the import type. ,
Enum:
{
AzureMigrateCSV: AzureMigrateCSV value. ,
RVToolsXlsx: RVToolsXlsx value. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
jobArmId:
{
Description: Gets or sets the job ARM ID. ,
Required: False ,
}
string ,
uri:
{
Description: Gets or sets the SAS URI. ,
Required: False ,
}
string ,
importType:
{
Description: Gets or sets the import type. ,
Enum:
{
AzureMigrateCSV: AzureMigrateCSV value. ,
RVToolsXlsx: RVToolsXlsx value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportJobsController_ListImportjobs (new)
Description :  Method to get all import machines job for the given site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importJobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ImportMachinesJob items on this page ,
Required: False ,
}
[
{
type:
{
Description: Handled by resource provider. Type = Microsoft.OffAzure/ImportSites/jobs/importJobs. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the import job properties. ,
Required: False ,
}
{
blobName:
{
Description: blob name ,
Required: False ,
}
string ,
blobSasUri:
{
Description: blob sasUri ,
Required: False ,
}
string ,
jobResult:
{
Description: job Result ,
Enum:
{
Unknown: Unknown value. ,
Completed: Completed value. ,
CompletedWithWarnings: CompletedWithWarnings value. ,
CompletedWithErrors: CompletedWithErrors value. ,
Failed: Failed value. ,
WaitingForBlobUpload: WaitingForBlobUpload value. ,
InProgress: InProgress value. ,
}
,
Required: False ,
}
enum ,
numberOfMachinesImported:
{
Description: number Of Machines Imported ,
Format: int32 ,
Required: False ,
}
integer ,
blobCreationTimeStamp:
{
Description: blob Creation TimeStamp ,
Format: date-time ,
Required: False ,
}
string ,
errorSummary:
{
Description: error summary ,
Required: False ,
}
{
errors:
{
Description: errors list ,
Required: False ,
}
[
string ,
]
,
errorCount:
{
Description: error count ,
Format: int32 ,
Required: False ,
}
integer ,
warningCount:
{
Description: warning Count ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
id:
{
Description: Gets or sets the relative ARM name to get job. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Job ID. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the Job status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the Job start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the Job end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the Display name. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportJobsController_GetImportjob (new)
Description :  Gets the import job with the given job name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importJobs/{jobName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
jobName:
{
Description: Job Arm Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: Handled by resource provider. Type = Microsoft.OffAzure/ImportSites/jobs/importJobs. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the import job properties. ,
Required: False ,
}
{
blobName:
{
Description: blob name ,
Required: False ,
}
string ,
blobSasUri:
{
Description: blob sasUri ,
Required: False ,
}
string ,
jobResult:
{
Description: job Result ,
Enum:
{
Unknown: Unknown value. ,
Completed: Completed value. ,
CompletedWithWarnings: CompletedWithWarnings value. ,
CompletedWithErrors: CompletedWithErrors value. ,
Failed: Failed value. ,
WaitingForBlobUpload: WaitingForBlobUpload value. ,
InProgress: InProgress value. ,
}
,
Required: False ,
}
enum ,
numberOfMachinesImported:
{
Description: number Of Machines Imported ,
Format: int32 ,
Required: False ,
}
integer ,
blobCreationTimeStamp:
{
Description: blob Creation TimeStamp ,
Format: date-time ,
Required: False ,
}
string ,
errorSummary:
{
Description: error summary ,
Required: False ,
}
{
errors:
{
Description: errors list ,
Required: False ,
}
[
string ,
]
,
errorCount:
{
Description: error count ,
Format: int32 ,
Required: False ,
}
integer ,
warningCount:
{
Description: warning Count ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
id:
{
Description: Gets or sets the relative ARM name to get job. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the Job ID. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the Job status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the Job start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the Job end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the Display name. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportSitesController_ImportUri (new)
Description :  Method to import a site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importUri
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
jobArmId:
{
Description: Gets or sets the job ARM ID. ,
Required: False ,
}
string ,
uri:
{
Description: Gets or sets the SAS URI. ,
Required: False ,
}
string ,
importType:
{
Description: Gets or sets the import type. ,
Enum:
{
AzureMigrateCSV: AzureMigrateCSV value. ,
RVToolsXlsx: RVToolsXlsx value. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
jobArmId:
{
Description: Gets or sets the job ARM ID. ,
Required: False ,
}
string ,
uri:
{
Description: Gets or sets the SAS URI. ,
Required: False ,
}
string ,
importType:
{
Description: Gets or sets the import type. ,
Enum:
{
AzureMigrateCSV: AzureMigrateCSV value. ,
RVToolsXlsx: RVToolsXlsx value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportJobsController_ListByImportSite (new)
Description :  List ImportJob resources by ImportSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ImportJob items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
status:
{
Description: Gets operation status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets operation start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets operation end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the display name of the Job. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id used in the operation execution context. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id used in the operation execution context. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
isAgentReportedError:
{
Description: Gets a value indicating whether the error originated from a agent or not. ,
Required: False ,
}
boolean ,
agentErrorCode:
{
Description: Gets the agent error code. ,
Required: False ,
}
string ,
agentErrorMessage:
{
Description: Gets the error message from the agent. ,
Required: False ,
}
string ,
agentErrorPossibleCauses:
{
Description: Gets possible causes for the agent error. ,
Required: False ,
}
string ,
agentErrorRecommendedAction:
{
Description: Gets the recommended action for the agent error. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportJobsController_Get (new)
Description :  Get a ImportJob
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/jobs/{jobName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
jobName:
{
Description: Jobs name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
status:
{
Description: Gets operation status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets operation start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets operation end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the display name of the Job. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id used in the operation execution context. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id used in the operation execution context. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
isAgentReportedError:
{
Description: Gets a value indicating whether the error originated from a agent or not. ,
Required: False ,
}
boolean ,
agentErrorCode:
{
Description: Gets the agent error code. ,
Required: False ,
}
string ,
agentErrorMessage:
{
Description: Gets the error message from the agent. ,
Required: False ,
}
string ,
agentErrorPossibleCauses:
{
Description: Gets possible causes for the agent error. ,
Required: False ,
}
string ,
agentErrorRecommendedAction:
{
Description: Gets the recommended action for the agent error. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportMachinesController_ListByImportSite (new)
Description :  List ImportMachine resources by ImportSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/machines
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Required: False ,
}
string ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ImportMachine items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
firmware:
{
Description: Firmware of the machine. ,
Required: False ,
}
string ,
percentageCpuUtilization:
{
Description: CPU utilization. ,
Format: float ,
Required: False ,
}
number ,
percentageMemoryUtilization:
{
Description: Memory utilization. ,
Format: float ,
Required: False ,
}
number ,
numberOfDisks:
{
Description: Number of disks. ,
Format: int32 ,
Required: False ,
}
integer ,
totalDiskReadOperationsPerSecond:
{
Description: Total disk read operations per second. ,
Format: float ,
Required: False ,
}
number ,
totalDiskWriteOperationsPerSecond:
{
Description: Total disk write operations per second. ,
Format: float ,
Required: False ,
}
number ,
totalDiskWriteThroughput:
{
Description: Total disk write throughput. ,
Format: float ,
Required: False ,
}
number ,
totalDiskReadThroughput:
{
Description: Total disk read throughput. ,
Format: float ,
Required: False ,
}
number ,
macAddress:
{
Description: MAC Address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: IP Addresses. ,
Required: False ,
}
[
string ,
]
,
machineId:
{
Description: Machine ID. ,
Required: False ,
}
string ,
machineManagerId:
{
Description: Machine manager ID. ,
Required: False ,
}
string ,
numberOfNetworkAdapters:
{
Description: Number of network adapters. ,
Format: int32 ,
Required: False ,
}
integer ,
networkInThroughput:
{
Description: Network in throughput. ,
Format: float ,
Required: False ,
}
number ,
networkOutThroughput:
{
Description: Network out throughput. ,
Format: float ,
Required: False ,
}
number ,
serverType:
{
Description: Server type. ,
Required: False ,
}
string ,
hypervisor:
{
Description: Fabric type. ,
Required: False ,
}
string ,
hypervisorVersionNumber:
{
Description: Hypervisor version number. ,
Required: False ,
}
string ,
disks:
{
Description: Disks attached to the machine. ,
Required: False ,
}
[
{
megabytesPerSecondOfRead:
{
Description: Disk read throughput. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: Disk write throughput. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: Disk read IOPS. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: Disk write IOPS. ,
Format: float ,
Required: False ,
}
number ,
maxSizeInBytes:
{
Description: Gets or sets Bytes allocated for the disk. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets Name of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: Gets or sets Type of the disk. ,
Required: False ,
}
string ,
lun:
{
Description: Gets or sets LUN of the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets Path of the disk. ,
Required: False ,
}
string ,
}
,
]
,
vmFqdn:
{
Description: Server FQDN. ,
Required: False ,
}
string ,
storageInUseGb:
{
Description: Total storage in use. ,
Format: float ,
Required: False ,
}
number ,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: double ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the Display name of the machine. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Value indicating whether VM is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the marking machine creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
tags:
{
Description: machine tags ,
Required: True ,
}
object ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportMachinesController_Get (new)
Description :  Get a ImportMachine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: Machine name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
firmware:
{
Description: Firmware of the machine. ,
Required: False ,
}
string ,
percentageCpuUtilization:
{
Description: CPU utilization. ,
Format: float ,
Required: False ,
}
number ,
percentageMemoryUtilization:
{
Description: Memory utilization. ,
Format: float ,
Required: False ,
}
number ,
numberOfDisks:
{
Description: Number of disks. ,
Format: int32 ,
Required: False ,
}
integer ,
totalDiskReadOperationsPerSecond:
{
Description: Total disk read operations per second. ,
Format: float ,
Required: False ,
}
number ,
totalDiskWriteOperationsPerSecond:
{
Description: Total disk write operations per second. ,
Format: float ,
Required: False ,
}
number ,
totalDiskWriteThroughput:
{
Description: Total disk write throughput. ,
Format: float ,
Required: False ,
}
number ,
totalDiskReadThroughput:
{
Description: Total disk read throughput. ,
Format: float ,
Required: False ,
}
number ,
macAddress:
{
Description: MAC Address. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: IP Addresses. ,
Required: False ,
}
[
string ,
]
,
machineId:
{
Description: Machine ID. ,
Required: False ,
}
string ,
machineManagerId:
{
Description: Machine manager ID. ,
Required: False ,
}
string ,
numberOfNetworkAdapters:
{
Description: Number of network adapters. ,
Format: int32 ,
Required: False ,
}
integer ,
networkInThroughput:
{
Description: Network in throughput. ,
Format: float ,
Required: False ,
}
number ,
networkOutThroughput:
{
Description: Network out throughput. ,
Format: float ,
Required: False ,
}
number ,
serverType:
{
Description: Server type. ,
Required: False ,
}
string ,
hypervisor:
{
Description: Fabric type. ,
Required: False ,
}
string ,
hypervisorVersionNumber:
{
Description: Hypervisor version number. ,
Required: False ,
}
string ,
disks:
{
Description: Disks attached to the machine. ,
Required: False ,
}
[
{
megabytesPerSecondOfRead:
{
Description: Disk read throughput. ,
Format: float ,
Required: False ,
}
number ,
megabytesPerSecondOfWrite:
{
Description: Disk write throughput. ,
Format: float ,
Required: False ,
}
number ,
numberOfReadOperationsPerSecond:
{
Description: Disk read IOPS. ,
Format: float ,
Required: False ,
}
number ,
numberOfWriteOperationsPerSecond:
{
Description: Disk write IOPS. ,
Format: float ,
Required: False ,
}
number ,
maxSizeInBytes:
{
Description: Gets or sets Bytes allocated for the disk. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets Name of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: Gets or sets Type of the disk. ,
Required: False ,
}
string ,
lun:
{
Description: Gets or sets LUN of the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets Path of the disk. ,
Required: False ,
}
string ,
}
,
]
,
vmFqdn:
{
Description: Server FQDN. ,
Required: False ,
}
string ,
storageInUseGb:
{
Description: Total storage in use. ,
Format: float ,
Required: False ,
}
number ,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: double ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the Display name of the machine. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Value indicating whether VM is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the marking machine creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
tags:
{
Description: machine tags ,
Required: True ,
}
object ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ImportMachinesController_Delete (new)
Description :  Delete a ImportMachine
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: Machine name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
MasterSitesController_ListByResourceGroup (new)
Description :  Get all the sites in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MasterSite items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Gets or sets the state of public network access. ,
Enum:
{
NotSpecified: NotSpecified value. ,
Enabled: Enabled value. ,
Disabled: Disabled value. ,
}
,
Required: False ,
}
enum ,
allowMultipleSites:
{
Description: Gets or sets a value indicating whether multiple sites per site type are allowed. ,
Required: False ,
}
boolean ,
sites:
{
Description: Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name. ,
Required: False ,
}
[
string ,
]
,
customerStorageAccountArmId:
{
Description: Gets or sets a value for customer storage account ARM id. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: array of group ids ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: private endpoints ,
Required: False ,
}
{
id:
{
Description: id name ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: private endpoints connection state ,
Required: False ,
}
{
status:
{
Description: state status ,
Enum:
{
Approved: Approved value. ,
Pending: Pending value. ,
Rejected: Rejected value. ,
Disconnected: Disconnected value. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: description string ,
Required: False ,
}
string ,
actionsRequired:
{
Description: actions required ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nestedSites:
{
Description: Gets the nested sites under Master Site. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MasterSitesController_Get (new)
Description :  Get a MasterSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Gets or sets the state of public network access. ,
Enum:
{
NotSpecified: NotSpecified value. ,
Enabled: Enabled value. ,
Disabled: Disabled value. ,
}
,
Required: False ,
}
enum ,
allowMultipleSites:
{
Description: Gets or sets a value indicating whether multiple sites per site type are allowed. ,
Required: False ,
}
boolean ,
sites:
{
Description: Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name. ,
Required: False ,
}
[
string ,
]
,
customerStorageAccountArmId:
{
Description: Gets or sets a value for customer storage account ARM id. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: array of group ids ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: private endpoints ,
Required: False ,
}
{
id:
{
Description: id name ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: private endpoints connection state ,
Required: False ,
}
{
status:
{
Description: state status ,
Enum:
{
Approved: Approved value. ,
Pending: Pending value. ,
Rejected: Rejected value. ,
Disconnected: Disconnected value. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: description string ,
Required: False ,
}
string ,
actionsRequired:
{
Description: actions required ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nestedSites:
{
Description: Gets the nested sites under Master Site. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MasterSitesController_Create (new)
Description :  Method to create or update a site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Gets or sets the state of public network access. ,
Enum:
{
NotSpecified: NotSpecified value. ,
Enabled: Enabled value. ,
Disabled: Disabled value. ,
}
,
Required: False ,
}
enum ,
allowMultipleSites:
{
Description: Gets or sets a value indicating whether multiple sites per site type are allowed. ,
Required: False ,
}
boolean ,
sites:
{
Description: Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name. ,
Required: False ,
}
[
string ,
]
,
customerStorageAccountArmId:
{
Description: Gets or sets a value for customer storage account ARM id. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: array of group ids ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: private endpoints ,
Required: False ,
}
{
id:
{
Description: id name ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: private endpoints connection state ,
Required: False ,
}
{
status:
{
Description: state status ,
Enum:
{
Approved: Approved value. ,
Pending: Pending value. ,
Rejected: Rejected value. ,
Disconnected: Disconnected value. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: description string ,
Required: False ,
}
string ,
actionsRequired:
{
Description: actions required ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nestedSites:
{
Description: Gets the nested sites under Master Site. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Gets or sets the state of public network access. ,
Enum:
{
NotSpecified: NotSpecified value. ,
Enabled: Enabled value. ,
Disabled: Disabled value. ,
}
,
Required: False ,
}
enum ,
allowMultipleSites:
{
Description: Gets or sets a value indicating whether multiple sites per site type are allowed. ,
Required: False ,
}
boolean ,
sites:
{
Description: Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name. ,
Required: False ,
}
[
string ,
]
,
customerStorageAccountArmId:
{
Description: Gets or sets a value for customer storage account ARM id. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: array of group ids ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: private endpoints ,
Required: False ,
}
{
id:
{
Description: id name ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: private endpoints connection state ,
Required: False ,
}
{
status:
{
Description: state status ,
Enum:
{
Approved: Approved value. ,
Pending: Pending value. ,
Rejected: Rejected value. ,
Disconnected: Disconnected value. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: description string ,
Required: False ,
}
string ,
actionsRequired:
{
Description: actions required ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nestedSites:
{
Description: Gets the nested sites under Master Site. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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: A MasterSite ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Gets or sets the state of public network access. ,
Enum:
{
NotSpecified: NotSpecified value. ,
Enabled: Enabled value. ,
Disabled: Disabled value. ,
}
,
Required: False ,
}
enum ,
allowMultipleSites:
{
Description: Gets or sets a value indicating whether multiple sites per site type are allowed. ,
Required: False ,
}
boolean ,
sites:
{
Description: Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name. ,
Required: False ,
}
[
string ,
]
,
customerStorageAccountArmId:
{
Description: Gets or sets a value for customer storage account ARM id. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: array of group ids ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: private endpoints ,
Required: False ,
}
{
id:
{
Description: id name ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: private endpoints connection state ,
Required: False ,
}
{
status:
{
Description: state status ,
Enum:
{
Approved: Approved value. ,
Pending: Pending value. ,
Rejected: Rejected value. ,
Disconnected: Disconnected value. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: description string ,
Required: False ,
}
string ,
actionsRequired:
{
Description: actions required ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nestedSites:
{
Description: Gets the nested sites under Master Site. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MasterSitesController_Update (new)
Description :  Method to update an existing site.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The updatable properties of the MasterSite. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Gets or sets the state of public network access. ,
Enum:
{
NotSpecified: NotSpecified value. ,
Enabled: Enabled value. ,
Disabled: Disabled value. ,
}
,
Required: False ,
}
enum ,
allowMultipleSites:
{
Description: Gets or sets a value indicating whether multiple sites per site type are allowed. ,
Required: False ,
}
boolean ,
sites:
{
Description: Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name. ,
Required: False ,
}
[
string ,
]
,
customerStorageAccountArmId:
{
Description: Gets or sets a value for customer storage account ARM id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Gets or sets the state of public network access. ,
Enum:
{
NotSpecified: NotSpecified value. ,
Enabled: Enabled value. ,
Disabled: Disabled value. ,
}
,
Required: False ,
}
enum ,
allowMultipleSites:
{
Description: Gets or sets a value indicating whether multiple sites per site type are allowed. ,
Required: False ,
}
boolean ,
sites:
{
Description: Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name. ,
Required: False ,
}
[
string ,
]
,
customerStorageAccountArmId:
{
Description: Gets or sets a value for customer storage account ARM id. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: array of group ids ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: private endpoints ,
Required: False ,
}
{
id:
{
Description: id name ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: private endpoints connection state ,
Required: False ,
}
{
status:
{
Description: state status ,
Enum:
{
Approved: Approved value. ,
Pending: Pending value. ,
Rejected: Rejected value. ,
Disconnected: Disconnected value. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: description string ,
Required: False ,
}
string ,
actionsRequired:
{
Description: actions required ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nestedSites:
{
Description: Gets the nested sites under Master Site. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MasterSitesController_Delete (new)
Description :  Method to delete a site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
MasterSitesController_ErrorSummary (new)
Description :  Method to get error summary from master site for an appliance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/errorSummary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
applianceName:
{
Description: Appliance Name. ,
Required: True ,
}
string ,
discoveryScopeErrorSummaries:
{
Description: Gets the error message. ,
Required: True ,
}
{
affectedResourceType:
{
Description: Gets or sets the affected resource type. ,
Required: True ,
}
string ,
affectedObjectsCount:
{
Description: Count of affected objects. ,
Format: int64 ,
Required: True ,
}
integer ,
discoveryScope:
{
Description: Gets or sets the count of affected objects. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
}
,
Required: True ,
}
enum ,
}
,
nextLink:
{
Description: The link to fetch more models. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MasterSitesOperationsStatusController_GetVmwareOperationStatus (new)
Description :  A operation status resource belonging to a master site resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/operationsStatus/{operationStatusName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
operationStatusName:
{
Description: Operation status Arm Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the start time. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Operation status properties ,
Required: False ,
}
{
result:
{
Description: Gets or sets the result or output of the workflow. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnectionController_ListByMasterSite (new)
Description :  Gets the private link resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: array of group ids ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: private endpoints ,
Required: False ,
}
{
id:
{
Description: id name ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: private endpoints connection state ,
Required: False ,
}
{
status:
{
Description: state status ,
Enum:
{
Approved: Approved value. ,
Pending: Pending value. ,
Rejected: Rejected value. ,
Disconnected: Disconnected value. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: description string ,
Required: False ,
}
string ,
actionsRequired:
{
Description: actions required ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnectionController_Get (new)
Description :  Gets the private link resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections/{peConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
peConnectionName:
{
Description: Private link resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: array of group ids ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: private endpoints ,
Required: False ,
}
{
id:
{
Description: id name ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: private endpoints connection state ,
Required: False ,
}
{
status:
{
Description: state status ,
Enum:
{
Approved: Approved value. ,
Pending: Pending value. ,
Rejected: Rejected value. ,
Disconnected: Disconnected value. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: description string ,
Required: False ,
}
string ,
actionsRequired:
{
Description: actions required ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnectionController_Create (new)
Description :  Gets the private link resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections/{peConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
peConnectionName:
{
Description: Private link resource name. ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: array of group ids ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: private endpoints ,
Required: False ,
}
{
id:
{
Description: id name ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: private endpoints connection state ,
Required: False ,
}
{
status:
{
Description: state status ,
Enum:
{
Approved: Approved value. ,
Pending: Pending value. ,
Rejected: Rejected value. ,
Disconnected: Disconnected value. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: description string ,
Required: False ,
}
string ,
actionsRequired:
{
Description: actions required ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: array of group ids ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: private endpoints ,
Required: False ,
}
{
id:
{
Description: id name ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: private endpoints connection state ,
Required: False ,
}
{
status:
{
Description: state status ,
Enum:
{
Approved: Approved value. ,
Pending: Pending value. ,
Rejected: Rejected value. ,
Disconnected: Disconnected value. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: description string ,
Required: False ,
}
string ,
actionsRequired:
{
Description: actions required ,
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: REST model used to encapsulate Private Link properties for tracked resources. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: array of group ids ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: private endpoints ,
Required: False ,
}
{
id:
{
Description: id name ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: private endpoints connection state ,
Required: False ,
}
{
status:
{
Description: state status ,
Enum:
{
Approved: Approved value. ,
Pending: Pending value. ,
Rejected: Rejected value. ,
Disconnected: Disconnected value. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: description string ,
Required: False ,
}
string ,
actionsRequired:
{
Description: actions required ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnectionController_Delete (new)
Description :  Deletes the private link resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections/{peConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
peConnectionName:
{
Description: Private link resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
PrivateLinkResourcesController_ListByMasterSite (new)
Description :  Gets the private link resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateLinkResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
requiredMembers:
{
Description: required members ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: required zone names ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: group id ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
PrivateLinkResourcesController_Get (new)
Description :  Gets the private link resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateLinkResources/{privateLinkResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
privateLinkResourceName:
{
Description: Private link resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
requiredMembers:
{
Description: required members ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: required zone names ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: group id ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MasterSitesController_RefreshArcStatus (new)
Description :  Method to refresh arc status from master site for an appliance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/refreshArcStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlSitesController_ListByMasterSite (new)
Description :  Method to get all sites.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlSite items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlSitesController_Get (new)
Description :  Method to get a site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlSitesController_Create (new)
Description :  Method to create a SQL site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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: SQL site web model. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlSitesController_Update (new)
Description :  Method to update an existing site.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The updatable properties of the SqlSite. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlSitesController_Delete (new)
Description :  Deletes the SQL site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlDiscoverySiteDataSourceController_ListBySqlSite (new)
Description :  List SqlDiscoverySiteDataSource resources by SqlSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlDiscoverySiteDataSource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySiteId:
{
Description: Gets or sets the discovery site Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlDiscoverySiteDataSourceController_Get (new)
Description :  Get a SqlDiscoverySiteDataSource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
discoverySiteDataSourceName:
{
Description: SQL Discovery site data source name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySiteId:
{
Description: Gets or sets the discovery site Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlDiscoverySiteDataSourceController_Create (new)
Description :  Create a SqlDiscoverySiteDataSource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
discoverySiteDataSourceName:
{
Description: SQL Discovery site data source name. ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySiteId:
{
Description: Gets or sets the discovery site Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySiteId:
{
Description: Gets or sets the discovery site Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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: A SQL discovery site data source resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySiteId:
{
Description: Gets or sets the discovery site Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlDiscoverySiteDataSourceController_Delete (new)
Description :  Delete a SqlDiscoverySiteDataSource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
discoverySiteDataSourceName:
{
Description: SQL Discovery site data source name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlSitesController_ErrorSummary (new)
Description :  Method to get error summary from SQL site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/errorSummary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
applianceName:
{
Description: Appliance Name. ,
Required: True ,
}
string ,
discoveryScopeErrorSummaries:
{
Description: Gets the error message. ,
Required: True ,
}
{
affectedResourceType:
{
Description: Gets or sets the affected resource type. ,
Required: True ,
}
string ,
affectedObjectsCount:
{
Description: Count of affected objects. ,
Format: int64 ,
Required: True ,
}
integer ,
discoveryScope:
{
Description: Gets or sets the count of affected objects. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
}
,
Required: True ,
}
enum ,
}
,
nextLink:
{
Description: The link to fetch more models. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlSitesController_ExportSqlServerErrors (new)
Description :  Method to generate report containing SQL servers.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/exportSqlServerErrors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlSitesController_ExportSqlServers (new)
Description :  Method to generate report containing SQL servers.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/exportSqlServers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
filter:
{
Description: filter options. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlJobsController_ListBySqlSite (new)
Description :  List SqlJob resources by SqlSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlJob items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
status:
{
Description: Gets operation status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets operation start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets operation end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the display name of the Job. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id used in the operation execution context. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id used in the operation execution context. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
isAgentReportedError:
{
Description: Gets a value indicating whether the error originated from a agent or not. ,
Required: False ,
}
boolean ,
agentErrorCode:
{
Description: Gets the agent error code. ,
Required: False ,
}
string ,
agentErrorMessage:
{
Description: Gets the error message from the agent. ,
Required: False ,
}
string ,
agentErrorPossibleCauses:
{
Description: Gets possible causes for the agent error. ,
Required: False ,
}
string ,
agentErrorRecommendedAction:
{
Description: Gets the recommended action for the agent error. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlJobsController_Get (new)
Description :  Get a SqlJob
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/jobs/{jobName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
jobName:
{
Description: SQL Job name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
status:
{
Description: Gets operation status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets operation start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets operation end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the display name of the Job. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id used in the operation execution context. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id used in the operation execution context. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
isAgentReportedError:
{
Description: Gets a value indicating whether the error originated from a agent or not. ,
Required: False ,
}
boolean ,
agentErrorCode:
{
Description: Gets the agent error code. ,
Required: False ,
}
string ,
agentErrorMessage:
{
Description: Gets the error message from the agent. ,
Required: False ,
}
string ,
agentErrorPossibleCauses:
{
Description: Gets possible causes for the agent error. ,
Required: False ,
}
string ,
agentErrorRecommendedAction:
{
Description: Gets the recommended action for the agent error. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlOperationsStatusController_GetSqlOperationStatus (new)
Description :  Method to get operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/operationsStatus/{operationStatusName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
operationStatusName:
{
Description: Operation status Arm Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the start time. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Operation status properties ,
Required: False ,
}
{
result:
{
Description: Gets or sets the result or output of the workflow. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlSitesController_Refresh (new)
Description :  Method to refresh a site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/refresh
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
applianceName:
{
Description: Gets or sets the appliance name of the agent in the site. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlRunAsAccountsController_ListBySqlSite (new)
Description :  List SqlRunAsAccount resources by SqlSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/runAsAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlRunAsAccount items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the run as account. ,
Required: False ,
}
string ,
credentialType:
{
Description: Gets the credential type of the run as account. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Timestamp marking run as account creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp marking last updated on the run as account. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the appliance name of the run as account. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlRunAsAccountsController_Get (new)
Description :  Get a SqlRunAsAccount
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/runAsAccounts/{accountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
accountName:
{
Description: SQL RunAsAccounts name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the run as account. ,
Required: False ,
}
string ,
credentialType:
{
Description: Gets the credential type of the run as account. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Timestamp marking run as account creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp marking last updated on the run as account. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the appliance name of the run as account. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlAvailabilityGroupsController_ListBySqlSite (new)
Description :  Gets the sql availability groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlAvailabilityGroups
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Required: False ,
}
string ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlAvailabilityGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilityGroupName:
{
Description: Gets or sets the SQL Availability Group Name. ,
Required: False ,
}
string ,
availabilityGroupType:
{
Description: Gets or sets the type of availability group. Currently there are two types of AGs Traditional and Distributed. ,
Enum:
{
Unknown: Unknown value. ,
Traditional: Traditional value. ,
Distributed: Distributed value. ,
}
,
Required: False ,
}
enum ,
isMultiSubNet:
{
Description: Gets or sets a value indicating whether AG is multi subnet or not. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Gets or sets the Cluster name where AG is hosted. ,
Required: False ,
}
string ,
availabilityReplicas:
{
Description: Gets the list of availability replica properties which together forms this availability group. ,
Required: False ,
}
[
{
availabilityReplicaName:
{
Description: Gets or sets the SQL Availability Replica Name. ,
Required: False ,
}
string ,
availabilityReplicaId:
{
Description: Gets or sets the SQL Availability Replica Id. ,
Required: False ,
}
string ,
replicaType:
{
Description: Gets or sets the replica type of the availability group. ,
Enum:
{
Unknown: Unknown value. ,
DatabaseReplica: DatabaseReplica value. ,
AvailabilityGroupReplica: AvailabilityGroupReplica value. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: Gets or sets the state of the availability replica. ,
Enum:
{
Unknown: Unknown value. ,
Primary: Primary value. ,
Secondary: Secondary value. ,
}
,
Required: False ,
}
enum ,
replicaSyncStatus:
{
Description: Gets or sets the synchronization status of the replica. ,
Enum:
{
Unknown: Unknown value. ,
Synchronized: Synchronized value. ,
Unsynchronized: Unsynchronized value. ,
}
,
Required: False ,
}
enum ,
replicaCommitMode:
{
Description: Gets or sets the commit mode of the replica. ,
Enum:
{
Unknown: Unknown value. ,
Synchronous: Synchronous value. ,
Asynchronous: Asynchronous value. ,
}
,
Required: False ,
}
enum ,
replicaReadMode:
{
Description: Gets or sets the read mode of the replica. ,
Enum:
{
Unknown: Unknown value. ,
None: None value. ,
ReadOnly: ReadOnly value. ,
ReadWrite: ReadWrite value. ,
}
,
Required: False ,
}
enum ,
replicaSeedMode:
{
Description: Gets or sets the seed mode of the replica. ,
Enum:
{
Unknown: Unknown value. ,
Manual: Manual value. ,
Automatic: Automatic value. ,
}
,
Required: False ,
}
enum ,
sqlDatabaseReplicaInfo:
{
Description: Gets or sets the Availability Replica object if Replica is of type database. This is null in case Replica is of type AG. This is to be populated in case of normal AG. ,
Required: False ,
}
{
hostName:
{
Description: Gets or sets the host name of the availability replica. ,
Required: False ,
}
string ,
sqlServerName:
{
Description: Gets or sets the SQL Server name of the availability replica. ,
Required: False ,
}
string ,
sqlServerArmId:
{
Description: Gets or sets the SQL Server name of the availability replica. ,
Required: False ,
}
string ,
}
,
sqlAvailabilityGroupReplicaInfo:
{
Description: Gets or sets the Availability Replica object if Replica is of type AG. This is null in case Replica is of type database. This is to be populated in case AG is of type DAG. ,
Required: False ,
}
{
clusterName:
{
Description: Gets or sets the name of the cluster on which this replica is hosted. ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Gets or sets the name of the availability replica. ,
Required: False ,
}
string ,
availabilityGroupArmId:
{
Description: Gets or sets the AG ARM ID which are part of this Replica. ,
Required: False ,
}
string ,
}
,
}
,
]
,
parentReplicaOverviewList:
{
Description: Gets the parent availability replica overview if any. This would be set with details of parent AG and AR for cases where this availability group is a part of a distributed AG. Currently, we do not populate this since discovery and linking of DAG(Distributed Availability Group) is not implemented. ,
Required: False ,
}
[
{
replicaState:
{
Description: Gets or sets the state of the availability replica. ,
Enum:
{
Unknown: Unknown value. ,
Primary: Primary value. ,
Secondary: Secondary value. ,
}
,
Required: False ,
}
enum ,
availabilityReplicaId:
{
Description: Gets or sets the SQL Availability Replica Id within the Availability Group this database is a part of. ,
Required: False ,
}
string ,
availabilityGroupArmId:
{
Description: Gets or sets the Availability Group Id in which this database participates if any. It would be set if the database has {Microsoft.Azure.FDS.CosmosDB.SqlDatabaseEntity.IsDatabaseHighlyAvailable} has a value "true". ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Gets or sets the SQL Availability group name. ,
Required: False ,
}
string ,
}
,
]
,
isPartOfDistributedAvailabilityGroup:
{
Description: Gets or sets a value indicating whether this Availability group is part of a distributed AG. ,
Required: False ,
}
boolean ,
isDeleted:
{
Description: Gets or sets a value indicating whether the entity is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets or sets the marking machine creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets or sets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlAvailabilityGroupsController_Get (new)
Description :  Gets the sql availability group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlAvailabilityGroups/{sqlAvailabilityGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
sqlAvailabilityGroupName:
{
Description: SQL availability group name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilityGroupName:
{
Description: Gets or sets the SQL Availability Group Name. ,
Required: False ,
}
string ,
availabilityGroupType:
{
Description: Gets or sets the type of availability group. Currently there are two types of AGs Traditional and Distributed. ,
Enum:
{
Unknown: Unknown value. ,
Traditional: Traditional value. ,
Distributed: Distributed value. ,
}
,
Required: False ,
}
enum ,
isMultiSubNet:
{
Description: Gets or sets a value indicating whether AG is multi subnet or not. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Gets or sets the Cluster name where AG is hosted. ,
Required: False ,
}
string ,
availabilityReplicas:
{
Description: Gets the list of availability replica properties which together forms this availability group. ,
Required: False ,
}
[
{
availabilityReplicaName:
{
Description: Gets or sets the SQL Availability Replica Name. ,
Required: False ,
}
string ,
availabilityReplicaId:
{
Description: Gets or sets the SQL Availability Replica Id. ,
Required: False ,
}
string ,
replicaType:
{
Description: Gets or sets the replica type of the availability group. ,
Enum:
{
Unknown: Unknown value. ,
DatabaseReplica: DatabaseReplica value. ,
AvailabilityGroupReplica: AvailabilityGroupReplica value. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: Gets or sets the state of the availability replica. ,
Enum:
{
Unknown: Unknown value. ,
Primary: Primary value. ,
Secondary: Secondary value. ,
}
,
Required: False ,
}
enum ,
replicaSyncStatus:
{
Description: Gets or sets the synchronization status of the replica. ,
Enum:
{
Unknown: Unknown value. ,
Synchronized: Synchronized value. ,
Unsynchronized: Unsynchronized value. ,
}
,
Required: False ,
}
enum ,
replicaCommitMode:
{
Description: Gets or sets the commit mode of the replica. ,
Enum:
{
Unknown: Unknown value. ,
Synchronous: Synchronous value. ,
Asynchronous: Asynchronous value. ,
}
,
Required: False ,
}
enum ,
replicaReadMode:
{
Description: Gets or sets the read mode of the replica. ,
Enum:
{
Unknown: Unknown value. ,
None: None value. ,
ReadOnly: ReadOnly value. ,
ReadWrite: ReadWrite value. ,
}
,
Required: False ,
}
enum ,
replicaSeedMode:
{
Description: Gets or sets the seed mode of the replica. ,
Enum:
{
Unknown: Unknown value. ,
Manual: Manual value. ,
Automatic: Automatic value. ,
}
,
Required: False ,
}
enum ,
sqlDatabaseReplicaInfo:
{
Description: Gets or sets the Availability Replica object if Replica is of type database. This is null in case Replica is of type AG. This is to be populated in case of normal AG. ,
Required: False ,
}
{
hostName:
{
Description: Gets or sets the host name of the availability replica. ,
Required: False ,
}
string ,
sqlServerName:
{
Description: Gets or sets the SQL Server name of the availability replica. ,
Required: False ,
}
string ,
sqlServerArmId:
{
Description: Gets or sets the SQL Server name of the availability replica. ,
Required: False ,
}
string ,
}
,
sqlAvailabilityGroupReplicaInfo:
{
Description: Gets or sets the Availability Replica object if Replica is of type AG. This is null in case Replica is of type database. This is to be populated in case AG is of type DAG. ,
Required: False ,
}
{
clusterName:
{
Description: Gets or sets the name of the cluster on which this replica is hosted. ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Gets or sets the name of the availability replica. ,
Required: False ,
}
string ,
availabilityGroupArmId:
{
Description: Gets or sets the AG ARM ID which are part of this Replica. ,
Required: False ,
}
string ,
}
,
}
,
]
,
parentReplicaOverviewList:
{
Description: Gets the parent availability replica overview if any. This would be set with details of parent AG and AR for cases where this availability group is a part of a distributed AG. Currently, we do not populate this since discovery and linking of DAG(Distributed Availability Group) is not implemented. ,
Required: False ,
}
[
{
replicaState:
{
Description: Gets or sets the state of the availability replica. ,
Enum:
{
Unknown: Unknown value. ,
Primary: Primary value. ,
Secondary: Secondary value. ,
}
,
Required: False ,
}
enum ,
availabilityReplicaId:
{
Description: Gets or sets the SQL Availability Replica Id within the Availability Group this database is a part of. ,
Required: False ,
}
string ,
availabilityGroupArmId:
{
Description: Gets or sets the Availability Group Id in which this database participates if any. It would be set if the database has {Microsoft.Azure.FDS.CosmosDB.SqlDatabaseEntity.IsDatabaseHighlyAvailable} has a value "true". ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Gets or sets the SQL Availability group name. ,
Required: False ,
}
string ,
}
,
]
,
isPartOfDistributedAvailabilityGroup:
{
Description: Gets or sets a value indicating whether this Availability group is part of a distributed AG. ,
Required: False ,
}
boolean ,
isDeleted:
{
Description: Gets or sets a value indicating whether the entity is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets or sets the marking machine creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets or sets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlDatabasesController_ListBySqlSite (new)
Description :  Gets the sql Databases.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlDatabases
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Required: False ,
}
string ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlDatabaseV2 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
parentReplicaOverview:
{
Description: Gets or sets the Replica overview. ,
Required: False ,
}
{
replicaState:
{
Description: Gets or sets the state of the availability replica. ,
Enum:
{
Unknown: Unknown value. ,
Primary: Primary value. ,
Secondary: Secondary value. ,
}
,
Required: False ,
}
enum ,
availabilityReplicaId:
{
Description: Gets or sets the SQL Availability Replica Id within the Availability Group this database is a part of. ,
Required: False ,
}
string ,
availabilityGroupArmId:
{
Description: Gets or sets the Availability Group Id in which this database participates if any. It would be set if the database has {Microsoft.Azure.FDS.CosmosDB.SqlDatabaseEntity.IsDatabaseHighlyAvailable} has a value "true". ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Gets or sets the SQL Availability group name. ,
Required: False ,
}
string ,
}
,
isDatabaseHighlyAvailable:
{
Description: Gets or sets a value indicating whether this database is a part of an HA setup. ,
Required: False ,
}
boolean ,
fileMetadataList:
{
Description: Gets the file metadata list. ,
Required: False ,
}
[
{
logicalName:
{
Description: Gets or sets the logical name of the file. ,
Required: False ,
}
string ,
physicalFullName:
{
Description: Gets or sets the operating-system full path of the file. ,
Required: False ,
}
string ,
fileType:
{
Description: Gets or sets the database file type. ,
Enum:
{
Rows: Rows value. ,
Log: Log value. ,
Filestream: Filestream value. ,
NotSupported: NotSpecified value. ,
Fulltext: Fulltext value. ,
}
,
Required: False ,
}
enum ,
sizeInMb:
{
Description: Gets or sets the size of the file in MB. ,
Format: float ,
Required: False ,
}
number ,
isMemoryOptimizedDataOptionEnabled:
{
Description: Gets or sets a value indicating whether memory optimized data option is enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
hostname:
{
Description: Gets or sets the hostname. ,
Required: False ,
}
string ,
sqlServerName:
{
Description: Gets or sets the SQL Server Id in which the database resides. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status. ,
Required: False ,
}
string ,
sizeMb:
{
Description: Gets or sets the size in Mb. ,
Format: float ,
Required: False ,
}
number ,
databaseName:
{
Description: Gets or sets the SQL database name. ,
Required: False ,
}
string ,
sqlServerArmId:
{
Description: Gets or sets the SQL Server ARM Id in which the database resides. ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: Gets or sets the database compatibility level. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Gets or sets a value indicating whether the entity is deleted. ,
Required: False ,
}
boolean ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int32 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdTimestamp:
{
Description: Gets or sets the marking machine creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets or sets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlDatabasesController_Get (new)
Description :  Gets the sql Database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlDatabases/{sqlDatabaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
sqlDatabaseName:
{
Description: SQL Database name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
parentReplicaOverview:
{
Description: Gets or sets the Replica overview. ,
Required: False ,
}
{
replicaState:
{
Description: Gets or sets the state of the availability replica. ,
Enum:
{
Unknown: Unknown value. ,
Primary: Primary value. ,
Secondary: Secondary value. ,
}
,
Required: False ,
}
enum ,
availabilityReplicaId:
{
Description: Gets or sets the SQL Availability Replica Id within the Availability Group this database is a part of. ,
Required: False ,
}
string ,
availabilityGroupArmId:
{
Description: Gets or sets the Availability Group Id in which this database participates if any. It would be set if the database has {Microsoft.Azure.FDS.CosmosDB.SqlDatabaseEntity.IsDatabaseHighlyAvailable} has a value "true". ,
Required: False ,
}
string ,
availabilityGroupName:
{
Description: Gets or sets the SQL Availability group name. ,
Required: False ,
}
string ,
}
,
isDatabaseHighlyAvailable:
{
Description: Gets or sets a value indicating whether this database is a part of an HA setup. ,
Required: False ,
}
boolean ,
fileMetadataList:
{
Description: Gets the file metadata list. ,
Required: False ,
}
[
{
logicalName:
{
Description: Gets or sets the logical name of the file. ,
Required: False ,
}
string ,
physicalFullName:
{
Description: Gets or sets the operating-system full path of the file. ,
Required: False ,
}
string ,
fileType:
{
Description: Gets or sets the database file type. ,
Enum:
{
Rows: Rows value. ,
Log: Log value. ,
Filestream: Filestream value. ,
NotSupported: NotSpecified value. ,
Fulltext: Fulltext value. ,
}
,
Required: False ,
}
enum ,
sizeInMb:
{
Description: Gets or sets the size of the file in MB. ,
Format: float ,
Required: False ,
}
number ,
isMemoryOptimizedDataOptionEnabled:
{
Description: Gets or sets a value indicating whether memory optimized data option is enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
hostname:
{
Description: Gets or sets the hostname. ,
Required: False ,
}
string ,
sqlServerName:
{
Description: Gets or sets the SQL Server Id in which the database resides. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status. ,
Required: False ,
}
string ,
sizeMb:
{
Description: Gets or sets the size in Mb. ,
Format: float ,
Required: False ,
}
number ,
databaseName:
{
Description: Gets or sets the SQL database name. ,
Required: False ,
}
string ,
sqlServerArmId:
{
Description: Gets or sets the SQL Server ARM Id in which the database resides. ,
Required: False ,
}
string ,
compatibilityLevel:
{
Description: Gets or sets the database compatibility level. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Gets or sets a value indicating whether the entity is deleted. ,
Required: False ,
}
boolean ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int32 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdTimestamp:
{
Description: Gets or sets the marking machine creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets or sets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlServersController_ListBySqlSite (new)
Description :  Gets the sql servers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Required: False ,
}
string ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SqlServerV2 items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
machineOverviewList:
{
Description: Gets the Machine Overview properties of all machines on which the SQL server is deployed. ,
Required: False ,
}
[
{
machineArmId:
{
Description: Gets or sets SQL machine ARM ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets SQL machine display name. ,
Required: False ,
}
string ,
fciRole:
{
Description: Gets or sets SQL machine FCI role. ,
Enum:
{
Unknown: Unknown value. ,
NotApplicable: NotApplicable value. ,
ActiveNode: ActiveNode value. ,
PossibleOwnerNode: PossibleOwnerNode value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
numberOfAgDatabases:
{
Description: Gets or sets the number of databases part of availability group on this SQL instance. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlFciProperties:
{
Description: Gets or sets the FCI properties if the instance is an FCI instance. This would be populated if IsClustered is true. ,
Required: False ,
}
{
state:
{
Description: Gets or sets the state of the FCI instance. ,
Enum:
{
Unknown: Unknown value. ,
Inherited: Inherited value. ,
Initializing: Initializing value. ,
Online: Online value. ,
Offline: Offline value. ,
Failed: Failed value. ,
Pending: Pending value. ,
OnlinePending: OnlinePending value. ,
OfflinePending: OfflinePending value. ,
}
,
Required: False ,
}
enum ,
networkName:
{
Description: Gets or sets the FCI Network Name used to connect to this FCI instance. ,
Required: False ,
}
string ,
isMultiSubnet:
{
Description: Gets or sets a value indicating whether the FCI is hosted on possible owners which are in multiple subnets. ,
Required: False ,
}
boolean ,
sharedDiskCount:
{
Description: Gets or sets the count of Shared Disks for SQL FCI. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
version:
{
Description: Gets or sets the SQL server version. ,
Required: False ,
}
string ,
numberOfUserDatabases:
{
Description: Gets or sets total number of users databases. ,
Format: int32 ,
Required: False ,
}
integer ,
sumOfUserDatabasesSizeInMb:
{
Description: Gets or sets total size of all user databases. ,
Format: float ,
Required: False ,
}
number ,
tempDbSizeInMb:
{
Description: Gets or sets size of temp database. ,
Format: float ,
Required: False ,
}
number ,
maxServerMemoryInUseInMb:
{
Description: Gets or sets maximum server memory in use. ,
Format: float ,
Required: False ,
}
number ,
visibleOnlineCoreCount:
{
Description: Gets or sets the SQL server number of cores that have visible online status. ,
Format: int32 ,
Required: False ,
}
integer ,
numOfLogins:
{
Description: Gets or sets number of logins. ,
Format: int32 ,
Required: False ,
}
integer ,
physicalCpuCount:
{
Description: Gets or sets physical CPU count. ,
Format: float ,
Required: False ,
}
number ,
logicalCpuCount:
{
Description: Gets or sets logical CPU count. ,
Format: int32 ,
Required: False ,
}
integer ,
engineEdition:
{
Description: Gets or sets the SQL server engine edition. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets the SQL server edition. ,
Required: False ,
}
string ,
isHighAvailabilityEnabled:
{
Description: Gets or sets a value indicating whether High Availability is enabled or not. ,
Required: False ,
}
boolean ,
isClustered:
{
Description: Gets or sets a value indicating whether failover cluster is configured or not. ,
Required: False ,
}
boolean ,
hyperthreadRatio:
{
Description: Gets or sets the Hyper thread ratio. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlStartTime:
{
Description: Gets or sets the SQL start time. ,
Format: date-time ,
Required: False ,
}
string ,
machineArmIds:
{
Description: Gets the list of machine ARM Ids on which the SQL server is deployed. ,
Required: False ,
}
[
string ,
]
,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the SQL server. ,
Required: False ,
}
string ,
hydratedRunAsAccountId:
{
Description: Gets or sets the hydrated run as account ID of the SQL server. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets hostname. ,
Required: False ,
}
string ,
sqlServerName:
{
Description: Gets or sets the SQL server instance name. ,
Required: False ,
}
string ,
portNumber:
{
Description: Gets or sets the Preferred Port Number. ,
Format: int32 ,
Required: False ,
}
integer ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int32 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
tags:
{
Description: Gets or sets tags on the resource. ,
Required: False ,
}
object ,
isDeleted:
{
Description: Gets or sets a value indicating whether the entity is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets or sets the marking machine creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets or sets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the powered on status. ,
Enum:
{
Unknown: Unknown value. ,
ContinuePending: ContinuePending value. ,
Paused: Paused value. ,
PausePending: PausePending value. ,
Running: Running value. ,
StartPending: StartPending value. ,
Stopped: Stopped value. ,
StopPending: StopPending value. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlServersController_Get (new)
Description :  Gets the sql server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers/{sqlServerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
sqlServerName:
{
Description: SQL server name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
machineOverviewList:
{
Description: Gets the Machine Overview properties of all machines on which the SQL server is deployed. ,
Required: False ,
}
[
{
machineArmId:
{
Description: Gets or sets SQL machine ARM ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets SQL machine display name. ,
Required: False ,
}
string ,
fciRole:
{
Description: Gets or sets SQL machine FCI role. ,
Enum:
{
Unknown: Unknown value. ,
NotApplicable: NotApplicable value. ,
ActiveNode: ActiveNode value. ,
PossibleOwnerNode: PossibleOwnerNode value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
numberOfAgDatabases:
{
Description: Gets or sets the number of databases part of availability group on this SQL instance. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlFciProperties:
{
Description: Gets or sets the FCI properties if the instance is an FCI instance. This would be populated if IsClustered is true. ,
Required: False ,
}
{
state:
{
Description: Gets or sets the state of the FCI instance. ,
Enum:
{
Unknown: Unknown value. ,
Inherited: Inherited value. ,
Initializing: Initializing value. ,
Online: Online value. ,
Offline: Offline value. ,
Failed: Failed value. ,
Pending: Pending value. ,
OnlinePending: OnlinePending value. ,
OfflinePending: OfflinePending value. ,
}
,
Required: False ,
}
enum ,
networkName:
{
Description: Gets or sets the FCI Network Name used to connect to this FCI instance. ,
Required: False ,
}
string ,
isMultiSubnet:
{
Description: Gets or sets a value indicating whether the FCI is hosted on possible owners which are in multiple subnets. ,
Required: False ,
}
boolean ,
sharedDiskCount:
{
Description: Gets or sets the count of Shared Disks for SQL FCI. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
version:
{
Description: Gets or sets the SQL server version. ,
Required: False ,
}
string ,
numberOfUserDatabases:
{
Description: Gets or sets total number of users databases. ,
Format: int32 ,
Required: False ,
}
integer ,
sumOfUserDatabasesSizeInMb:
{
Description: Gets or sets total size of all user databases. ,
Format: float ,
Required: False ,
}
number ,
tempDbSizeInMb:
{
Description: Gets or sets size of temp database. ,
Format: float ,
Required: False ,
}
number ,
maxServerMemoryInUseInMb:
{
Description: Gets or sets maximum server memory in use. ,
Format: float ,
Required: False ,
}
number ,
visibleOnlineCoreCount:
{
Description: Gets or sets the SQL server number of cores that have visible online status. ,
Format: int32 ,
Required: False ,
}
integer ,
numOfLogins:
{
Description: Gets or sets number of logins. ,
Format: int32 ,
Required: False ,
}
integer ,
physicalCpuCount:
{
Description: Gets or sets physical CPU count. ,
Format: float ,
Required: False ,
}
number ,
logicalCpuCount:
{
Description: Gets or sets logical CPU count. ,
Format: int32 ,
Required: False ,
}
integer ,
engineEdition:
{
Description: Gets or sets the SQL server engine edition. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets the SQL server edition. ,
Required: False ,
}
string ,
isHighAvailabilityEnabled:
{
Description: Gets or sets a value indicating whether High Availability is enabled or not. ,
Required: False ,
}
boolean ,
isClustered:
{
Description: Gets or sets a value indicating whether failover cluster is configured or not. ,
Required: False ,
}
boolean ,
hyperthreadRatio:
{
Description: Gets or sets the Hyper thread ratio. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlStartTime:
{
Description: Gets or sets the SQL start time. ,
Format: date-time ,
Required: False ,
}
string ,
machineArmIds:
{
Description: Gets the list of machine ARM Ids on which the SQL server is deployed. ,
Required: False ,
}
[
string ,
]
,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the SQL server. ,
Required: False ,
}
string ,
hydratedRunAsAccountId:
{
Description: Gets or sets the hydrated run as account ID of the SQL server. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets hostname. ,
Required: False ,
}
string ,
sqlServerName:
{
Description: Gets or sets the SQL server instance name. ,
Required: False ,
}
string ,
portNumber:
{
Description: Gets or sets the Preferred Port Number. ,
Format: int32 ,
Required: False ,
}
integer ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int32 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
tags:
{
Description: Gets or sets tags on the resource. ,
Required: False ,
}
object ,
isDeleted:
{
Description: Gets or sets a value indicating whether the entity is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets or sets the marking machine creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets or sets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the powered on status. ,
Enum:
{
Unknown: Unknown value. ,
ContinuePending: ContinuePending value. ,
Paused: Paused value. ,
PausePending: PausePending value. ,
Running: Running value. ,
StartPending: StartPending value. ,
Stopped: Stopped value. ,
StopPending: StopPending value. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlServersController_Update (new)
Description :  Updates the sql server tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers/{sqlServerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
sqlServerName:
{
Description: SQL server name. ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The updatable properties of the SqlServerV2. ,
Required: False ,
}
{
numberOfAgDatabases:
{
Description: Gets or sets the number of databases part of availability group on this SQL instance. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlFciProperties:
{
Description: Gets or sets the FCI properties if the instance is an FCI instance. This would be populated if IsClustered is true. ,
Required: False ,
}
{
state:
{
Description: Gets or sets the state of the FCI instance. ,
Enum:
{
Unknown: Unknown value. ,
Inherited: Inherited value. ,
Initializing: Initializing value. ,
Online: Online value. ,
Offline: Offline value. ,
Failed: Failed value. ,
Pending: Pending value. ,
OnlinePending: OnlinePending value. ,
OfflinePending: OfflinePending value. ,
}
,
Required: False ,
}
enum ,
networkName:
{
Description: Gets or sets the FCI Network Name used to connect to this FCI instance. ,
Required: False ,
}
string ,
isMultiSubnet:
{
Description: Gets or sets a value indicating whether the FCI is hosted on possible owners which are in multiple subnets. ,
Required: False ,
}
boolean ,
sharedDiskCount:
{
Description: Gets or sets the count of Shared Disks for SQL FCI. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
version:
{
Description: Gets or sets the SQL server version. ,
Required: False ,
}
string ,
numberOfUserDatabases:
{
Description: Gets or sets total number of users databases. ,
Format: int32 ,
Required: False ,
}
integer ,
sumOfUserDatabasesSizeInMb:
{
Description: Gets or sets total size of all user databases. ,
Format: float ,
Required: False ,
}
number ,
tempDbSizeInMb:
{
Description: Gets or sets size of temp database. ,
Format: float ,
Required: False ,
}
number ,
maxServerMemoryInUseInMb:
{
Description: Gets or sets maximum server memory in use. ,
Format: float ,
Required: False ,
}
number ,
visibleOnlineCoreCount:
{
Description: Gets or sets the SQL server number of cores that have visible online status. ,
Format: int32 ,
Required: False ,
}
integer ,
numOfLogins:
{
Description: Gets or sets number of logins. ,
Format: int32 ,
Required: False ,
}
integer ,
physicalCpuCount:
{
Description: Gets or sets physical CPU count. ,
Format: float ,
Required: False ,
}
number ,
logicalCpuCount:
{
Description: Gets or sets logical CPU count. ,
Format: int32 ,
Required: False ,
}
integer ,
engineEdition:
{
Description: Gets or sets the SQL server engine edition. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets the SQL server edition. ,
Required: False ,
}
string ,
isHighAvailabilityEnabled:
{
Description: Gets or sets a value indicating whether High Availability is enabled or not. ,
Required: False ,
}
boolean ,
isClustered:
{
Description: Gets or sets a value indicating whether failover cluster is configured or not. ,
Required: False ,
}
boolean ,
hyperthreadRatio:
{
Description: Gets or sets the Hyper thread ratio. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlStartTime:
{
Description: Gets or sets the SQL start time. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the SQL server. ,
Required: False ,
}
string ,
hydratedRunAsAccountId:
{
Description: Gets or sets the hydrated run as account ID of the SQL server. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets hostname. ,
Required: False ,
}
string ,
sqlServerName:
{
Description: Gets or sets the SQL server instance name. ,
Required: False ,
}
string ,
portNumber:
{
Description: Gets or sets the Preferred Port Number. ,
Format: int32 ,
Required: False ,
}
integer ,
tags:
{
Description: Gets or sets tags on the resource. ,
Required: False ,
}
object ,
isDeleted:
{
Description: Gets or sets a value indicating whether the entity is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets or sets the marking machine creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets or sets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the powered on status. ,
Enum:
{
Unknown: Unknown value. ,
ContinuePending: ContinuePending value. ,
Paused: Paused value. ,
PausePending: PausePending value. ,
Running: Running value. ,
StartPending: StartPending value. ,
Stopped: Stopped value. ,
StopPending: StopPending value. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
machineOverviewList:
{
Description: Gets the Machine Overview properties of all machines on which the SQL server is deployed. ,
Required: False ,
}
[
{
machineArmId:
{
Description: Gets or sets SQL machine ARM ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets SQL machine display name. ,
Required: False ,
}
string ,
fciRole:
{
Description: Gets or sets SQL machine FCI role. ,
Enum:
{
Unknown: Unknown value. ,
NotApplicable: NotApplicable value. ,
ActiveNode: ActiveNode value. ,
PossibleOwnerNode: PossibleOwnerNode value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
numberOfAgDatabases:
{
Description: Gets or sets the number of databases part of availability group on this SQL instance. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlFciProperties:
{
Description: Gets or sets the FCI properties if the instance is an FCI instance. This would be populated if IsClustered is true. ,
Required: False ,
}
{
state:
{
Description: Gets or sets the state of the FCI instance. ,
Enum:
{
Unknown: Unknown value. ,
Inherited: Inherited value. ,
Initializing: Initializing value. ,
Online: Online value. ,
Offline: Offline value. ,
Failed: Failed value. ,
Pending: Pending value. ,
OnlinePending: OnlinePending value. ,
OfflinePending: OfflinePending value. ,
}
,
Required: False ,
}
enum ,
networkName:
{
Description: Gets or sets the FCI Network Name used to connect to this FCI instance. ,
Required: False ,
}
string ,
isMultiSubnet:
{
Description: Gets or sets a value indicating whether the FCI is hosted on possible owners which are in multiple subnets. ,
Required: False ,
}
boolean ,
sharedDiskCount:
{
Description: Gets or sets the count of Shared Disks for SQL FCI. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
version:
{
Description: Gets or sets the SQL server version. ,
Required: False ,
}
string ,
numberOfUserDatabases:
{
Description: Gets or sets total number of users databases. ,
Format: int32 ,
Required: False ,
}
integer ,
sumOfUserDatabasesSizeInMb:
{
Description: Gets or sets total size of all user databases. ,
Format: float ,
Required: False ,
}
number ,
tempDbSizeInMb:
{
Description: Gets or sets size of temp database. ,
Format: float ,
Required: False ,
}
number ,
maxServerMemoryInUseInMb:
{
Description: Gets or sets maximum server memory in use. ,
Format: float ,
Required: False ,
}
number ,
visibleOnlineCoreCount:
{
Description: Gets or sets the SQL server number of cores that have visible online status. ,
Format: int32 ,
Required: False ,
}
integer ,
numOfLogins:
{
Description: Gets or sets number of logins. ,
Format: int32 ,
Required: False ,
}
integer ,
physicalCpuCount:
{
Description: Gets or sets physical CPU count. ,
Format: float ,
Required: False ,
}
number ,
logicalCpuCount:
{
Description: Gets or sets logical CPU count. ,
Format: int32 ,
Required: False ,
}
integer ,
engineEdition:
{
Description: Gets or sets the SQL server engine edition. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets the SQL server edition. ,
Required: False ,
}
string ,
isHighAvailabilityEnabled:
{
Description: Gets or sets a value indicating whether High Availability is enabled or not. ,
Required: False ,
}
boolean ,
isClustered:
{
Description: Gets or sets a value indicating whether failover cluster is configured or not. ,
Required: False ,
}
boolean ,
hyperthreadRatio:
{
Description: Gets or sets the Hyper thread ratio. ,
Format: int32 ,
Required: False ,
}
integer ,
sqlStartTime:
{
Description: Gets or sets the SQL start time. ,
Format: date-time ,
Required: False ,
}
string ,
machineArmIds:
{
Description: Gets the list of machine ARM Ids on which the SQL server is deployed. ,
Required: False ,
}
[
string ,
]
,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the SQL server. ,
Required: False ,
}
string ,
hydratedRunAsAccountId:
{
Description: Gets or sets the hydrated run as account ID of the SQL server. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets hostname. ,
Required: False ,
}
string ,
sqlServerName:
{
Description: Gets or sets the SQL server instance name. ,
Required: False ,
}
string ,
portNumber:
{
Description: Gets or sets the Preferred Port Number. ,
Format: int32 ,
Required: False ,
}
integer ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int32 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
tags:
{
Description: Gets or sets tags on the resource. ,
Required: False ,
}
object ,
isDeleted:
{
Description: Gets or sets a value indicating whether the entity is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets or sets the marking machine creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets or sets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the powered on status. ,
Enum:
{
Unknown: Unknown value. ,
ContinuePending: ContinuePending value. ,
Paused: Paused value. ,
PausePending: PausePending value. ,
Running: Running value. ,
StartPending: StartPending value. ,
Stopped: Stopped value. ,
StopPending: StopPending value. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SqlSitesController_Summary (new)
Description :  Method to get site usage/summary.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/summary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
sqlSiteName:
{
Description: SQL site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serverCount:
{
Description: Gets or sets the number of servers discovered in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseCount:
{
Description: Gets or sets the number of databases discovered in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsAccountCount:
{
Description: Gets or sets the number of run as accounts in the site. ,
Format: int32 ,
Required: False ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppSitesController_ListByMasterSite (new)
Description :  Method to get all sites.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WebAppSite items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppSitesController_Get (new)
Description :  Method to get a site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppSitesController_Create (new)
Description :  Method to create a WebApp site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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: WebApp site web model. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppSitesController_Update (new)
Description :  Method to update an existing site.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The updatable properties of the WebAppSite. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
siteAppliancePropertiesCollection:
{
Description: Gets or sets the appliance details used by service to communicate to the appliance. ,
Required: False ,
}
[
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
]
,
discoveryScenario:
{
Description: Gets or sets the discovery scenario. ,
Enum:
{
Migrate: Migrate value. ,
DR: DR value. ,
}
,
Required: False ,
}
enum ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppSitesController_Delete (new)
Description :  Deletes the WebApp site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppDiscoverySiteDataSourcesController_ListByWebAppSite (new)
Description :  Method to get all Web app data sources in site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DiscoverySiteDataSource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySiteId:
{
Description: Gets or sets the discovery site Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppDiscoverySiteDataSourcesController_Get (new)
Description :  Method to get a Web app data source in site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
discoverySiteDataSourceName:
{
Description: Data Source ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySiteId:
{
Description: Gets or sets the discovery site Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppDiscoverySiteDataSourcesController_Create (new)
Description :  Method to create or update a Web app data source in site.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
discoverySiteDataSourceName:
{
Description: Data Source ARM name. ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySiteId:
{
Description: Gets or sets the discovery site Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySiteId:
{
Description: Gets or sets the discovery site Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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: Web app data source web model. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
discoverySiteId:
{
Description: Gets or sets the discovery site Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppDiscoverySiteDataSourcesController_Delete (new)
Description :  Method to delete a Web app data source in site.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
discoverySiteDataSourceName:
{
Description: Data Source ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppSitesController_ErrorSummary (new)
Description :  MMethod to get error summary from web app site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/errorSummary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
applianceName:
{
Description: Appliance Name. ,
Required: True ,
}
string ,
discoveryScopeErrorSummaries:
{
Description: Gets the error message. ,
Required: True ,
}
{
affectedResourceType:
{
Description: Gets or sets the affected resource type. ,
Required: True ,
}
string ,
affectedObjectsCount:
{
Description: Count of affected objects. ,
Format: int64 ,
Required: True ,
}
integer ,
discoveryScope:
{
Description: Gets or sets the count of affected objects. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
}
,
Required: True ,
}
enum ,
}
,
nextLink:
{
Description: The link to fetch more models. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppSitesController_ExportInventory (new)
Description :  Method to generate report containing web app inventory.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/exportInventory
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
filter:
{
Description: filter options. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppExtendedMachinesController_ListByWebAppSite (new)
Description :  Method to get all extended machines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/extendedMachines
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Required: False ,
}
string ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WebAppExtendedMachine items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostName:
{
Description: Gets the hydrated host name. ,
Required: False ,
}
string ,
machineDisplayName:
{
Description: Gets the Name of the extended machine. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets the machine ARM id. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets the run as account ID of the machine used for web app discovery. ,
Required: False ,
}
string ,
hydratedRunAsAccountId:
{
Description: Gets the agent hydrated run as account. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppExtendedMachinesController_Get (new)
Description :  Method to get a extended machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/extendedMachines/{extendedMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
extendedMachineName:
{
Description: Extended machine name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostName:
{
Description: Gets the hydrated host name. ,
Required: False ,
}
string ,
machineDisplayName:
{
Description: Gets the Name of the extended machine. ,
Required: False ,
}
string ,
machineId:
{
Description: Gets the machine ARM id. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets the run as account ID of the machine used for web app discovery. ,
Required: False ,
}
string ,
hydratedRunAsAccountId:
{
Description: Gets the agent hydrated run as account. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
IisWebApplicationsController_ListByWebAppSite (new)
Description :  Method to get all IIS web application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebApplications
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Required: False ,
}
string ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IisWebApplications items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
applications:
{
Description: Gets the list of application units for the web site. ,
Required: False ,
}
[
{
applicationPoolName:
{
Description: Gets or sets the path of the directory. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Gets or sets the managed pipeline mode. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Gets or sets the runtime version. ,
Required: False ,
}
string ,
enable32BitApiOnWin64:
{
Description: Gets or sets a value indicating whether 32 bit applications are allowed to run on 64 bit. ,
Required: False ,
}
boolean ,
path:
{
Description: Gets or sets the path of the directory. ,
Required: False ,
}
{
virtual:
{
Description: Gets or sets the virtual path for the directory. ,
Required: False ,
}
string ,
physical:
{
Description: Gets or sets the physical path of the directory on the web server. ,
Required: False ,
}
string ,
}
,
directories:
{
Description: Gets or sets the list of directories. ,
Required: False ,
}
[
{
virtual:
{
Description: Gets or sets the virtual path for the directory. ,
Required: False ,
}
string ,
physical:
{
Description: Gets or sets the physical path of the directory on the web server. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
virtualApplications:
{
Description: Gets the list of application units for the web site. ,
Required: False ,
}
[
{
isVirtualDirectory:
{
Description: Gets a value indicating whether the application corresponds to a directory. ,
Required: False ,
}
boolean ,
path:
{
Description: Gets or sets the path of the directory. ,
Required: False ,
}
{
virtual:
{
Description: Gets or sets the virtual path for the directory. ,
Required: False ,
}
string ,
physical:
{
Description: Gets or sets the physical path of the directory on the web server. ,
Required: False ,
}
string ,
}
,
directories:
{
Description: Gets or sets the list of directories. ,
Required: False ,
}
[
{
virtual:
{
Description: Gets or sets the virtual path for the directory. ,
Required: False ,
}
string ,
physical:
{
Description: Gets or sets the physical path of the directory on the web server. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
webServerId:
{
Description: Gets the web server id. ,
Required: False ,
}
string ,
webServerName:
{
Description: Gets the web server name. ,
Required: False ,
}
string ,
machineArmIds:
{
Description: Gets the list of machine ARM Ids on which the SQL server is deployed. ,
Required: False ,
}
[
string ,
]
,
virtualPath:
{
Description: Gets the virtual path of the application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Gets the physical path of the application. ,
Required: False ,
}
string ,
bindings:
{
Description: Gets the front end bindings for the application. ,
Required: False ,
}
[
{
protocol:
{
Description: Gets or sets the Binding protocol. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets the Host name. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the Port number. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Gets or sets the IP Address. ,
Required: False ,
}
string ,
}
,
]
,
frameworks:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the framework. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the framework. ,
Required: False ,
}
string ,
}
,
]
,
configurations:
{
Description: Gets the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the configuration name. ,
Required: False ,
}
string ,
filePath:
{
Description: Gets or sets the configuration file path. ,
Required: False ,
}
string ,
localFilePath:
{
Description: Gets or sets the configuration local file path. ,
Required: False ,
}
string ,
targetFilePath:
{
Description: Gets or sets the configuration target file path. ,
Required: False ,
}
string ,
section:
{
Description: Gets or sets the configuration section in the file. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the configuration type. ,
Required: False ,
}
string ,
isDeploymentTimeEditable:
{
Description: Gets or sets a value indicating whether the configuration is edited or not by the user. ,
Required: False ,
}
boolean ,
identifier:
{
Description: Gets or sets the identifier for the configuration. ,
Required: False ,
}
string ,
}
,
]
,
directories:
{
Description: Gets the directories. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the unique id corresponding to the application directory. ,
Required: False ,
}
string ,
isEditable:
{
Description: Gets or sets a value indicating whether the directory object is editable. True when the directory is added as an optional directory, false when discovery is done manually. ,
Required: False ,
}
boolean ,
sourcePaths:
{
Description: Gets or sets the paths of the directory on the source machine. ,
Required: False ,
}
[
string ,
]
,
localScratchPath:
{
Description: Gets or sets the local scratch path at which the directories has been copied. ,
Required: False ,
}
string ,
mountPath:
{
Description: Gets or sets the mount path of the application directory. ,
Required: False ,
}
string ,
sourceSize:
{
Description: Gets or sets the size of the directory on the source machine. ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Gets the display name. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the resource. ,
Required: False ,
}
object ,
staticFolders:
{
Description: Static folders. ,
Required: False ,
}
[
string ,
]
,
machineDisplayName:
{
Description: Machine display name ,
Required: False ,
}
string ,
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
serverType:
{
Description: Gets the server type. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
hasErrors:
{
Description: Gets a value indicating whether the WebApp has errors or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
IisWebApplicationsController_Get (new)
Description :  Method to get an IIS web application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebApplications/{webApplicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
webApplicationName:
{
Description: Web application name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
applications:
{
Description: Gets the list of application units for the web site. ,
Required: False ,
}
[
{
applicationPoolName:
{
Description: Gets or sets the path of the directory. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Gets or sets the managed pipeline mode. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Gets or sets the runtime version. ,
Required: False ,
}
string ,
enable32BitApiOnWin64:
{
Description: Gets or sets a value indicating whether 32 bit applications are allowed to run on 64 bit. ,
Required: False ,
}
boolean ,
path:
{
Description: Gets or sets the path of the directory. ,
Required: False ,
}
{
virtual:
{
Description: Gets or sets the virtual path for the directory. ,
Required: False ,
}
string ,
physical:
{
Description: Gets or sets the physical path of the directory on the web server. ,
Required: False ,
}
string ,
}
,
directories:
{
Description: Gets or sets the list of directories. ,
Required: False ,
}
[
{
virtual:
{
Description: Gets or sets the virtual path for the directory. ,
Required: False ,
}
string ,
physical:
{
Description: Gets or sets the physical path of the directory on the web server. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
virtualApplications:
{
Description: Gets the list of application units for the web site. ,
Required: False ,
}
[
{
isVirtualDirectory:
{
Description: Gets a value indicating whether the application corresponds to a directory. ,
Required: False ,
}
boolean ,
path:
{
Description: Gets or sets the path of the directory. ,
Required: False ,
}
{
virtual:
{
Description: Gets or sets the virtual path for the directory. ,
Required: False ,
}
string ,
physical:
{
Description: Gets or sets the physical path of the directory on the web server. ,
Required: False ,
}
string ,
}
,
directories:
{
Description: Gets or sets the list of directories. ,
Required: False ,
}
[
{
virtual:
{
Description: Gets or sets the virtual path for the directory. ,
Required: False ,
}
string ,
physical:
{
Description: Gets or sets the physical path of the directory on the web server. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
webServerId:
{
Description: Gets the web server id. ,
Required: False ,
}
string ,
webServerName:
{
Description: Gets the web server name. ,
Required: False ,
}
string ,
machineArmIds:
{
Description: Gets the list of machine ARM Ids on which the SQL server is deployed. ,
Required: False ,
}
[
string ,
]
,
virtualPath:
{
Description: Gets the virtual path of the application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Gets the physical path of the application. ,
Required: False ,
}
string ,
bindings:
{
Description: Gets the front end bindings for the application. ,
Required: False ,
}
[
{
protocol:
{
Description: Gets or sets the Binding protocol. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets the Host name. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the Port number. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Gets or sets the IP Address. ,
Required: False ,
}
string ,
}
,
]
,
frameworks:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the framework. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the framework. ,
Required: False ,
}
string ,
}
,
]
,
configurations:
{
Description: Gets the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the configuration name. ,
Required: False ,
}
string ,
filePath:
{
Description: Gets or sets the configuration file path. ,
Required: False ,
}
string ,
localFilePath:
{
Description: Gets or sets the configuration local file path. ,
Required: False ,
}
string ,
targetFilePath:
{
Description: Gets or sets the configuration target file path. ,
Required: False ,
}
string ,
section:
{
Description: Gets or sets the configuration section in the file. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the configuration type. ,
Required: False ,
}
string ,
isDeploymentTimeEditable:
{
Description: Gets or sets a value indicating whether the configuration is edited or not by the user. ,
Required: False ,
}
boolean ,
identifier:
{
Description: Gets or sets the identifier for the configuration. ,
Required: False ,
}
string ,
}
,
]
,
directories:
{
Description: Gets the directories. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the unique id corresponding to the application directory. ,
Required: False ,
}
string ,
isEditable:
{
Description: Gets or sets a value indicating whether the directory object is editable. True when the directory is added as an optional directory, false when discovery is done manually. ,
Required: False ,
}
boolean ,
sourcePaths:
{
Description: Gets or sets the paths of the directory on the source machine. ,
Required: False ,
}
[
string ,
]
,
localScratchPath:
{
Description: Gets or sets the local scratch path at which the directories has been copied. ,
Required: False ,
}
string ,
mountPath:
{
Description: Gets or sets the mount path of the application directory. ,
Required: False ,
}
string ,
sourceSize:
{
Description: Gets or sets the size of the directory on the source machine. ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Gets the display name. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the resource. ,
Required: False ,
}
object ,
staticFolders:
{
Description: Static folders. ,
Required: False ,
}
[
string ,
]
,
machineDisplayName:
{
Description: Machine display name ,
Required: False ,
}
string ,
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
serverType:
{
Description: Gets the server type. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
hasErrors:
{
Description: Gets a value indicating whether the WebApp has errors or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
IisWebApplicationsController_Update (new)
Description :  Method to update tags on IIS web application.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebApplications/{webApplicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
webApplicationName:
{
Description: Web application name. ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The updatable properties of the IisWebApplications. ,
Required: False ,
}
{
tags:
{
Description: Gets or sets tags on the resource. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
applications:
{
Description: Gets the list of application units for the web site. ,
Required: False ,
}
[
{
applicationPoolName:
{
Description: Gets or sets the path of the directory. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Gets or sets the managed pipeline mode. ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Gets or sets the runtime version. ,
Required: False ,
}
string ,
enable32BitApiOnWin64:
{
Description: Gets or sets a value indicating whether 32 bit applications are allowed to run on 64 bit. ,
Required: False ,
}
boolean ,
path:
{
Description: Gets or sets the path of the directory. ,
Required: False ,
}
{
virtual:
{
Description: Gets or sets the virtual path for the directory. ,
Required: False ,
}
string ,
physical:
{
Description: Gets or sets the physical path of the directory on the web server. ,
Required: False ,
}
string ,
}
,
directories:
{
Description: Gets or sets the list of directories. ,
Required: False ,
}
[
{
virtual:
{
Description: Gets or sets the virtual path for the directory. ,
Required: False ,
}
string ,
physical:
{
Description: Gets or sets the physical path of the directory on the web server. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
virtualApplications:
{
Description: Gets the list of application units for the web site. ,
Required: False ,
}
[
{
isVirtualDirectory:
{
Description: Gets a value indicating whether the application corresponds to a directory. ,
Required: False ,
}
boolean ,
path:
{
Description: Gets or sets the path of the directory. ,
Required: False ,
}
{
virtual:
{
Description: Gets or sets the virtual path for the directory. ,
Required: False ,
}
string ,
physical:
{
Description: Gets or sets the physical path of the directory on the web server. ,
Required: False ,
}
string ,
}
,
directories:
{
Description: Gets or sets the list of directories. ,
Required: False ,
}
[
{
virtual:
{
Description: Gets or sets the virtual path for the directory. ,
Required: False ,
}
string ,
physical:
{
Description: Gets or sets the physical path of the directory on the web server. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
webServerId:
{
Description: Gets the web server id. ,
Required: False ,
}
string ,
webServerName:
{
Description: Gets the web server name. ,
Required: False ,
}
string ,
machineArmIds:
{
Description: Gets the list of machine ARM Ids on which the SQL server is deployed. ,
Required: False ,
}
[
string ,
]
,
virtualPath:
{
Description: Gets the virtual path of the application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Gets the physical path of the application. ,
Required: False ,
}
string ,
bindings:
{
Description: Gets the front end bindings for the application. ,
Required: False ,
}
[
{
protocol:
{
Description: Gets or sets the Binding protocol. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets the Host name. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the Port number. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Gets or sets the IP Address. ,
Required: False ,
}
string ,
}
,
]
,
frameworks:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the framework. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the framework. ,
Required: False ,
}
string ,
}
,
]
,
configurations:
{
Description: Gets the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the configuration name. ,
Required: False ,
}
string ,
filePath:
{
Description: Gets or sets the configuration file path. ,
Required: False ,
}
string ,
localFilePath:
{
Description: Gets or sets the configuration local file path. ,
Required: False ,
}
string ,
targetFilePath:
{
Description: Gets or sets the configuration target file path. ,
Required: False ,
}
string ,
section:
{
Description: Gets or sets the configuration section in the file. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the configuration type. ,
Required: False ,
}
string ,
isDeploymentTimeEditable:
{
Description: Gets or sets a value indicating whether the configuration is edited or not by the user. ,
Required: False ,
}
boolean ,
identifier:
{
Description: Gets or sets the identifier for the configuration. ,
Required: False ,
}
string ,
}
,
]
,
directories:
{
Description: Gets the directories. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the unique id corresponding to the application directory. ,
Required: False ,
}
string ,
isEditable:
{
Description: Gets or sets a value indicating whether the directory object is editable. True when the directory is added as an optional directory, false when discovery is done manually. ,
Required: False ,
}
boolean ,
sourcePaths:
{
Description: Gets or sets the paths of the directory on the source machine. ,
Required: False ,
}
[
string ,
]
,
localScratchPath:
{
Description: Gets or sets the local scratch path at which the directories has been copied. ,
Required: False ,
}
string ,
mountPath:
{
Description: Gets or sets the mount path of the application directory. ,
Required: False ,
}
string ,
sourceSize:
{
Description: Gets or sets the size of the directory on the source machine. ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Gets the display name. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the resource. ,
Required: False ,
}
object ,
staticFolders:
{
Description: Static folders. ,
Required: False ,
}
[
string ,
]
,
machineDisplayName:
{
Description: Machine display name ,
Required: False ,
}
string ,
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
serverType:
{
Description: Gets the server type. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
hasErrors:
{
Description: Gets a value indicating whether the WebApp has errors or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
IisWebServersController_ListByWebAppSite (new)
Description :  Method to get all IIS web servers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebServers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Required: False ,
}
string ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IisWebServers items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationLocation:
{
Description: Gets the configuration location. ,
Required: False ,
}
string ,
version:
{
Description: Gets the configuration location. ,
Required: False ,
}
string ,
machineIds:
{
Description: Gets the list of machines. ,
Required: False ,
}
[
string ,
]
,
webApplications:
{
Description: Gets the list of web applications. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Gets the display name. ,
Required: False ,
}
string ,
serverFqdn:
{
Description: Gets the server FQDN. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets the run as account id. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
serverType:
{
Description: Gets the server type. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
hasErrors:
{
Description: Gets a value indicating whether the WebApp has errors or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
IisWebServersController_Get (new)
Description :  Method to get an IIS web server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebServers/{webServerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
webServerName:
{
Description: Web server name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationLocation:
{
Description: Gets the configuration location. ,
Required: False ,
}
string ,
version:
{
Description: Gets the configuration location. ,
Required: False ,
}
string ,
machineIds:
{
Description: Gets the list of machines. ,
Required: False ,
}
[
string ,
]
,
webApplications:
{
Description: Gets the list of web applications. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Gets the display name. ,
Required: False ,
}
string ,
serverFqdn:
{
Description: Gets the server FQDN. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets the run as account id. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
serverType:
{
Description: Gets the server type. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
hasErrors:
{
Description: Gets a value indicating whether the WebApp has errors or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppSitesController_Refresh (new)
Description :  Method to refresh a site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/refresh
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
applianceName:
{
Description: Gets or sets the appliance name of the agent in the site. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppRunAsAccountsController_ListByWebAppSite (new)
Description :  Method to get all run as accounts.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/runasaccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WebAppRunAsAccount items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the run as account. ,
Required: False ,
}
string ,
credentialType:
{
Description: Gets the credential type of the run as account. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Timestamp marking run as account creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp marking last updated on the run as account. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the appliance name of the run as account. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppRunAsAccountsController_Get (new)
Description :  Method to get run as account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/runasaccounts/{accountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
accountName:
{
Description: Run as account ARM name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the run as account. ,
Required: False ,
}
string ,
credentialType:
{
Description: Gets the credential type of the run as account. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Timestamp marking run as account creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp marking last updated on the run as account. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the appliance name of the run as account. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppSitesController_Summary (new)
Description :  Method to get site usage/summary.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/summary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
webServerCount:
{
Description: Gets or sets the number of web servers discovered in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
webApplicationCount:
{
Description: Gets or sets the number of web applications discovered in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsAccountCount:
{
Description: Gets or sets the number of run as accounts in the site. ,
Format: int32 ,
Required: False ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
TomcatWebApplicationsController_ListByWebAppSite (new)
Description :  Method to get all Tomcat web application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebApplications
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Required: False ,
}
string ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The TomcatWebApplications items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hasDatabaseDependency:
{
Description: Boolean value having true if the application has database dependency. ,
Required: False ,
}
boolean ,
isExternalLoggingConfigured:
{
Description: Boolean value having true if the application has file dependency. ,
Required: False ,
}
boolean ,
webServerId:
{
Description: Gets the web server id. ,
Required: False ,
}
string ,
webServerName:
{
Description: Gets the web server name. ,
Required: False ,
}
string ,
machineArmIds:
{
Description: Gets the list of machine ARM Ids on which the web application is deployed. ,
Required: False ,
}
[
string ,
]
,
virtualPath:
{
Description: Gets the virtual path of the application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Gets the physical path of the application. ,
Required: False ,
}
string ,
bindings:
{
Description: Gets the front end bindings for the application. ,
Required: False ,
}
[
{
protocol:
{
Description: Gets or sets the Binding protocol. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets the Host name. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the Port number. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Gets or sets the IP Address. ,
Required: False ,
}
string ,
}
,
]
,
frameworks:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the framework. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the framework. ,
Required: False ,
}
string ,
}
,
]
,
configurations:
{
Description: Gets the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the configuration name. ,
Required: False ,
}
string ,
filePath:
{
Description: Gets or sets the configuration file path. ,
Required: False ,
}
string ,
localFilePath:
{
Description: Gets or sets the configuration local file path. ,
Required: False ,
}
string ,
targetFilePath:
{
Description: Gets or sets the configuration target file path. ,
Required: False ,
}
string ,
section:
{
Description: Gets or sets the configuration section in the file. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the configuration type. ,
Required: False ,
}
string ,
isDeploymentTimeEditable:
{
Description: Gets or sets a value indicating whether the configuration is edited or not by the user. ,
Required: False ,
}
boolean ,
identifier:
{
Description: Gets or sets the identifier for the configuration. ,
Required: False ,
}
string ,
}
,
]
,
directories:
{
Description: Gets the directories. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the unique id corresponding to the application directory. ,
Required: False ,
}
string ,
isEditable:
{
Description: Gets or sets a value indicating whether the directory object is editable. True when the directory is added as an optional directory, false when discovery is done manually. ,
Required: False ,
}
boolean ,
sourcePaths:
{
Description: Gets or sets the paths of the directory on the source machine. ,
Required: False ,
}
[
string ,
]
,
localScratchPath:
{
Description: Gets or sets the local scratch path at which the directories has been copied. ,
Required: False ,
}
string ,
mountPath:
{
Description: Gets or sets the mount path of the application directory. ,
Required: False ,
}
string ,
sourceSize:
{
Description: Gets or sets the size of the directory on the source machine. ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Gets the display name. ,
Required: False ,
}
string ,
tags:
{
Description: Gets tags that can be used with ODATA. ,
Required: False ,
}
object ,
staticFolders:
{
Description: Static folders. ,
Required: False ,
}
[
string ,
]
,
machineDisplayName:
{
Description: Machine display name ,
Required: False ,
}
string ,
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
serverType:
{
Description: Gets the server type. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
hasErrors:
{
Description: Gets a value indicating whether the WebApp has errors or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
TomcatWebApplicationsController_Get (new)
Description :  Method to get an Tomcat web application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebApplications/{webApplicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
webApplicationName:
{
Description: Web application name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hasDatabaseDependency:
{
Description: Boolean value having true if the application has database dependency. ,
Required: False ,
}
boolean ,
isExternalLoggingConfigured:
{
Description: Boolean value having true if the application has file dependency. ,
Required: False ,
}
boolean ,
webServerId:
{
Description: Gets the web server id. ,
Required: False ,
}
string ,
webServerName:
{
Description: Gets the web server name. ,
Required: False ,
}
string ,
machineArmIds:
{
Description: Gets the list of machine ARM Ids on which the web application is deployed. ,
Required: False ,
}
[
string ,
]
,
virtualPath:
{
Description: Gets the virtual path of the application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Gets the physical path of the application. ,
Required: False ,
}
string ,
bindings:
{
Description: Gets the front end bindings for the application. ,
Required: False ,
}
[
{
protocol:
{
Description: Gets or sets the Binding protocol. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets the Host name. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the Port number. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Gets or sets the IP Address. ,
Required: False ,
}
string ,
}
,
]
,
frameworks:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the framework. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the framework. ,
Required: False ,
}
string ,
}
,
]
,
configurations:
{
Description: Gets the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the configuration name. ,
Required: False ,
}
string ,
filePath:
{
Description: Gets or sets the configuration file path. ,
Required: False ,
}
string ,
localFilePath:
{
Description: Gets or sets the configuration local file path. ,
Required: False ,
}
string ,
targetFilePath:
{
Description: Gets or sets the configuration target file path. ,
Required: False ,
}
string ,
section:
{
Description: Gets or sets the configuration section in the file. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the configuration type. ,
Required: False ,
}
string ,
isDeploymentTimeEditable:
{
Description: Gets or sets a value indicating whether the configuration is edited or not by the user. ,
Required: False ,
}
boolean ,
identifier:
{
Description: Gets or sets the identifier for the configuration. ,
Required: False ,
}
string ,
}
,
]
,
directories:
{
Description: Gets the directories. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the unique id corresponding to the application directory. ,
Required: False ,
}
string ,
isEditable:
{
Description: Gets or sets a value indicating whether the directory object is editable. True when the directory is added as an optional directory, false when discovery is done manually. ,
Required: False ,
}
boolean ,
sourcePaths:
{
Description: Gets or sets the paths of the directory on the source machine. ,
Required: False ,
}
[
string ,
]
,
localScratchPath:
{
Description: Gets or sets the local scratch path at which the directories has been copied. ,
Required: False ,
}
string ,
mountPath:
{
Description: Gets or sets the mount path of the application directory. ,
Required: False ,
}
string ,
sourceSize:
{
Description: Gets or sets the size of the directory on the source machine. ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Gets the display name. ,
Required: False ,
}
string ,
tags:
{
Description: Gets tags that can be used with ODATA. ,
Required: False ,
}
object ,
staticFolders:
{
Description: Static folders. ,
Required: False ,
}
[
string ,
]
,
machineDisplayName:
{
Description: Machine display name ,
Required: False ,
}
string ,
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
serverType:
{
Description: Gets the server type. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
hasErrors:
{
Description: Gets a value indicating whether the WebApp has errors or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
TomcatWebApplicationsController_Update (new)
Description :  Updates the Tomcat web application tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebApplications/{webApplicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
webApplicationName:
{
Description: Web application name. ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hasDatabaseDependency:
{
Description: Boolean value having true if the application has database dependency. ,
Required: False ,
}
boolean ,
isExternalLoggingConfigured:
{
Description: Boolean value having true if the application has file dependency. ,
Required: False ,
}
boolean ,
webServerId:
{
Description: Gets the web server id. ,
Required: False ,
}
string ,
webServerName:
{
Description: Gets the web server name. ,
Required: False ,
}
string ,
machineArmIds:
{
Description: Gets the list of machine ARM Ids on which the web application is deployed. ,
Required: False ,
}
[
string ,
]
,
virtualPath:
{
Description: Gets the virtual path of the application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Gets the physical path of the application. ,
Required: False ,
}
string ,
bindings:
{
Description: Gets the front end bindings for the application. ,
Required: False ,
}
[
{
protocol:
{
Description: Gets or sets the Binding protocol. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets the Host name. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the Port number. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Gets or sets the IP Address. ,
Required: False ,
}
string ,
}
,
]
,
frameworks:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the framework. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the framework. ,
Required: False ,
}
string ,
}
,
]
,
configurations:
{
Description: Gets the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the configuration name. ,
Required: False ,
}
string ,
filePath:
{
Description: Gets or sets the configuration file path. ,
Required: False ,
}
string ,
localFilePath:
{
Description: Gets or sets the configuration local file path. ,
Required: False ,
}
string ,
targetFilePath:
{
Description: Gets or sets the configuration target file path. ,
Required: False ,
}
string ,
section:
{
Description: Gets or sets the configuration section in the file. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the configuration type. ,
Required: False ,
}
string ,
isDeploymentTimeEditable:
{
Description: Gets or sets a value indicating whether the configuration is edited or not by the user. ,
Required: False ,
}
boolean ,
identifier:
{
Description: Gets or sets the identifier for the configuration. ,
Required: False ,
}
string ,
}
,
]
,
directories:
{
Description: Gets the directories. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the unique id corresponding to the application directory. ,
Required: False ,
}
string ,
isEditable:
{
Description: Gets or sets a value indicating whether the directory object is editable. True when the directory is added as an optional directory, false when discovery is done manually. ,
Required: False ,
}
boolean ,
sourcePaths:
{
Description: Gets or sets the paths of the directory on the source machine. ,
Required: False ,
}
[
string ,
]
,
localScratchPath:
{
Description: Gets or sets the local scratch path at which the directories has been copied. ,
Required: False ,
}
string ,
mountPath:
{
Description: Gets or sets the mount path of the application directory. ,
Required: False ,
}
string ,
sourceSize:
{
Description: Gets or sets the size of the directory on the source machine. ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Gets the display name. ,
Required: False ,
}
string ,
tags:
{
Description: Gets tags that can be used with ODATA. ,
Required: False ,
}
object ,
staticFolders:
{
Description: Static folders. ,
Required: False ,
}
[
string ,
]
,
machineDisplayName:
{
Description: Machine display name ,
Required: False ,
}
string ,
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
serverType:
{
Description: Gets the server type. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
hasErrors:
{
Description: Gets a value indicating whether the WebApp has errors or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
TomcatWebServersController_ListByWebAppSite (new)
Description :  Method to get all Tomcat web servers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebServers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Required: False ,
}
string ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The TomcatWebServers items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
services:
{
Description: Gets or sets the services defined in the server. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the service. ,
Required: False ,
}
string ,
connectors:
{
Description: Gets or sets the connectors defined for the service component. ,
Required: False ,
}
[
{
bindings:
{
Description: Gets or sets the bindings for the connector. ,
Required: False ,
}
[
{
protocol:
{
Description: Gets or sets the Binding protocol. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets the Host name. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the Port number. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Gets or sets the IP Address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
engine:
{
Description: Gets or sets the engine defined for the service component. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the engine. ,
Required: False ,
}
string ,
hosts:
{
Description: Gets or sets the hosts defined for the engine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the host. ,
Required: False ,
}
string ,
appBasePath:
{
Description: Gets or sets the app base path for the host. ,
Required: False ,
}
string ,
appBase:
{
Description: Gets or sets the app base value configured for the host. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
catalinaHome:
{
Description: Catalina Home ,
Required: False ,
}
string ,
jvmVersion:
{
Description: Version of the JVM ,
Required: False ,
}
string ,
sessionPersistenceMechanism:
{
Description: session persistence mechanism ,
Required: False ,
}
string ,
isClusteringPresent:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
isMemoryRealmPresent:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
isSessionTrackingPresent:
{
Description: is session tracking present ,
Required: False ,
}
boolean ,
isAccessLogValvePresent:
{
Description: is access log valve present ,
Required: False ,
}
boolean ,
maxMemoryUsageInMb:
{
Description: max memory usage in mb ,
Required: False ,
}
string ,
configurationLocation:
{
Description: Gets the configuration location. ,
Required: False ,
}
string ,
version:
{
Description: Gets the configuration location. ,
Required: False ,
}
string ,
machineIds:
{
Description: Gets the list of machines. ,
Required: False ,
}
[
string ,
]
,
webApplications:
{
Description: Gets the list of web applications. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Gets the display name. ,
Required: False ,
}
string ,
serverFqdn:
{
Description: Gets the server FQDN. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets the run as account id. ,
Required: False ,
}
string ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
serverType:
{
Description: Gets the server type. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
hasErrors:
{
Description: Gets a value indicating whether the WebApp has errors or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
TomcatWebServersController_Get (new)
Description :  Method to get an Tomcat web server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebServers/{webServerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
webServerName:
{
Description: Web server name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
services:
{
Description: Gets or sets the services defined in the server. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the service. ,
Required: False ,
}
string ,
connectors:
{
Description: Gets or sets the connectors defined for the service component. ,
Required: False ,
}
[
{
bindings:
{
Description: Gets or sets the bindings for the connector. ,
Required: False ,
}
[
{
protocol:
{
Description: Gets or sets the Binding protocol. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets the Host name. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the Port number. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Gets or sets the IP Address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
engine:
{
Description: Gets or sets the engine defined for the service component. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the engine. ,
Required: False ,
}
string ,
hosts:
{
Description: Gets or sets the hosts defined for the engine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the host. ,
Required: False ,
}
string ,
appBasePath:
{
Description: Gets or sets the app base path for the host. ,
Required: False ,
}
string ,
appBase:
{
Description: Gets or sets the app base value configured for the host. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
catalinaHome:
{
Description: Catalina Home ,
Required: False ,
}
string ,
jvmVersion:
{
Description: Version of the JVM ,
Required: False ,
}
string ,
sessionPersistenceMechanism:
{
Description: session persistence mechanism ,
Required: False ,
}
string ,
isClusteringPresent:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
isMemoryRealmPresent:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
isSessionTrackingPresent:
{
Description: is session tracking present ,
Required: False ,
}
boolean ,
isAccessLogValvePresent:
{
Description: is access log valve present ,
Required: False ,
}
boolean ,
maxMemoryUsageInMb:
{
Description: max memory usage in mb ,
Required: False ,
}
string ,
configurationLocation:
{
Description: Gets the configuration location. ,
Required: False ,
}
string ,
version:
{
Description: Gets the configuration location. ,
Required: False ,
}
string ,
machineIds:
{
Description: Gets the list of machines. ,
Required: False ,
}
[
string ,
]
,
webApplications:
{
Description: Gets the list of web applications. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Gets the display name. ,
Required: False ,
}
string ,
serverFqdn:
{
Description: Gets the server FQDN. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets the run as account id. ,
Required: False ,
}
string ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
serverType:
{
Description: Gets the server type. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
hasErrors:
{
Description: Gets a value indicating whether the WebApp has errors or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebAppPropertiesController_UpdateProperties (new)
Description :  Method to update properties for web applications. in a site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/updateProperties
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
webApps:
{
Description: Gets or sets the list of web app properties. ,
Required: False ,
}
[
{
webAppArmId:
{
Description: Gets or sets the arm id of the web app. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets Tags. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebApplicationsController_ListByWebAppSite (new)
Description :  Method to get all IIS web applications.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/webApplications
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Required: False ,
}
string ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WebApplication items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
webServerId:
{
Description: Gets the web server id. ,
Required: False ,
}
string ,
webServerName:
{
Description: Gets the web server name. ,
Required: False ,
}
string ,
machineArmIds:
{
Description: Gets the list of machine ARM Ids on which the SQL server is deployed. ,
Required: False ,
}
[
string ,
]
,
virtualPath:
{
Description: Gets the virtual path of the application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Gets the physical path of the application. ,
Required: False ,
}
string ,
bindings:
{
Description: Gets the front end bindings for the application. ,
Required: False ,
}
[
{
protocol:
{
Description: Gets or sets the Binding protocol. ,
Required: False ,
}
string ,
hostName:
{
Description: Gets or sets the Host name. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the Port number. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Gets or sets the IP Address. ,
Required: False ,
}
string ,
}
,
]
,
frameworks:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the framework. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the framework. ,
Required: False ,
}
string ,
}
,
]
,
configurations:
{
Description: Gets the configuration. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the configuration name. ,
Required: False ,
}
string ,
filePath:
{
Description: Gets or sets the configuration file path. ,
Required: False ,
}
string ,
localFilePath:
{
Description: Gets or sets the configuration local file path. ,
Required: False ,
}
string ,
targetFilePath:
{
Description: Gets or sets the configuration target file path. ,
Required: False ,
}
string ,
section:
{
Description: Gets or sets the configuration section in the file. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the configuration type. ,
Required: False ,
}
string ,
isDeploymentTimeEditable:
{
Description: Gets or sets a value indicating whether the configuration is edited or not by the user. ,
Required: False ,
}
boolean ,
identifier:
{
Description: Gets or sets the identifier for the configuration. ,
Required: False ,
}
string ,
}
,
]
,
directories:
{
Description: Gets the directories. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the unique id corresponding to the application directory. ,
Required: False ,
}
string ,
isEditable:
{
Description: Gets or sets a value indicating whether the directory object is editable. True when the directory is added as an optional directory, false when discovery is done manually. ,
Required: False ,
}
boolean ,
sourcePaths:
{
Description: Gets or sets the paths of the directory on the source machine. ,
Required: False ,
}
[
string ,
]
,
localScratchPath:
{
Description: Gets or sets the local scratch path at which the directories has been copied. ,
Required: False ,
}
string ,
mountPath:
{
Description: Gets or sets the mount path of the application directory. ,
Required: False ,
}
string ,
sourceSize:
{
Description: Gets or sets the size of the directory on the source machine. ,
Required: False ,
}
string ,
}
,
]
,
displayName:
{
Description: Gets the display name. ,
Required: False ,
}
string ,
tags:
{
Description: Gets tags that can be used with ODATA. ,
Required: False ,
}
object ,
staticFolders:
{
Description: Static folders. ,
Required: False ,
}
[
string ,
]
,
machineDisplayName:
{
Description: Machine display name ,
Required: False ,
}
string ,
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
serverType:
{
Description: Gets the server type. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
hasErrors:
{
Description: Gets a value indicating whether the WebApp has errors or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
WebServersController_ListByWebAppSite (new)
Description :  Method to get all web servers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/webServers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Required: False ,
}
string ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
webAppSiteName:
{
Description: Web app site name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WebServer items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationLocation:
{
Description: Gets the configuration location. ,
Required: False ,
}
string ,
version:
{
Description: Gets the configuration location. ,
Required: False ,
}
string ,
machineIds:
{
Description: Gets the list of machines. ,
Required: False ,
}
[
string ,
]
,
webApplications:
{
Description: Gets the list of web applications. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Gets the display name. ,
Required: False ,
}
string ,
serverFqdn:
{
Description: Gets the server FQDN. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets the run as account id. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Gets a value indicating whether application is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the timestamp marking creation of the entity. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last update operation. ,
Required: False ,
}
string ,
serverType:
{
Description: Gets the server type. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the Error details. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
hasErrors:
{
Description: Gets a value indicating whether the WebApp has errors or not. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_ListByResourceGroup (new)
Description :  List ServerSiteResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ServerSiteResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_Get (new)
Description :  Get a ServerSiteResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_Create (new)
Description :  Create a ServerSiteResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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: A ServerSiteResource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_Update (new)
Description :  Update a ServerSiteResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The updatable properties of the ServerSiteResource. ,
Required: False ,
}
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_Delete (new)
Description :  Delete a ServerSiteResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerDependencyMapController_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/serverSites/{siteName}/clientGroupMembers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
machineId:
{
Description: id of machine ,
Required: False ,
}
string ,
processGroupName:
{
Description: process group name ,
Required: False ,
}
string ,
processName:
{
Description: name of process ,
Required: False ,
}
string ,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
filters:
{
Description: optional filters ,
Required: False ,
}
{
machineIds:
{
Description: array of machine ids ,
Required: False ,
}
[
string ,
]
,
processIds:
{
Description: array of process Ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_ComputeErrorSummary (new)
Description :  Get the error summary for a server site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/computeErrorSummary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
applianceName:
{
Description: Appliance Name. ,
Required: True ,
}
string ,
discoveryScopeErrorSummaries:
{
Description: Gets the error message. ,
Required: True ,
}
{
affectedResourceType:
{
Description: Gets or sets the affected resource type. ,
Required: True ,
}
string ,
affectedObjectsCount:
{
Description: Count of affected objects. ,
Format: int64 ,
Required: True ,
}
integer ,
discoveryScope:
{
Description: Gets or sets the count of affected objects. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
}
,
Required: True ,
}
enum ,
}
,
nextLink:
{
Description: The link to fetch more models. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_Computeusage (new)
Description :  Get a serve site usage.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/computeusage
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
runAsAccounts:
{
Description: Gets or sets the number of run as accounts in the site. ,
Format: int32 ,
Required: True ,
}
integer ,
serverCount:
{
Description: Gets or sets the number of servers part of the site. ,
Format: int32 ,
Required: True ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_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/serverSites/{siteName}/exportApplications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerDependencyMapController_ExportDependencies (new)
Description :  API to generate report containing agentless dependencies.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/exportDependencies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
requestBody:
{
Description: The content of the action request ,
Required: True ,
}
{
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_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/serverSites/{siteName}/exportMachineErrors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
discoveryScope:
{
Description: Gets or sets the discovery scope. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerDependencyMapController_GenerateCoarseMap (new)
Description :  API to generate coarse map for the list of machines.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/generateCoarseMap
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
filters:
{
Description: optional filters ,
Required: False ,
}
{
machineIds:
{
Description: array of machine ids ,
Required: False ,
}
[
string ,
]
,
processIds:
{
Description: array of process Ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerDependencyMapController_GenerateDetailedMap (new)
Description :  API to generate detailed map for a selected machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/generateDetailedMap
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
machineId:
{
Description: id of machine ,
Required: False ,
}
string ,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
filters:
{
Description: optional filters ,
Required: False ,
}
{
machineIds:
{
Description: array of machine ids ,
Required: False ,
}
[
string ,
]
,
processIds:
{
Description: array of process Ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerJobsController_ListByServerSiteResource (new)
Description :  List ServerJob resources by ServerSiteResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ServerJob items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
status:
{
Description: Gets operation status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets operation start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets operation end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the display name of the Job. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id used in the operation execution context. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id used in the operation execution context. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
isAgentReportedError:
{
Description: Gets a value indicating whether the error originated from a agent or not. ,
Required: False ,
}
boolean ,
agentErrorCode:
{
Description: Gets the agent error code. ,
Required: False ,
}
string ,
agentErrorMessage:
{
Description: Gets the error message from the agent. ,
Required: False ,
}
string ,
agentErrorPossibleCauses:
{
Description: Gets possible causes for the agent error. ,
Required: False ,
}
string ,
agentErrorRecommendedAction:
{
Description: Gets the recommended action for the agent error. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerJobsController_Get (new)
Description :  Get a ServerJob
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/jobs/{jobName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
jobName:
{
Description: Jobs name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
status:
{
Description: Gets operation status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets operation start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets operation end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the display name of the Job. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id used in the operation execution context. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id used in the operation execution context. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
isAgentReportedError:
{
Description: Gets a value indicating whether the error originated from a agent or not. ,
Required: False ,
}
boolean ,
agentErrorCode:
{
Description: Gets the agent error code. ,
Required: False ,
}
string ,
agentErrorMessage:
{
Description: Gets the error message from the agent. ,
Required: False ,
}
string ,
agentErrorPossibleCauses:
{
Description: Gets possible causes for the agent error. ,
Required: False ,
}
string ,
agentErrorRecommendedAction:
{
Description: Gets the recommended action for the agent error. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_ListHealthSummary (new)
Description :  Method to get site health summary.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/listHealthSummary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of SiteHealthSummary. ,
Required: True ,
}
[
{
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the summary message. ,
Required: False ,
}
string ,
errorId:
{
Description: Gets the error Id. ,
Format: int64 ,
Required: False ,
}
integer ,
errorCode:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
affectedObjectsCount:
{
Description: Gets or sets the count of affected objects. ,
Format: int64 ,
Required: False ,
}
integer ,
hitCount:
{
Description: Gets or sets the hit count of the error. ,
Format: int64 ,
Required: False ,
}
integer ,
severity:
{
Description: Gets the severity of error. ,
Required: False ,
}
string ,
remediationGuidance:
{
Description: Gets the remediation guidance. ,
Required: False ,
}
string ,
affectedResourceType:
{
Description: Gets the affected resource type. ,
Required: False ,
}
string ,
affectedResources:
{
Description: Gets or sets the affected resources. ,
Required: False ,
}
[
string ,
]
,
fabricLayoutUpdateSources:
{
Description: Gets or sets sources of the exception. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: Gets the value of next link. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServersController_ListByServerSiteResource (new)
Description :  Get all machines in a site.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Required: False ,
}
string ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Server items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Gets the Display name of the machine. For server entity hydrated FQDN is set as display name as the server id and server name are same. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the server. ,
Required: False ,
}
string ,
networkAdapters:
{
Description: Gets or sets the network adapters of the server. ,
Required: False ,
}
[
{
nicId:
{
Description: Gets or sets the NIC Id. ,
Required: False ,
}
string ,
macAddress:
{
Description: Gets or sets Mac address of the NIC. ,
Required: False ,
}
string ,
ipAddressList:
{
Description: Gets IP addresses for the machine. ,
Required: False ,
}
[
string ,
]
,
networkName:
{
Description: Gets or sets Network Name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: Gets or sets Type of the IP address. ,
Required: False ,
}
string ,
}
,
]
,
hydratedFqdn:
{
Description: Gets or sets the FQDN of machine which can be changed. ,
Required: False ,
}
string ,
disks:
{
Description: Gets or sets the disk details of server. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets Id of the disk. ,
Required: False ,
}
string ,
generatedId:
{
Description: Gets or sets generated Id of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: Gets or sets Bytes allocated for the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets Name of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: Gets or sets Type of the disk. ,
Required: False ,
}
string ,
lun:
{
Description: Gets or sets LUN of the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets Path of the disk. ,
Required: False ,
}
string ,
}
,
]
,
validationRequired:
{
Description: Gets or sets the validation required for the machine. ,
Required: False ,
}
string ,
processorInfo:
{
Description: Processor Info of the Server machine. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name\model of a processor. ,
Required: False ,
}
string ,
numberOfSockets:
{
Description: Gets or sets the number of sockets. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfCoresPerSocket:
{
Description: Gets or sets the total number of cores in a socket. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
firmware:
{
Description: Gets or sets the firmware. ,
Required: False ,
}
string ,
guestOsDetails:
{
Description: Operating System Details extracted from the guest bu executing script inside the guest VM. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
numberOfApplications:
{
Description: Number of applications installed in the guest VM. ,
Format: int32 ,
Required: False ,
}
integer ,
guestDetailsDiscoveryTimestamp:
{
Description: The last time at which the Guest Details was discovered or the error while discovering guest details based discovery of the machine. ,
Format: date-time ,
Required: False ,
}
string ,
isGuestDetailsDiscoveryInProgress:
{
Description: Whether Refresh Fabric Layout Guest Details has been completed once. Portal will show discovery in progress, if this value is true. ,
Required: False ,
}
boolean ,
dependencyMapping:
{
Description: Gets or sets if dependency mapping feature is enabled or not for the VM. ,
Required: False ,
}
string ,
dependencyMappingStartTime:
{
Description: Gets or sets when dependency mapping collection is last started. ,
Format: date-time ,
Required: False ,
}
string ,
dependencyMappingEndTime:
{
Description: Gets or sets when dependency mapping collection was last disabled. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the machine. ,
Required: False ,
}
string ,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Errors for machine. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationDiscovery:
{
Description: Gets the data related to application discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
dependencyMapDiscovery:
{
Description: Gets the data related to dependency map discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
staticDiscovery:
{
Description: Gets the data related to static discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
sqlDiscovery:
{
Description: Gets the data related to SQL discovery. ,
Required: False ,
}
{
successfullyDiscoveredServerCount:
{
Description: successfully Discovered ServerCount ,
Format: int32 ,
Required: False ,
}
integer ,
totalServerCount:
{
Description: total Server Count ,
Format: int32 ,
Required: False ,
}
integer ,
sqlMetadataHydratedRunAsAccountId:
{
Description: sql Metadata Hydrated RunAsAccountId ,
Required: False ,
}
string ,
sqlMetadataDiscoveryPipe:
{
Description: sql Metadata DiscoveryPipe ,
Enum:
{
Unknown: Unknown value. ,
VMware: VMware value. ,
PowerShell: PowerShell value. ,
SSH: SSH value. ,
CIM: CIM value. ,
Other: Other value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: discovery Scope Status ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
webAppDiscovery:
{
Description: Gets the data related to Web application discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
oracleDiscovery:
{
Description: Gets the data related to Oracle discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalDatabaseCount:
{
Description: Gets or sets number of successfully discovered databases. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
springBootDiscovery:
{
Description: Gets the data related to SpringBoot discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplicationCount:
{
Description: Gets or sets number of successfully discovered applications. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
iisDiscovery:
{
Description: Gets the data related to iis discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
tomcatDiscovery:
{
Description: Gets the data related to tomcat discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
appsAndRoles:
{
Description: Apps And Roles of the Server. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: float ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Value indicating whether VM is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the marking machine creation. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the Server machine. ,
Required: False ,
}
object ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the server resource. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
arcDiscovery:
{
Description: Gets the data related to Azure arc discovery. ,
Required: False ,
}
{
status:
{
Description: AzureArc status indicates whether arc discovery has successfully completed or not. ,
Enum:
{
Unknown: Unknown value. ,
NotEnabled: Not enabled value. ,
Enabled: Enabled value. ,
}
,
Required: True ,
}
enum ,
machineResourceId:
{
Description: Machine Resource Id. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServersController_GetMachine (new)
Description :  Get a Server
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: A server machine name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Gets the Display name of the machine. For server entity hydrated FQDN is set as display name as the server id and server name are same. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the server. ,
Required: False ,
}
string ,
networkAdapters:
{
Description: Gets or sets the network adapters of the server. ,
Required: False ,
}
[
{
nicId:
{
Description: Gets or sets the NIC Id. ,
Required: False ,
}
string ,
macAddress:
{
Description: Gets or sets Mac address of the NIC. ,
Required: False ,
}
string ,
ipAddressList:
{
Description: Gets IP addresses for the machine. ,
Required: False ,
}
[
string ,
]
,
networkName:
{
Description: Gets or sets Network Name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: Gets or sets Type of the IP address. ,
Required: False ,
}
string ,
}
,
]
,
hydratedFqdn:
{
Description: Gets or sets the FQDN of machine which can be changed. ,
Required: False ,
}
string ,
disks:
{
Description: Gets or sets the disk details of server. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets Id of the disk. ,
Required: False ,
}
string ,
generatedId:
{
Description: Gets or sets generated Id of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: Gets or sets Bytes allocated for the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets Name of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: Gets or sets Type of the disk. ,
Required: False ,
}
string ,
lun:
{
Description: Gets or sets LUN of the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets Path of the disk. ,
Required: False ,
}
string ,
}
,
]
,
validationRequired:
{
Description: Gets or sets the validation required for the machine. ,
Required: False ,
}
string ,
processorInfo:
{
Description: Processor Info of the Server machine. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name\model of a processor. ,
Required: False ,
}
string ,
numberOfSockets:
{
Description: Gets or sets the number of sockets. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfCoresPerSocket:
{
Description: Gets or sets the total number of cores in a socket. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
firmware:
{
Description: Gets or sets the firmware. ,
Required: False ,
}
string ,
guestOsDetails:
{
Description: Operating System Details extracted from the guest bu executing script inside the guest VM. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
numberOfApplications:
{
Description: Number of applications installed in the guest VM. ,
Format: int32 ,
Required: False ,
}
integer ,
guestDetailsDiscoveryTimestamp:
{
Description: The last time at which the Guest Details was discovered or the error while discovering guest details based discovery of the machine. ,
Format: date-time ,
Required: False ,
}
string ,
isGuestDetailsDiscoveryInProgress:
{
Description: Whether Refresh Fabric Layout Guest Details has been completed once. Portal will show discovery in progress, if this value is true. ,
Required: False ,
}
boolean ,
dependencyMapping:
{
Description: Gets or sets if dependency mapping feature is enabled or not for the VM. ,
Required: False ,
}
string ,
dependencyMappingStartTime:
{
Description: Gets or sets when dependency mapping collection is last started. ,
Format: date-time ,
Required: False ,
}
string ,
dependencyMappingEndTime:
{
Description: Gets or sets when dependency mapping collection was last disabled. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the machine. ,
Required: False ,
}
string ,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Errors for machine. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationDiscovery:
{
Description: Gets the data related to application discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
dependencyMapDiscovery:
{
Description: Gets the data related to dependency map discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
staticDiscovery:
{
Description: Gets the data related to static discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
sqlDiscovery:
{
Description: Gets the data related to SQL discovery. ,
Required: False ,
}
{
successfullyDiscoveredServerCount:
{
Description: successfully Discovered ServerCount ,
Format: int32 ,
Required: False ,
}
integer ,
totalServerCount:
{
Description: total Server Count ,
Format: int32 ,
Required: False ,
}
integer ,
sqlMetadataHydratedRunAsAccountId:
{
Description: sql Metadata Hydrated RunAsAccountId ,
Required: False ,
}
string ,
sqlMetadataDiscoveryPipe:
{
Description: sql Metadata DiscoveryPipe ,
Enum:
{
Unknown: Unknown value. ,
VMware: VMware value. ,
PowerShell: PowerShell value. ,
SSH: SSH value. ,
CIM: CIM value. ,
Other: Other value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: discovery Scope Status ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
webAppDiscovery:
{
Description: Gets the data related to Web application discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
oracleDiscovery:
{
Description: Gets the data related to Oracle discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalDatabaseCount:
{
Description: Gets or sets number of successfully discovered databases. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
springBootDiscovery:
{
Description: Gets the data related to SpringBoot discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplicationCount:
{
Description: Gets or sets number of successfully discovered applications. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
iisDiscovery:
{
Description: Gets the data related to iis discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
tomcatDiscovery:
{
Description: Gets the data related to tomcat discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
appsAndRoles:
{
Description: Apps And Roles of the Server. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: float ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Value indicating whether VM is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the marking machine creation. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the Server machine. ,
Required: False ,
}
object ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the server resource. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
arcDiscovery:
{
Description: Gets the data related to Azure arc discovery. ,
Required: False ,
}
{
status:
{
Description: AzureArc status indicates whether arc discovery has successfully completed or not. ,
Enum:
{
Unknown: Unknown value. ,
NotEnabled: Not enabled value. ,
Enabled: Enabled value. ,
}
,
Required: True ,
}
enum ,
machineResourceId:
{
Description: Machine Resource Id. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServersController_UpdateMachine (new)
Description :  Update a Server machine
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: A server machine name ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The updatable properties of the Server. ,
Required: False ,
}
{
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the server. ,
Required: False ,
}
string ,
networkAdapters:
{
Description: Gets or sets the network adapters of the server. ,
Required: False ,
}
[
{
nicId:
{
Description: Gets or sets the NIC Id. ,
Required: False ,
}
string ,
macAddress:
{
Description: Gets or sets Mac address of the NIC. ,
Required: False ,
}
string ,
ipAddressList:
{
Description: Gets IP addresses for the machine. ,
Required: False ,
}
[
string ,
]
,
networkName:
{
Description: Gets or sets Network Name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: Gets or sets Type of the IP address. ,
Required: False ,
}
string ,
}
,
]
,
hydratedFqdn:
{
Description: Gets or sets the FQDN of machine which can be changed. ,
Required: False ,
}
string ,
disks:
{
Description: Gets or sets the disk details of server. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets Id of the disk. ,
Required: False ,
}
string ,
generatedId:
{
Description: Gets or sets generated Id of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: Gets or sets Bytes allocated for the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets Name of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: Gets or sets Type of the disk. ,
Required: False ,
}
string ,
lun:
{
Description: Gets or sets LUN of the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets Path of the disk. ,
Required: False ,
}
string ,
}
,
]
,
validationRequired:
{
Description: Gets or sets the validation required for the machine. ,
Required: False ,
}
string ,
firmware:
{
Description: Gets or sets the firmware. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the machine. ,
Required: False ,
}
string ,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: float ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the Server machine. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state of the server resource. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Gets the Display name of the machine. For server entity hydrated FQDN is set as display name as the server id and server name are same. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the server. ,
Required: False ,
}
string ,
networkAdapters:
{
Description: Gets or sets the network adapters of the server. ,
Required: False ,
}
[
{
nicId:
{
Description: Gets or sets the NIC Id. ,
Required: False ,
}
string ,
macAddress:
{
Description: Gets or sets Mac address of the NIC. ,
Required: False ,
}
string ,
ipAddressList:
{
Description: Gets IP addresses for the machine. ,
Required: False ,
}
[
string ,
]
,
networkName:
{
Description: Gets or sets Network Name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: Gets or sets Type of the IP address. ,
Required: False ,
}
string ,
}
,
]
,
hydratedFqdn:
{
Description: Gets or sets the FQDN of machine which can be changed. ,
Required: False ,
}
string ,
disks:
{
Description: Gets or sets the disk details of server. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets Id of the disk. ,
Required: False ,
}
string ,
generatedId:
{
Description: Gets or sets generated Id of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: Gets or sets Bytes allocated for the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets Name of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: Gets or sets Type of the disk. ,
Required: False ,
}
string ,
lun:
{
Description: Gets or sets LUN of the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets Path of the disk. ,
Required: False ,
}
string ,
}
,
]
,
validationRequired:
{
Description: Gets or sets the validation required for the machine. ,
Required: False ,
}
string ,
processorInfo:
{
Description: Processor Info of the Server machine. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name\model of a processor. ,
Required: False ,
}
string ,
numberOfSockets:
{
Description: Gets or sets the number of sockets. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfCoresPerSocket:
{
Description: Gets or sets the total number of cores in a socket. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
firmware:
{
Description: Gets or sets the firmware. ,
Required: False ,
}
string ,
guestOsDetails:
{
Description: Operating System Details extracted from the guest bu executing script inside the guest VM. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
numberOfApplications:
{
Description: Number of applications installed in the guest VM. ,
Format: int32 ,
Required: False ,
}
integer ,
guestDetailsDiscoveryTimestamp:
{
Description: The last time at which the Guest Details was discovered or the error while discovering guest details based discovery of the machine. ,
Format: date-time ,
Required: False ,
}
string ,
isGuestDetailsDiscoveryInProgress:
{
Description: Whether Refresh Fabric Layout Guest Details has been completed once. Portal will show discovery in progress, if this value is true. ,
Required: False ,
}
boolean ,
dependencyMapping:
{
Description: Gets or sets if dependency mapping feature is enabled or not for the VM. ,
Required: False ,
}
string ,
dependencyMappingStartTime:
{
Description: Gets or sets when dependency mapping collection is last started. ,
Format: date-time ,
Required: False ,
}
string ,
dependencyMappingEndTime:
{
Description: Gets or sets when dependency mapping collection was last disabled. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the machine. ,
Required: False ,
}
string ,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Errors for machine. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationDiscovery:
{
Description: Gets the data related to application discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
dependencyMapDiscovery:
{
Description: Gets the data related to dependency map discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
staticDiscovery:
{
Description: Gets the data related to static discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
sqlDiscovery:
{
Description: Gets the data related to SQL discovery. ,
Required: False ,
}
{
successfullyDiscoveredServerCount:
{
Description: successfully Discovered ServerCount ,
Format: int32 ,
Required: False ,
}
integer ,
totalServerCount:
{
Description: total Server Count ,
Format: int32 ,
Required: False ,
}
integer ,
sqlMetadataHydratedRunAsAccountId:
{
Description: sql Metadata Hydrated RunAsAccountId ,
Required: False ,
}
string ,
sqlMetadataDiscoveryPipe:
{
Description: sql Metadata DiscoveryPipe ,
Enum:
{
Unknown: Unknown value. ,
VMware: VMware value. ,
PowerShell: PowerShell value. ,
SSH: SSH value. ,
CIM: CIM value. ,
Other: Other value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: discovery Scope Status ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
webAppDiscovery:
{
Description: Gets the data related to Web application discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
oracleDiscovery:
{
Description: Gets the data related to Oracle discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalDatabaseCount:
{
Description: Gets or sets number of successfully discovered databases. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
springBootDiscovery:
{
Description: Gets the data related to SpringBoot discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplicationCount:
{
Description: Gets or sets number of successfully discovered applications. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
iisDiscovery:
{
Description: Gets the data related to iis discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
tomcatDiscovery:
{
Description: Gets the data related to tomcat discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
appsAndRoles:
{
Description: Apps And Roles of the Server. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: float ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Value indicating whether VM is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the marking machine creation. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the Server machine. ,
Required: False ,
}
object ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the server resource. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
arcDiscovery:
{
Description: Gets the data related to Azure arc discovery. ,
Required: False ,
}
{
status:
{
Description: AzureArc status indicates whether arc discovery has successfully completed or not. ,
Enum:
{
Unknown: Unknown value. ,
NotEnabled: Not enabled value. ,
Enabled: Enabled value. ,
}
,
Required: True ,
}
enum ,
machineResourceId:
{
Description: Machine Resource Id. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServersController_DeleteMachine (new)
Description :  Delete a Server
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: A server machine name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSoftwareInventoriesController_GetMachineSoftwareInventory (new)
Description :  Method to get a machines software inventory like applications and roles.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}/softwareInventories/{default}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: A server machine name ,
Required: True ,
}
string ,
default:
{
Description: Default value. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
appsAndRoles:
{
Description: Apps And Roles of the machine entity. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSoftwareInventoriesController_ListByServer (new)
Description :  List ServerSoftwareInventory resources by Server
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}/softwareinventories
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: A server machine name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ServerSoftwareInventory items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
appsAndRoles:
{
Description: Apps And Roles of the machine entity. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerOperationsStatusController_GetServerSiteOperationsStatus (new)
Description :  A operation status resource belonging to a site resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/operationsStatus/{operationStatusName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
operationStatusName:
{
Description: Operation status Arm Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the start time. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Operation status properties ,
Required: False ,
}
{
result:
{
Description: Gets or sets the result or output of the workflow. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_RefreshSite (new)
Description :  Operation to refresh a site
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/refreshSite
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerRunAsAccountsController_ListByServerSiteResource (new)
Description :  List ServerRunAsAccount resources by ServerSiteResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/runAsAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ServerRunAsAccount items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the run as account. ,
Required: False ,
}
string ,
credentialType:
{
Description: Gets the credential type of the run as account. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Timestamp marking run as account creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp marking last updated on the run as account. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the appliance name of the run as account. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerRunAsAccountsController_Get (new)
Description :  Get a ServerRunAsAccount
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/runAsAccounts/{accountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
accountName:
{
Description: RunAsAccounts name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the run as account. ,
Required: False ,
}
string ,
credentialType:
{
Description: Gets the credential type of the run as account. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Timestamp marking run as account creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp marking last updated on the run as account. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the appliance name of the run as account. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerDependencyMapController_ServerGroupMembers (new)
Description :  API to list server group members for the selected server group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/serverGroupMembers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
serverPort:
{
Description: port of server ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
filters:
{
Description: optional filters ,
Required: False ,
}
{
machineIds:
{
Description: array of machine ids ,
Required: False ,
}
[
string ,
]
,
processIds:
{
Description: array of process Ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_Summary (new)
Description :  Method to get site usage.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/summary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
runAsAccountCount:
{
Description: Gets or sets the number of run as accounts in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
serverCount:
{
Description: Gets or sets the number of servers part of the site. ,
Format: int32 ,
Required: False ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_UpdateDependencyMapStatus (new)
Description :  Method to enable disable dependency map status for machines in a site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/updateDependencyMapStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
machines:
{
Description: Gets or sets the machine collection. ,
Required: False ,
}
[
{
machineId:
{
Description: Gets or sets the ARM id of the machine. ,
Required: False ,
}
string ,
isDependencyMapToBeEnabled:
{
Description: Gets or sets a value indicating whether dependency mapping is to be enabled or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
ServerSitesController_UpdateProperties (new)
Description :  Operation to update custom properties for servers
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/updateProperties
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
metaData:
{
Description: The content of the action request ,
Required: True ,
}
{
value:
{
Description: The list of Machine MetaData. ,
Required: True ,
}
[
{
machineArmId:
{
Description: arm id of the machine. ,
Required: True ,
}
string ,
dependencyMapping:
{
Description: value representing state of dependency mapping (enabled/disabled). ,
Required: True ,
}
string ,
tags:
{
Description: machine tags ,
Required: True ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_ListByResourceGroup (new)
Description :  Get all the vmware sites in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VmwareSite items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_Get (new)
Description :  Get a VmwareSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_Create (new)
Description :  Create a VmwareSite
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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: A VmwareSite ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_Update (new)
Description :  Update a VmwareSite
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The updatable properties of the VmwareSite. ,
Required: False ,
}
{
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
masterSiteId:
{
Description: Gets the Master Site this site is linked to. ,
Required: False ,
}
string ,
servicePrincipalIdentityDetails:
{
Description: Gets or sets the service principal identity details used by agent for communication to the service. ,
Required: False ,
}
{
tenantId:
{
Description: Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
applicationId:
{
Description: Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
objectId:
{
Description: Gets or sets the object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. ,
Required: False ,
}
string ,
audience:
{
Description: Gets or sets the intended audience for the service principal. ,
Required: False ,
}
string ,
aadAuthority:
{
Description: Gets or sets the AAD Authority URL which was used to request the token for the service principal. ,
Required: False ,
}
string ,
rawCertData:
{
Description: Gets or sets the raw certificate data for building certificate expiry flows. ,
Required: False ,
}
string ,
}
,
agentDetails:
{
Description: Gets or sets the on-premises agent details. ,
Required: False ,
}
{
id:
{
Description: Gets the ID of the agent. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the agent. ,
Required: False ,
}
string ,
lastHeartBeatUtc:
{
Description: Gets the last heartbeat time of the agent in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Gets or sets the key vault URI. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: Gets or sets the key vault ARM Id. ,
Required: False ,
}
string ,
}
,
applianceName:
{
Description: Gets or sets the Appliance Name. ,
Required: False ,
}
string ,
discoverySolutionId:
{
Description: Gets or sets the ARM ID of migration hub solution for SDS. ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Gets the service endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_Delete (new)
Description :  Delete a VmwareSite
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
DependencyMapController_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/vmwareSites/{siteName}/clientGroupMembers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
machineId:
{
Description: id of machine ,
Required: False ,
}
string ,
processGroupName:
{
Description: process group name ,
Required: False ,
}
string ,
processName:
{
Description: name of process ,
Required: False ,
}
string ,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
filters:
{
Description: optional filters ,
Required: False ,
}
{
machineIds:
{
Description: array of machine ids ,
Required: False ,
}
[
string ,
]
,
processIds:
{
Description: array of process Ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_ComputeErrorSummary (new)
Description :  Method to get site error summary.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/computeErrorSummary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
applianceName:
{
Description: Appliance Name. ,
Required: True ,
}
string ,
discoveryScopeErrorSummaries:
{
Description: Gets the error message. ,
Required: True ,
}
{
affectedResourceType:
{
Description: Gets or sets the affected resource type. ,
Required: True ,
}
string ,
affectedObjectsCount:
{
Description: Count of affected objects. ,
Format: int64 ,
Required: True ,
}
integer ,
discoveryScope:
{
Description: Gets or sets the count of affected objects. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
}
,
Required: True ,
}
enum ,
}
,
nextLink:
{
Description: The link to fetch more models. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_Computeusage (new)
Description :  Method to get site error summary.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/computeusage
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
machineCount:
{
Description: Gets or sets the number of machines discovered in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsAccountCount:
{
Description: Gets or sets the number of run as accounts in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
vCenterCount:
{
Description: Gets or sets the number of vCenters part of the site. ,
Format: int32 ,
Required: False ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_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/vmwareSites/{siteName}/exportApplications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
DependencyMapController_ExportDependencies (new)
Description :  API to generate report containing agentless dependencies.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportDependencies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
requestBody:
{
Description: The content of the action request ,
Required: True ,
}
{
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_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/vmwareSites/{siteName}/exportMachineErrors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
discoveryScope:
{
Description: Gets or sets the discovery scope. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_ExportMachines (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/vmwareSites/{siteName}/exportMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
filter:
{
Description: filter options. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
DependencyMapController_GenerateCoarseMap (new)
Description :  API to generate coarse map for the list of machines.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/generateCoarseMap
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
filters:
{
Description: optional filters ,
Required: False ,
}
{
machineIds:
{
Description: array of machine ids ,
Required: False ,
}
[
string ,
]
,
processIds:
{
Description: array of process Ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
DependencyMapController_GenerateDetailedMap (new)
Description :  API to generate detailed map for a selected machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/generateDetailedMap
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
machineId:
{
Description: id of machine ,
Required: False ,
}
string ,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
filters:
{
Description: optional filters ,
Required: False ,
}
{
machineIds:
{
Description: array of machine ids ,
Required: False ,
}
[
string ,
]
,
processIds:
{
Description: array of process Ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VmwareHostController_ListByVmwareSite (new)
Description :  List VmwareHost resources by VmwareSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/hosts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VmwareHost items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Gets the timestamp marking VMware host creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the VMware host. ,
Required: False ,
}
string ,
datastores:
{
Description: Gets the data stores. ,
Required: False ,
}
[
{
uuid:
{
Description: Data store UUID. ,
Required: False ,
}
string ,
capacityInGb:
{
Description: Capacity of the data store. ,
Format: float ,
Required: False ,
}
number ,
freeSpaceInGb:
{
Description: Free space of the data store. ,
Format: float ,
Required: False ,
}
number ,
type:
{
Description: Type of the data store. ,
Enum:
{
Unknown: Unknown value. ,
CIFS: CIFS value. ,
NFS: NFS value. ,
NFS41: NFS41 value. ,
PMEM: PMEM value. ,
VFFS: VFFS value. ,
VMFS: VMFS value. ,
VSAN: VSAN value. ,
VVOL: VVOL value. ,
}
,
Required: False ,
}
enum ,
symbolicName:
{
Description: Symbolic name of the data store. ,
Required: False ,
}
string ,
}
,
]
,
vcenterId:
{
Description: Gets the V-center ID. ,
Required: False ,
}
string ,
uuid:
{
Description: Gets the instance UUID of the vmware host. ,
Required: False ,
}
string ,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VmwareHostController_Get (new)
Description :  Get a VmwareHost
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/hosts/{hostName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
hostName:
{
Description: Hosts name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createdTimestamp:
{
Description: Gets the timestamp marking VMware host creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the VMware host. ,
Required: False ,
}
string ,
datastores:
{
Description: Gets the data stores. ,
Required: False ,
}
[
{
uuid:
{
Description: Data store UUID. ,
Required: False ,
}
string ,
capacityInGb:
{
Description: Capacity of the data store. ,
Format: float ,
Required: False ,
}
number ,
freeSpaceInGb:
{
Description: Free space of the data store. ,
Format: float ,
Required: False ,
}
number ,
type:
{
Description: Type of the data store. ,
Enum:
{
Unknown: Unknown value. ,
CIFS: CIFS value. ,
NFS: NFS value. ,
NFS41: NFS41 value. ,
PMEM: PMEM value. ,
VFFS: VFFS value. ,
VMFS: VMFS value. ,
VSAN: VSAN value. ,
VVOL: VVOL value. ,
}
,
Required: False ,
}
enum ,
symbolicName:
{
Description: Symbolic name of the data store. ,
Required: False ,
}
string ,
}
,
]
,
vcenterId:
{
Description: Gets the V-center ID. ,
Required: False ,
}
string ,
uuid:
{
Description: Gets the instance UUID of the vmware host. ,
Required: False ,
}
string ,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervJobsController_ListByVmwareSite (new)
Description :  List VmwareJob resources by VmwareSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VmwareJob items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
status:
{
Description: Gets operation status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets operation start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets operation end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the display name of the Job. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id used in the operation execution context. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id used in the operation execution context. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
isAgentReportedError:
{
Description: Gets a value indicating whether the error originated from a agent or not. ,
Required: False ,
}
boolean ,
agentErrorCode:
{
Description: Gets the agent error code. ,
Required: False ,
}
string ,
agentErrorMessage:
{
Description: Gets the error message from the agent. ,
Required: False ,
}
string ,
agentErrorPossibleCauses:
{
Description: Gets possible causes for the agent error. ,
Required: False ,
}
string ,
agentErrorRecommendedAction:
{
Description: Gets the recommended action for the agent error. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
HypervJobsController_Get (new)
Description :  Get a VmwareJob
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/jobs/{jobName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
jobName:
{
Description: Jobs name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
status:
{
Description: Gets operation status. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets operation start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets operation end time. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the display name of the Job. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id used in the operation execution context. ,
Required: False ,
}
string ,
activityId:
{
Description: Gets the activity Id used in the operation execution context. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
isAgentReportedError:
{
Description: Gets a value indicating whether the error originated from a agent or not. ,
Required: False ,
}
boolean ,
agentErrorCode:
{
Description: Gets the agent error code. ,
Required: False ,
}
string ,
agentErrorMessage:
{
Description: Gets the error message from the agent. ,
Required: False ,
}
string ,
agentErrorPossibleCauses:
{
Description: Gets possible causes for the agent error. ,
Required: False ,
}
string ,
agentErrorRecommendedAction:
{
Description: Gets the recommended action for the agent error. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_ListHealthSummary (new)
Description :  Method to get site health summary.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/listHealthSummary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of SiteHealthSummary. ,
Required: True ,
}
[
{
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the summary message. ,
Required: False ,
}
string ,
errorId:
{
Description: Gets the error Id. ,
Format: int64 ,
Required: False ,
}
integer ,
errorCode:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
affectedObjectsCount:
{
Description: Gets or sets the count of affected objects. ,
Format: int64 ,
Required: False ,
}
integer ,
hitCount:
{
Description: Gets or sets the hit count of the error. ,
Format: int64 ,
Required: False ,
}
integer ,
severity:
{
Description: Gets the severity of error. ,
Required: False ,
}
string ,
remediationGuidance:
{
Description: Gets the remediation guidance. ,
Required: False ,
}
string ,
affectedResourceType:
{
Description: Gets the affected resource type. ,
Required: False ,
}
string ,
affectedResources:
{
Description: Gets or sets the affected resources. ,
Required: False ,
}
[
string ,
]
,
fabricLayoutUpdateSources:
{
Description: Gets or sets sources of the exception. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: Gets the value of next link. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MachinesController_ListByVmwareSite (new)
Description :  List MachineResource resources by VmwareSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
top:
{
Description: page size query ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: Optional parameter for continuation token. ,
Required: False ,
}
string ,
totalRecordCount:
{
Description: Total count of machines in the given site. ,
Format: int32 ,
Required: False ,
}
integer ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MachineResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
vCenterFqdn:
{
Description: VCenter FQDN/IPAddress. ,
Required: False ,
}
string ,
vCenterId:
{
Description: VCenter ARM ID. ,
Required: False ,
}
string ,
instanceUuid:
{
Description: On-premise Instance UUID of the machine. ,
Required: False ,
}
string ,
dataCenterScope:
{
Description: Scope of the data center. ,
Required: False ,
}
string ,
description:
{
Description: User description of the machine. ,
Required: False ,
}
string ,
disks:
{
Description: Disks attached to the machine. ,
Required: False ,
}
[
{
uuid:
{
Description: Disk UUID. ,
Required: False ,
}
string ,
label:
{
Description: Label of the disk. ,
Required: False ,
}
string ,
diskProvisioningPolicy:
{
Description: The provisioning policy of the disk. It is Thin or Thick or Unknown for the VMWare VMDK. ,
Required: False ,
}
string ,
diskScrubbingPolicy:
{
Description: The scrubbing policy of disks which can be eagerly zeroed or lazily zeroed. ,
Required: False ,
}
string ,
diskMode:
{
Description: Disk mode property used for identifying independent disks. ,
Required: False ,
}
string ,
controllerType:
{
Description: Gets or sets a value indicating the type of the disk controller type. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: Gets or sets Bytes allocated for the disk. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets Name of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: Gets or sets Type of the disk. ,
Required: False ,
}
string ,
lun:
{
Description: Gets or sets LUN of the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets Path of the disk. ,
Required: False ,
}
string ,
}
,
]
,
hostInMaintenanceMode:
{
Description: Indicates whether the host is in maintenance mode. ,
Required: False ,
}
boolean ,
hostName:
{
Description: The host name. ,
Required: False ,
}
string ,
hostPowerState:
{
Description: The host power state. ,
Required: False ,
}
string ,
hostVersion:
{
Description: The host version. ,
Required: False ,
}
string ,
networkAdapters:
{
Description: Network adapters attached to the machine. ,
Required: False ,
}
[
{
label:
{
Description: Label of the NIC. ,
Required: False ,
}
string ,
adapterType:
{
Description: Gets or sets the adapter type. ,
Required: False ,
}
string ,
nicId:
{
Description: Gets or sets the NIC Id. ,
Required: False ,
}
string ,
macAddress:
{
Description: Gets or sets Mac address of the NIC. ,
Required: False ,
}
string ,
ipAddressList:
{
Description: Gets IP addresses for the machine. ,
Required: False ,
}
[
string ,
]
,
networkName:
{
Description: Gets or sets Network Name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: Gets or sets Type of the IP address. ,
Required: False ,
}
string ,
}
,
]
,
vMwareToolsStatus:
{
Description: VMware tools status. ,
Required: False ,
}
string ,
vMwareToolsVersion:
{
Description: VMware tools version. ,
Required: False ,
}
string ,
changeTrackingSupported:
{
Description: Value indicating whether change tracking is supported. ,
Required: False ,
}
boolean ,
changeTrackingEnabled:
{
Description: Value indicating whether change tracking is enabled. ,
Required: False ,
}
boolean ,
maxSnapshots:
{
Description: Maximum number of snapshots for the VM. Default value is -1. ,
Format: int32 ,
Required: False ,
}
integer ,
diskEnabledUuid:
{
Description: Gets or sets whether Disk Enabled UUID is set or not. ,
Required: False ,
}
string ,
numberOfSnapshots:
{
Description: Number of snapshots for the VM. Default value is -1. ,
Format: int32 ,
Required: False ,
}
integer ,
altGuestName:
{
Description: Gets or sets the machine alt guest name. ,
Required: False ,
}
string ,
powerStatus:
{
Description: Gets the Machine power status. ,
Required: False ,
}
string ,
vmFqdn:
{
Description: Gets the VM FQDN. ,
Required: False ,
}
string ,
vmConfigurationFileLocation:
{
Description: Gets the Root location of the VM configuration file. ,
Required: False ,
}
string ,
firmware:
{
Description: Gets or sets the firmware. ,
Required: False ,
}
string ,
guestOsDetails:
{
Description: Operating System Details extracted from the guest bu executing script inside the guest VM. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
numberOfApplications:
{
Description: Number of applications installed in the guest VM. ,
Format: int32 ,
Required: False ,
}
integer ,
guestDetailsDiscoveryTimestamp:
{
Description: The last time at which the Guest Details was discovered or the error while discovering guest details based discovery of the machine. ,
Format: date-time ,
Required: False ,
}
string ,
isGuestDetailsDiscoveryInProgress:
{
Description: Whether Refresh Fabric Layout Guest Details has been completed once. Portal will show discovery in progress, if this value is true. ,
Required: False ,
}
boolean ,
dependencyMapping:
{
Description: Gets or sets if dependency mapping feature is enabled or not for the VM. ,
Required: False ,
}
string ,
dependencyMappingStartTime:
{
Description: Gets or sets when dependency mapping collection is last started. ,
Format: date-time ,
Required: False ,
}
string ,
dependencyMappingEndTime:
{
Description: Gets or sets when dependency mapping collection was last disabled. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the machine. ,
Required: False ,
}
string ,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Errors for machine. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationDiscovery:
{
Description: Gets the data related to application discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
dependencyMapDiscovery:
{
Description: Gets the data related to dependency map discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
staticDiscovery:
{
Description: Gets the data related to static discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
sqlDiscovery:
{
Description: Gets the data related to SQL discovery. ,
Required: False ,
}
{
successfullyDiscoveredServerCount:
{
Description: successfully Discovered ServerCount ,
Format: int32 ,
Required: False ,
}
integer ,
totalServerCount:
{
Description: total Server Count ,
Format: int32 ,
Required: False ,
}
integer ,
sqlMetadataHydratedRunAsAccountId:
{
Description: sql Metadata Hydrated RunAsAccountId ,
Required: False ,
}
string ,
sqlMetadataDiscoveryPipe:
{
Description: sql Metadata DiscoveryPipe ,
Enum:
{
Unknown: Unknown value. ,
VMware: VMware value. ,
PowerShell: PowerShell value. ,
SSH: SSH value. ,
CIM: CIM value. ,
Other: Other value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: discovery Scope Status ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
webAppDiscovery:
{
Description: Gets the data related to Web application discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
oracleDiscovery:
{
Description: Gets the data related to Oracle discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalDatabaseCount:
{
Description: Gets or sets number of successfully discovered databases. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
springBootDiscovery:
{
Description: Gets the data related to SpringBoot discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplicationCount:
{
Description: Gets or sets number of successfully discovered applications. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
iisDiscovery:
{
Description: Gets the data related to iis discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
tomcatDiscovery:
{
Description: Gets the data related to tomcat discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
appsAndRoles:
{
Description: Apps And Roles of the Server. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: double ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the Display name of the machine. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Value indicating whether VM is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the marking machine creation. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the VMware machine. ,
Required: False ,
}
object ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
arcDiscovery:
{
Description: Gets the data related to Azure arc discovery. ,
Required: False ,
}
{
status:
{
Description: AzureArc status indicates whether arc discovery has successfully completed or not. ,
Enum:
{
Unknown: Unknown value. ,
NotEnabled: Not enabled value. ,
Enabled: Enabled value. ,
}
,
Required: True ,
}
enum ,
machineResourceId:
{
Description: Machine Resource Id. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MachinesController_Get (new)
Description :  Get a MachineResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: Machine name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
vCenterFqdn:
{
Description: VCenter FQDN/IPAddress. ,
Required: False ,
}
string ,
vCenterId:
{
Description: VCenter ARM ID. ,
Required: False ,
}
string ,
instanceUuid:
{
Description: On-premise Instance UUID of the machine. ,
Required: False ,
}
string ,
dataCenterScope:
{
Description: Scope of the data center. ,
Required: False ,
}
string ,
description:
{
Description: User description of the machine. ,
Required: False ,
}
string ,
disks:
{
Description: Disks attached to the machine. ,
Required: False ,
}
[
{
uuid:
{
Description: Disk UUID. ,
Required: False ,
}
string ,
label:
{
Description: Label of the disk. ,
Required: False ,
}
string ,
diskProvisioningPolicy:
{
Description: The provisioning policy of the disk. It is Thin or Thick or Unknown for the VMWare VMDK. ,
Required: False ,
}
string ,
diskScrubbingPolicy:
{
Description: The scrubbing policy of disks which can be eagerly zeroed or lazily zeroed. ,
Required: False ,
}
string ,
diskMode:
{
Description: Disk mode property used for identifying independent disks. ,
Required: False ,
}
string ,
controllerType:
{
Description: Gets or sets a value indicating the type of the disk controller type. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: Gets or sets Bytes allocated for the disk. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets Name of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: Gets or sets Type of the disk. ,
Required: False ,
}
string ,
lun:
{
Description: Gets or sets LUN of the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets Path of the disk. ,
Required: False ,
}
string ,
}
,
]
,
hostInMaintenanceMode:
{
Description: Indicates whether the host is in maintenance mode. ,
Required: False ,
}
boolean ,
hostName:
{
Description: The host name. ,
Required: False ,
}
string ,
hostPowerState:
{
Description: The host power state. ,
Required: False ,
}
string ,
hostVersion:
{
Description: The host version. ,
Required: False ,
}
string ,
networkAdapters:
{
Description: Network adapters attached to the machine. ,
Required: False ,
}
[
{
label:
{
Description: Label of the NIC. ,
Required: False ,
}
string ,
adapterType:
{
Description: Gets or sets the adapter type. ,
Required: False ,
}
string ,
nicId:
{
Description: Gets or sets the NIC Id. ,
Required: False ,
}
string ,
macAddress:
{
Description: Gets or sets Mac address of the NIC. ,
Required: False ,
}
string ,
ipAddressList:
{
Description: Gets IP addresses for the machine. ,
Required: False ,
}
[
string ,
]
,
networkName:
{
Description: Gets or sets Network Name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: Gets or sets Type of the IP address. ,
Required: False ,
}
string ,
}
,
]
,
vMwareToolsStatus:
{
Description: VMware tools status. ,
Required: False ,
}
string ,
vMwareToolsVersion:
{
Description: VMware tools version. ,
Required: False ,
}
string ,
changeTrackingSupported:
{
Description: Value indicating whether change tracking is supported. ,
Required: False ,
}
boolean ,
changeTrackingEnabled:
{
Description: Value indicating whether change tracking is enabled. ,
Required: False ,
}
boolean ,
maxSnapshots:
{
Description: Maximum number of snapshots for the VM. Default value is -1. ,
Format: int32 ,
Required: False ,
}
integer ,
diskEnabledUuid:
{
Description: Gets or sets whether Disk Enabled UUID is set or not. ,
Required: False ,
}
string ,
numberOfSnapshots:
{
Description: Number of snapshots for the VM. Default value is -1. ,
Format: int32 ,
Required: False ,
}
integer ,
altGuestName:
{
Description: Gets or sets the machine alt guest name. ,
Required: False ,
}
string ,
powerStatus:
{
Description: Gets the Machine power status. ,
Required: False ,
}
string ,
vmFqdn:
{
Description: Gets the VM FQDN. ,
Required: False ,
}
string ,
vmConfigurationFileLocation:
{
Description: Gets the Root location of the VM configuration file. ,
Required: False ,
}
string ,
firmware:
{
Description: Gets or sets the firmware. ,
Required: False ,
}
string ,
guestOsDetails:
{
Description: Operating System Details extracted from the guest bu executing script inside the guest VM. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
numberOfApplications:
{
Description: Number of applications installed in the guest VM. ,
Format: int32 ,
Required: False ,
}
integer ,
guestDetailsDiscoveryTimestamp:
{
Description: The last time at which the Guest Details was discovered or the error while discovering guest details based discovery of the machine. ,
Format: date-time ,
Required: False ,
}
string ,
isGuestDetailsDiscoveryInProgress:
{
Description: Whether Refresh Fabric Layout Guest Details has been completed once. Portal will show discovery in progress, if this value is true. ,
Required: False ,
}
boolean ,
dependencyMapping:
{
Description: Gets or sets if dependency mapping feature is enabled or not for the VM. ,
Required: False ,
}
string ,
dependencyMappingStartTime:
{
Description: Gets or sets when dependency mapping collection is last started. ,
Format: date-time ,
Required: False ,
}
string ,
dependencyMappingEndTime:
{
Description: Gets or sets when dependency mapping collection was last disabled. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the machine. ,
Required: False ,
}
string ,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Errors for machine. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationDiscovery:
{
Description: Gets the data related to application discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
dependencyMapDiscovery:
{
Description: Gets the data related to dependency map discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
staticDiscovery:
{
Description: Gets the data related to static discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
sqlDiscovery:
{
Description: Gets the data related to SQL discovery. ,
Required: False ,
}
{
successfullyDiscoveredServerCount:
{
Description: successfully Discovered ServerCount ,
Format: int32 ,
Required: False ,
}
integer ,
totalServerCount:
{
Description: total Server Count ,
Format: int32 ,
Required: False ,
}
integer ,
sqlMetadataHydratedRunAsAccountId:
{
Description: sql Metadata Hydrated RunAsAccountId ,
Required: False ,
}
string ,
sqlMetadataDiscoveryPipe:
{
Description: sql Metadata DiscoveryPipe ,
Enum:
{
Unknown: Unknown value. ,
VMware: VMware value. ,
PowerShell: PowerShell value. ,
SSH: SSH value. ,
CIM: CIM value. ,
Other: Other value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: discovery Scope Status ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
webAppDiscovery:
{
Description: Gets the data related to Web application discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
oracleDiscovery:
{
Description: Gets the data related to Oracle discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalDatabaseCount:
{
Description: Gets or sets number of successfully discovered databases. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
springBootDiscovery:
{
Description: Gets the data related to SpringBoot discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplicationCount:
{
Description: Gets or sets number of successfully discovered applications. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
iisDiscovery:
{
Description: Gets the data related to iis discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
tomcatDiscovery:
{
Description: Gets the data related to tomcat discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
appsAndRoles:
{
Description: Apps And Roles of the Server. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: double ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the Display name of the machine. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Value indicating whether VM is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the marking machine creation. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the VMware machine. ,
Required: False ,
}
object ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
arcDiscovery:
{
Description: Gets the data related to Azure arc discovery. ,
Required: False ,
}
{
status:
{
Description: AzureArc status indicates whether arc discovery has successfully completed or not. ,
Enum:
{
Unknown: Unknown value. ,
NotEnabled: Not enabled value. ,
Enabled: Enabled value. ,
}
,
Required: True ,
}
enum ,
machineResourceId:
{
Description: Machine Resource Id. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MachinesController_Update (new)
Description :  Update a MachineResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: Machine name ,
Required: True ,
}
string ,
body:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The updatable properties of the MachineResource. ,
Required: False ,
}
{
firmware:
{
Description: Gets or sets the firmware. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the machine. ,
Required: False ,
}
string ,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: double ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the VMware machine. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
vCenterFqdn:
{
Description: VCenter FQDN/IPAddress. ,
Required: False ,
}
string ,
vCenterId:
{
Description: VCenter ARM ID. ,
Required: False ,
}
string ,
instanceUuid:
{
Description: On-premise Instance UUID of the machine. ,
Required: False ,
}
string ,
dataCenterScope:
{
Description: Scope of the data center. ,
Required: False ,
}
string ,
description:
{
Description: User description of the machine. ,
Required: False ,
}
string ,
disks:
{
Description: Disks attached to the machine. ,
Required: False ,
}
[
{
uuid:
{
Description: Disk UUID. ,
Required: False ,
}
string ,
label:
{
Description: Label of the disk. ,
Required: False ,
}
string ,
diskProvisioningPolicy:
{
Description: The provisioning policy of the disk. It is Thin or Thick or Unknown for the VMWare VMDK. ,
Required: False ,
}
string ,
diskScrubbingPolicy:
{
Description: The scrubbing policy of disks which can be eagerly zeroed or lazily zeroed. ,
Required: False ,
}
string ,
diskMode:
{
Description: Disk mode property used for identifying independent disks. ,
Required: False ,
}
string ,
controllerType:
{
Description: Gets or sets a value indicating the type of the disk controller type. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: Gets or sets Bytes allocated for the disk. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets Name of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: Gets or sets Type of the disk. ,
Required: False ,
}
string ,
lun:
{
Description: Gets or sets LUN of the disk. ,
Format: int32 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets Path of the disk. ,
Required: False ,
}
string ,
}
,
]
,
hostInMaintenanceMode:
{
Description: Indicates whether the host is in maintenance mode. ,
Required: False ,
}
boolean ,
hostName:
{
Description: The host name. ,
Required: False ,
}
string ,
hostPowerState:
{
Description: The host power state. ,
Required: False ,
}
string ,
hostVersion:
{
Description: The host version. ,
Required: False ,
}
string ,
networkAdapters:
{
Description: Network adapters attached to the machine. ,
Required: False ,
}
[
{
label:
{
Description: Label of the NIC. ,
Required: False ,
}
string ,
adapterType:
{
Description: Gets or sets the adapter type. ,
Required: False ,
}
string ,
nicId:
{
Description: Gets or sets the NIC Id. ,
Required: False ,
}
string ,
macAddress:
{
Description: Gets or sets Mac address of the NIC. ,
Required: False ,
}
string ,
ipAddressList:
{
Description: Gets IP addresses for the machine. ,
Required: False ,
}
[
string ,
]
,
networkName:
{
Description: Gets or sets Network Name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: Gets or sets Type of the IP address. ,
Required: False ,
}
string ,
}
,
]
,
vMwareToolsStatus:
{
Description: VMware tools status. ,
Required: False ,
}
string ,
vMwareToolsVersion:
{
Description: VMware tools version. ,
Required: False ,
}
string ,
changeTrackingSupported:
{
Description: Value indicating whether change tracking is supported. ,
Required: False ,
}
boolean ,
changeTrackingEnabled:
{
Description: Value indicating whether change tracking is enabled. ,
Required: False ,
}
boolean ,
maxSnapshots:
{
Description: Maximum number of snapshots for the VM. Default value is -1. ,
Format: int32 ,
Required: False ,
}
integer ,
diskEnabledUuid:
{
Description: Gets or sets whether Disk Enabled UUID is set or not. ,
Required: False ,
}
string ,
numberOfSnapshots:
{
Description: Number of snapshots for the VM. Default value is -1. ,
Format: int32 ,
Required: False ,
}
integer ,
altGuestName:
{
Description: Gets or sets the machine alt guest name. ,
Required: False ,
}
string ,
powerStatus:
{
Description: Gets the Machine power status. ,
Required: False ,
}
string ,
vmFqdn:
{
Description: Gets the VM FQDN. ,
Required: False ,
}
string ,
vmConfigurationFileLocation:
{
Description: Gets the Root location of the VM configuration file. ,
Required: False ,
}
string ,
firmware:
{
Description: Gets or sets the firmware. ,
Required: False ,
}
string ,
guestOsDetails:
{
Description: Operating System Details extracted from the guest bu executing script inside the guest VM. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
numberOfApplications:
{
Description: Number of applications installed in the guest VM. ,
Format: int32 ,
Required: False ,
}
integer ,
guestDetailsDiscoveryTimestamp:
{
Description: The last time at which the Guest Details was discovered or the error while discovering guest details based discovery of the machine. ,
Format: date-time ,
Required: False ,
}
string ,
isGuestDetailsDiscoveryInProgress:
{
Description: Whether Refresh Fabric Layout Guest Details has been completed once. Portal will show discovery in progress, if this value is true. ,
Required: False ,
}
boolean ,
dependencyMapping:
{
Description: Gets or sets if dependency mapping feature is enabled or not for the VM. ,
Required: False ,
}
string ,
dependencyMappingStartTime:
{
Description: Gets or sets when dependency mapping collection is last started. ,
Format: date-time ,
Required: False ,
}
string ,
dependencyMappingEndTime:
{
Description: Gets or sets when dependency mapping collection was last disabled. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets or sets the run as account ID of the machine. ,
Required: False ,
}
string ,
applianceNames:
{
Description: Gets the appliance names. ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Errors for machine. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationDiscovery:
{
Description: Gets the data related to application discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
dependencyMapDiscovery:
{
Description: Gets the data related to dependency map discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
staticDiscovery:
{
Description: Gets the data related to static discovery. ,
Required: False ,
}
{
discoveryScopeStatus:
{
Description: Gets discovery scope status. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Gets errors for discovery scope. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hydratedRunAsAccountId:
{
Description: Gets the run as account ID with which feature worked successfully. It is discovered by the agent from the list of credentials. ,
Required: False ,
}
string ,
}
,
sqlDiscovery:
{
Description: Gets the data related to SQL discovery. ,
Required: False ,
}
{
successfullyDiscoveredServerCount:
{
Description: successfully Discovered ServerCount ,
Format: int32 ,
Required: False ,
}
integer ,
totalServerCount:
{
Description: total Server Count ,
Format: int32 ,
Required: False ,
}
integer ,
sqlMetadataHydratedRunAsAccountId:
{
Description: sql Metadata Hydrated RunAsAccountId ,
Required: False ,
}
string ,
sqlMetadataDiscoveryPipe:
{
Description: sql Metadata DiscoveryPipe ,
Enum:
{
Unknown: Unknown value. ,
VMware: VMware value. ,
PowerShell: PowerShell value. ,
SSH: SSH value. ,
CIM: CIM value. ,
Other: Other value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: discovery Scope Status ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
webAppDiscovery:
{
Description: Gets the data related to Web application discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
oracleDiscovery:
{
Description: Gets the data related to Oracle discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalDatabaseCount:
{
Description: Gets or sets number of successfully discovered databases. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
springBootDiscovery:
{
Description: Gets the data related to SpringBoot discovery. ,
Required: False ,
}
{
totalInstanceCount:
{
Description: Gets or sets number of successfully discovered instances. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplicationCount:
{
Description: Gets or sets number of successfully discovered applications. ,
Format: int64 ,
Required: False ,
}
integer ,
shallowDiscoveryStatus:
{
Description: Gets or sets status of partner shallow discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
iisDiscovery:
{
Description: Gets the data related to iis discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
tomcatDiscovery:
{
Description: Gets the data related to tomcat discovery. ,
Required: False ,
}
{
totalWebServerCount:
{
Description: Gets or sets number of successfully discovered web servers.. ,
Format: int64 ,
Required: False ,
}
integer ,
totalWebApplicationCount:
{
Description: Gets or sets number of successfully discovered web applications. ,
Format: int64 ,
Required: False ,
}
integer ,
discoveryScopeStatus:
{
Description: Gets or sets status of partner discovery. ,
Enum:
{
DiscoverySucceededAtleastOnce: DiscoverySucceededAtleastOnce value. ,
DiscoveryFailed: DiscoveryFailed value. ,
RunAsAccountNotAssociated: RunAsAccountNotAssociated value. ,
DiscoveryNotStarted: DiscoveryNotStarted value. ,
DiscoveryInProgress: DiscoveryInProgress value. ,
Disabled: Disabled value. ,
DiscoveryPartiallySucceded: DiscoveryPartiallySucceded value. ,
DiscoverySucceeded: DiscoverySucceeded value. ,
}
,
Required: False ,
}
enum ,
}
,
appsAndRoles:
{
Description: Apps And Roles of the Server. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
productSupportStatus:
{
Description: product support status. ,
Required: False ,
}
{
currentVersion:
{
Description: current version. ,
Required: False ,
}
string ,
esuStatus:
{
Description: esu status. ,
Enum:
{
Unknown: Unknown value. ,
Active: Active value. ,
InActive: InActive value. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: support status. ,
Enum:
{
Unknown: Unknown value. ,
Mainstream: Mainstream value. ,
Extended: Extended value. ,
}
,
Required: False ,
}
enum ,
supportEndDate:
{
Description: support end date. ,
Format: date-time ,
Required: False ,
}
string ,
esuYear:
{
Description: esu year. ,
Enum:
{
Unknown: Unknown value. ,
FirstYear: FirstYear value. ,
SecondYear: SecondYear value. ,
ThirdYear: ThirdYear value. ,
UpgradeYear: UpgradeYear value. ,
}
,
Required: False ,
}
enum ,
}
,
numberOfProcessorCore:
{
Description: Gets or sets the Number of Processor Cores allocated for the machine. ,
Format: int32 ,
Required: False ,
}
integer ,
allocatedMemoryInMb:
{
Description: Gets or sets the allocated Memory in MB. ,
Format: double ,
Required: False ,
}
number ,
operatingSystemDetails:
{
Description: Gets or sets the Operating System Details installed on the machine. ,
Required: False ,
}
{
osType:
{
Description: Gets or sets the type of the operating system. ,
Required: False ,
}
string ,
osName:
{
Description: Gets or sets the Name of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets or sets the Version of the operating system. ,
Required: False ,
}
string ,
osArchitecture:
{
Description: Gets or sets the Architecture of the operating system. ,
Required: False ,
}
string ,
}
,
biosSerialNumber:
{
Description: Gets or sets the Machine BIOS serial number. ,
Required: False ,
}
string ,
biosGuid:
{
Description: Gets or sets the BIOS GUID. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the Display name of the machine. ,
Required: False ,
}
string ,
isDeleted:
{
Description: Value indicating whether VM is deleted. ,
Required: False ,
}
boolean ,
createdTimestamp:
{
Description: Gets the marking machine creation. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets tags on the VMware machine. ,
Required: False ,
}
object ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
arcDiscovery:
{
Description: Gets the data related to Azure arc discovery. ,
Required: False ,
}
{
status:
{
Description: AzureArc status indicates whether arc discovery has successfully completed or not. ,
Enum:
{
Unknown: Unknown value. ,
NotEnabled: Not enabled value. ,
Enabled: Enabled value. ,
}
,
Required: True ,
}
enum ,
machineResourceId:
{
Description: Machine Resource Id. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VmwareSoftwareInventoriesController_GetMachineSoftwareInventory (new)
Description :  Method to get a machines software inventory like applications and roles.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareInventories/{default}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: Machine name ,
Required: True ,
}
string ,
default:
{
Description: Default value. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
appsAndRoles:
{
Description: Apps And Roles of the machine entity. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VmwareSoftwareInventoriesController_ListByMachineResource (new)
Description :  List VmwareMachineSoftwareInventory resources by MachineResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareinventories
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: Machine name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VmwareMachineSoftwareInventory items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
appsAndRoles:
{
Description: Apps And Roles of the machine entity. ,
Required: False ,
}
{
applications:
{
Description: Gets or sets Applications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Application. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the Application. ,
Required: False ,
}
string ,
provider:
{
Description: Gets or sets Provider of the Application. ,
Required: False ,
}
string ,
}
,
]
,
webApplications:
{
Description: Gets or sets WebApplications of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the WebApplication. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the WebApplication. ,
Required: False ,
}
string ,
platform:
{
Description: Gets or sets Platform of the WebApplication. ,
Required: False ,
}
string ,
groupName:
{
Description: Gets or sets GroupName of the WebApplication. ,
Required: False ,
}
string ,
webServer:
{
Description: Gets or sets WebServer of the WebApplication. ,
Required: False ,
}
string ,
applicationPool:
{
Description: Gets or sets ApplicationPool of the WebApplication. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Gets or sets Features of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the Feature. ,
Required: False ,
}
string ,
featureType:
{
Description: Gets or sets FeatureType of the Feature. ,
Required: False ,
}
string ,
parent:
{
Description: Gets or sets Parent of the Feature. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the Feature. ,
Required: False ,
}
string ,
}
,
]
,
sqlServers:
{
Description: Gets or sets SQLServers of the AppsAndRoles. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the SQLServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the SQLServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the SQLServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SQLServer. ,
Required: False ,
}
string ,
clustered:
{
Description: Gets or sets Clustered of the SQLServer. ,
Required: False ,
}
string ,
clusterName:
{
Description: Gets or sets ClusterName of the SQLServer. ,
Required: False ,
}
string ,
dnsHostName:
{
Description: Gets or sets the DNS host name of SQLServer. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the SQLServer. ,
Required: False ,
}
string ,
commaSeparatedIps:
{
Description: Gets or sets the comma separated IPs of the SQLServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Required: False ,
}
string ,
isNamedPipeEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
isTcpIpEnabled:
{
Description: Gets or sets the value which reflects if Named Pipe is enabled or not. ,
Required: False ,
}
boolean ,
namedPipeName:
{
Description: Gets the status. ,
Required: False ,
}
string ,
}
,
]
,
sharePointServers:
{
Description: Gets or sets SharePointServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SharePointServer. ,
Required: False ,
}
string ,
isEnterprise:
{
Description: Gets or sets a value indicating whether the SharePointServer is Enterprise. ,
Required: False ,
}
boolean ,
status:
{
Description: Gets or sets Status of the SharePointServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SharePointServer. ,
Required: False ,
}
string ,
}
,
]
,
systemCenters:
{
Description: Gets or sets SystemCenters of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the SystemCenter. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the SystemCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the SystemCenter. ,
Required: False ,
}
string ,
}
,
]
,
bizTalkServers:
{
Description: Gets or sets BizTalkServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the BizTalkServer. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets Status of the BizTalkServer. ,
Required: False ,
}
string ,
}
,
]
,
exchangeServers:
{
Description: Gets or sets ExchangeServers of the AppsAndRoles. ,
Required: False ,
}
[
{
productName:
{
Description: Gets or sets ProductName of the ExchangeServer. ,
Required: False ,
}
string ,
edition:
{
Description: Gets or sets Edition of the ExchangeServer. ,
Required: False ,
}
string ,
roles:
{
Description: Gets or sets Roles of the ExchangeServer. ,
Required: False ,
}
string ,
servicePack:
{
Description: Gets or sets ServicePack of the ExchangeServer. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the ExchangeServer. ,
Required: False ,
}
string ,
}
,
]
,
otherDatabases:
{
Description: Gets or sets OtherDatabaseServers of the AppsAndRoles. ,
Required: False ,
}
[
{
databaseType:
{
Description: Gets or sets DatabaseType of the OtherDatabase. ,
Required: False ,
}
string ,
instance:
{
Description: Gets or sets Instance of the OtherDatabase. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets Version of the OtherDatabase. ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MachinesController_Start (new)
Description :  Method to start a machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: Machine name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
MachinesController_Stop (new)
Description :  Method to stop a machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
machineName:
{
Description: Machine name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VmwareOperationsStatus_GetVmwareOperationStatus (new)
Description :  A operation status resource belonging to a site resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/operationsStatus/{operationStatusName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
operationStatusName:
{
Description: Operation status Arm Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the operation name. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the start time. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
{
code:
{
Description: Gets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Operation status properties ,
Required: False ,
}
{
result:
{
Description: Gets or sets the result or output of the workflow. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
RunAsAccountsController_ListByVmwareSite (new)
Description :  List VmwareRunAsAccountResource resources by VmwareSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/runAsAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VmwareRunAsAccountResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the run as account. ,
Required: False ,
}
string ,
credentialType:
{
Description: Gets the credential type of the run as account. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Timestamp marking run as account creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp marking last updated on the run as account. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the appliance name of the run as account. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
RunAsAccountsController_Get (new)
Description :  Get a VmwareRunAsAccountResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/runAsAccounts/{accountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
accountName:
{
Description: RunAsAccounts name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the run as account. ,
Required: False ,
}
string ,
credentialType:
{
Description: Gets the credential type of the run as account. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Timestamp marking run as account creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Timestamp marking last updated on the run as account. ,
Required: False ,
}
string ,
applianceName:
{
Description: Gets the appliance name of the run as account. ,
Required: False ,
}
string ,
provisioningState:
{
Description: provisioning state enum ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
DependencyMapController_ServerGroupMembers (new)
Description :  API to list server group members for the selected server group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/serverGroupMembers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
mapRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
serverPort:
{
Description: port of server ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end time ,
Format: date-time ,
Required: False ,
}
string ,
filters:
{
Description: optional filters ,
Required: False ,
}
{
machineIds:
{
Description: array of machine ids ,
Required: False ,
}
[
string ,
]
,
processIds:
{
Description: array of process Ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
SitesController_Summary (new)
Description :  Method to get site usage/summary.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/summary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
machineCount:
{
Description: Gets or sets the number of machines discovered in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
runAsAccountCount:
{
Description: Gets or sets the number of run as accounts in the site. ,
Format: int32 ,
Required: False ,
}
integer ,
vCenterCount:
{
Description: Gets or sets the number of vCenters part of the site. ,
Format: int32 ,
Required: False ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VmwarePropertiesController_UpdateDependencyMapStatus (new)
Description :  Method to enable disable dependency map status for machines in a site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateDependencyMapStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
updateMachineDepMapStatus:
{
Description: The content of the action request ,
Required: True ,
}
{
machines:
{
Description: Gets or sets the machine collection. ,
Required: False ,
}
[
{
machineId:
{
Description: Gets or sets the ARM id of the machine. ,
Required: False ,
}
string ,
isDependencyMapToBeEnabled:
{
Description: Gets or sets a value indicating whether dependency mapping is to be enabled or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VmwarePropertiesController_UpdateProperties (new)
Description :  Method to update properties for machines in a site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateProperties
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
metaData:
{
Description: The content of the action request ,
Required: True ,
}
{
value:
{
Description: The list of Machine MetaData. ,
Required: True ,
}
[
{
machineArmId:
{
Description: arm id of the machine. ,
Required: True ,
}
string ,
dependencyMapping:
{
Description: value representing state of dependency mapping (enabled/disabled). ,
Required: True ,
}
string ,
tags:
{
Description: machine tags ,
Required: True ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VmwarePropertiesController_UpdateRunAsAccount (new)
Description :  Method to associate Run as account to machine in a site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateRunAsAccount
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
updateMachineRunAsAccount:
{
Description: The content of the action request ,
Required: True ,
}
{
machines:
{
Description: Gets or sets the machine collection. ,
Required: False ,
}
[
{
machineId:
{
Description: Gets or sets the ARM id of the machine. ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: run as AccountId ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VmwarePropertiesController_UpdateTags (new)
Description :  Method to associate Run as account to machine in a site.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateTags
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
updateMachineTags:
{
Description: The content of the action request ,
Required: True ,
}
{
machines:
{
Description: Gets or sets the machine collection. ,
Required: False ,
}
[
{
machineId:
{
Description: Gets or sets the ARM id of the machine. ,
Required: False ,
}
string ,
tags:
{
Description: run as AccountId ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VcenterController_ListByVmwareSite (new)
Description :  List Vcenter resources by VmwareSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: filter query ,
Required: False ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Vcenter items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
runAsAccountId:
{
Description: Gets or sets the run as account ID of the vCenter. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdTimestamp:
{
Description: Gets the timestamp marking vCenter creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the vCenter. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the vCenter. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the vCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the vCenter. ,
Required: False ,
}
string ,
perfStatisticsLevel:
{
Description: Gets the performance statistics enabled on the vCenter. ,
Required: False ,
}
string ,
instanceUuid:
{
Description: Gets the instance UUID of the vCenter. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name of the vCenter. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VcenterController_Get (new)
Description :  Get a Vcenter
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters/{vcenterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
vcenterName:
{
Description: VCenters name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
runAsAccountId:
{
Description: Gets or sets the run as account ID of the vCenter. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdTimestamp:
{
Description: Gets the timestamp marking vCenter creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the vCenter. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the vCenter. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the vCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the vCenter. ,
Required: False ,
}
string ,
perfStatisticsLevel:
{
Description: Gets the performance statistics enabled on the vCenter. ,
Required: False ,
}
string ,
instanceUuid:
{
Description: Gets the instance UUID of the vCenter. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name of the vCenter. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VcenterController_Create (new)
Description :  Create a Vcenter
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters/{vcenterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
vcenterName:
{
Description: VCenters name ,
Required: True ,
}
string ,
body:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
runAsAccountId:
{
Description: Gets or sets the run as account ID of the vCenter. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdTimestamp:
{
Description: Gets the timestamp marking vCenter creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the vCenter. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the vCenter. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the vCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the vCenter. ,
Required: False ,
}
string ,
perfStatisticsLevel:
{
Description: Gets the performance statistics enabled on the vCenter. ,
Required: False ,
}
string ,
instanceUuid:
{
Description: Gets the instance UUID of the vCenter. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name of the vCenter. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
runAsAccountId:
{
Description: Gets or sets the run as account ID of the vCenter. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdTimestamp:
{
Description: Gets the timestamp marking vCenter creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the vCenter. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the vCenter. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the vCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the vCenter. ,
Required: False ,
}
string ,
perfStatisticsLevel:
{
Description: Gets the performance statistics enabled on the vCenter. ,
Required: False ,
}
string ,
instanceUuid:
{
Description: Gets the instance UUID of the vCenter. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name of the vCenter. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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: A vcenter resource belonging to a site resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
runAsAccountId:
{
Description: Gets or sets the run as account ID of the vCenter. ,
Required: False ,
}
string ,
errors:
{
Description: Gets the errors. ,
Required: False ,
}
[
{
message:
{
Description: Gets the error message. ,
Required: False ,
}
string ,
messageParameters:
{
Description: Gets the message parameters. ,
Required: False ,
}
object ,
applianceName:
{
Description: Gets the appliance name. ,
Required: False ,
}
string ,
id:
{
Description: Gets the error ID. ,
Format: int64 ,
Required: False ,
}
integer ,
code:
{
Description: Gets the error name. ,
Required: False ,
}
string ,
possibleCauses:
{
Description: Gets the possible causes of error. ,
Required: False ,
}
string ,
recommendedAction:
{
Description: Gets the recommended action to resolve error. ,
Required: False ,
}
string ,
severity:
{
Description: Gets the error severity. ,
Required: False ,
}
string ,
summaryMessage:
{
Description: Gets the error summary message. ,
Required: False ,
}
string ,
source:
{
Description: Gets the error source. ,
Enum:
{
RefreshFabricLayout: RefreshFabricLayout value. ,
RefreshFabricLayoutGuest: RefreshFabricLayoutGuest value. ,
RefreshFabricLayoutDependencyMap: RefreshFabricLayoutDependencyMap value. ,
}
,
Required: False ,
}
enum ,
updatedTimeStamp:
{
Description: Gets the time stamp when the error was updated. ,
Format: date-time ,
Required: False ,
}
string ,
runAsAccountId:
{
Description: Gets run as account id used while performing discovery of entity. ,
Required: False ,
}
string ,
discoveryScope:
{
Description: Gets discovery scope for which error is encountered. ,
Enum:
{
AppsAndRoles: AppsAndRoles value. ,
DependencyMap: DependencyMap value. ,
StaticData: StaticData value. ,
SQLServerConnectionInfo: SQLServerConnectionInfo value. ,
DiscoveryTargets: DiscoveryTargets value. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdTimestamp:
{
Description: Gets the timestamp marking vCenter creation. ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Gets the timestamp marking last updated on the vCenter. ,
Required: False ,
}
string ,
fqdn:
{
Description: Gets or sets the FQDN/IPAddress of the vCenter. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the port of the vCenter. ,
Required: False ,
}
string ,
version:
{
Description: Gets the version of the vCenter. ,
Required: False ,
}
string ,
perfStatisticsLevel:
{
Description: Gets the performance statistics enabled on the vCenter. ,
Required: False ,
}
string ,
instanceUuid:
{
Description: Gets the instance UUID of the vCenter. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name of the vCenter. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Created: Created value. ,
Updated: Updated value. ,
Running: Running value. ,
Completed: Completed value. ,
Failed: Failed value. ,
Succeeded: Succeeded value. ,
Canceled: Canceled value. ,
}
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
VcenterController_Delete (new)
Description :  Delete a Vcenter
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters/{vcenterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
vcenterName:
{
Description: VCenters name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}