Microsoft.ResourceConnector (stable:2022-10-27)

2025/10/30 • 11 new, 11 deleted methods

Appliances_ListOperations (new)
Description :  Lists all available Appliances operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ResourceConnector/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: Array of applianceOperation ,
Required: True ,
}
[
{
display:
{
Description: Describes the properties of an Appliances Operation Value Display. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The display name of the compute operation. ,
Required: False ,
}
string ,
provider:
{
Description: The resource provider for the operation. ,
Required: False ,
}
string ,
resource:
{
Description: The display name of the resource the operation applies to. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Is this Operation a data plane operation ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the compute operation. ,
Required: False ,
}
string ,
origin:
{
Description: The origin of the compute operation. ,
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 ,
}
,
]
,
}
,
}
Appliances_ListBySubscription (new)
Description :  Gets a list of Appliances in the specified subscription. The operation returns properties of each Appliance
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceConnector/appliances
{
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)

{
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of Appliances. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
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 ,
}
,
]
,
}
,
}
Appliances_GetTelemetryConfig (new)
Description :  Gets the telemetry config.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceConnector/telemetryconfig
{
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)

{
telemetryInstrumentationKey:
{
Description: Telemetry instrumentation key. ,
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 ,
}
,
]
,
}
,
}
Appliances_ListByResourceGroup (new)
Description :  Gets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances
{
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)

{
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of Appliances. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
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 ,
}
,
]
,
}
,
}
Appliances_Get (new)
Description :  Gets the details of an Appliance with a specified resource group and name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
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 ,
}
,
]
,
}
,
}
Appliances_CreateOrUpdate (new)
Description :  Creates or updates an Appliance in the specified Subscription and Resource Group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or update an Appliance. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
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 ,
}
,
]
,
}
,
}
Appliances_Delete (new)
Description :  Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Appliances_Update (new)
Description :  Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
parameters:
{
Description: The updatable fields of an existing Appliance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
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 ,
}
,
]
,
}
,
}
Appliances_ListClusterUserCredential (new)
Description :  Returns the cluster user credentials for the dedicated appliance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/listClusterUserCredential
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
hybridConnectionConfig:
{
Description: Contains the REP (rendezvous endpoint) and “Listener” access token from notification service (NS). ,
Required: False ,
}
{
expirationTime:
{
Description: Timestamp when this token will be expired. ,
Format: int64 ,
Required: False ,
}
integer ,
hybridConnectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
relay:
{
Description: Name of the notification service. ,
Required: False ,
}
string ,
token:
{
Description: Listener access token ,
Required: False ,
}
string ,
}
,
kubeconfigs:
{
Description: The list of appliance kubeconfigs. ,
Required: False ,
}
[
{
name:
{
Description: Name which contains the role of the kubeconfig. ,
Enum:
{
clusterUser: No description available. ,
clusterCustomerUser: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Contains the kubeconfig value. ,
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 ,
}
,
]
,
}
,
}
Appliances_ListKeys (new)
Description :  Returns the cluster customer credentials for the dedicated appliance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/listkeys
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
artifactType:
{
Description: This sets the type of artifact being returned, when empty no artifact endpoint is returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
artifactProfiles:
{
Description: Map of artifacts that contains a list of ArtifactProfile used to upload artifacts such as logs. ,
Required: False ,
}
object ,
kubeconfigs:
{
Description: The list of appliance kubeconfigs. ,
Required: False ,
}
[
{
name:
{
Description: Name which contains the role of the kubeconfig. ,
Enum:
{
clusterUser: No description available. ,
clusterCustomerUser: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Contains the kubeconfig value. ,
Required: False ,
}
string ,
}
,
]
,
sshKeys:
{
Description: Map of Customer User Public, Private SSH Keys and Certificate when available. ,
Required: False ,
}
object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Appliances_GetUpgradeGraph (new)
Description :  Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/upgradeGraphs/{upgradeGraph}
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
upgradeGraph:
{
Description: Upgrade graph version, ex - stable ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The appliance resource path ,
Required: False ,
}
string ,
name:
{
Description: The release train name. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of supported version ,
Required: False ,
}
{
applianceVersion:
{
Description: The current appliance version ,
Required: False ,
}
string ,
supportedVersions:
{
Description: This contains the current version and supported upgrade versions. ,
Required: False ,
}
[
{
metadata:
{
Description: This is the metadata of the supported newer version. ,
Required: False ,
}
{
catalogVersion:
{
Description: The newer supported version catalog version. ,
Required: False ,
}
{
data:
{
Description: The newer supported version catalog version data. ,
Required: False ,
}
{
audience:
{
Description: The image audience name for the version available for upgrade. ,
Required: False ,
}
string ,
catalog:
{
Description: The image catalog name for the version available for upgrade. ,
Required: False ,
}
string ,
offer:
{
Description: The image offer name for the version available for upgrade. ,
Required: False ,
}
string ,
version:
{
Description: The image version for the version available for upgrade. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The catalog version name for the version available for upgrade. ,
Required: False ,
}
string ,
namespace:
{
Description: The catalog version namespace for the version available for upgrade. ,
Required: False ,
}
string ,
}
,
}
,
version:
{
Description: The newer version available for upgrade. ,
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 ,
}
,
]
,
}
,
}
Appliances_ListOperations (removed)
Description :  Lists all available Appliances operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ResourceConnector/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: Array of applianceOperation ,
Required: True ,
}
[
{
display:
{
Description: Describes the properties of an Appliances Operation Value Display. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The display name of the compute operation. ,
Required: False ,
}
string ,
provider:
{
Description: The resource provider for the operation. ,
Required: False ,
}
string ,
resource:
{
Description: The display name of the resource the operation applies to. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Is this Operation a data plane operation ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the compute operation. ,
Required: False ,
}
string ,
origin:
{
Description: The origin of the compute operation. ,
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 ,
}
,
]
,
}
,
}
Appliances_ListBySubscription (removed)
Description :  Gets a list of Appliances in the specified subscription. The operation returns properties of each Appliance
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceConnector/appliances
{
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)

{
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of Appliances. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
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 ,
}
,
]
,
}
,
}
Appliances_GetTelemetryConfig (removed)
Description :  Gets the telemetry config.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceConnector/telemetryconfig
{
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)

{
telemetryInstrumentationKey:
{
Description: Telemetry instrumentation key. ,
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 ,
}
,
]
,
}
,
}
Appliances_ListByResourceGroup (removed)
Description :  Gets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances
{
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)

{
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of Appliances. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
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 ,
}
,
]
,
}
,
}
Appliances_Get (removed)
Description :  Gets the details of an Appliance with a specified resource group and name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
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 ,
}
,
]
,
}
,
}
Appliances_CreateOrUpdate (removed)
Description :  Creates or updates an Appliance in the specified Subscription and Resource Group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or update an Appliance. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
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 ,
}
,
]
,
}
,
}
Appliances_Delete (removed)
Description :  Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Appliances_Update (removed)
Description :  Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
parameters:
{
Description: The updatable fields of an existing Appliance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to an Appliance ,
Required: False ,
}
{
distro:
{
Description: Represents a supported Fabric/Infra. (AKSEdge etc...). ,
Enum:
{
AKSEdge: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureConfig:
{
Description: Contains infrastructure information about the Appliance ,
Required: False ,
}
{
provider:
{
Description: Information about the connected appliance. ,
Enum:
{
VMWare: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
publicKey:
{
Description: Certificates pair used to download MSI certificate from HIS. Can only be set once. ,
Required: False ,
}
string ,
status:
{
Description: Appliance’s health and state of connection to on-prem ,
Enum:
{
WaitingForHeartbeat: No description available. ,
Validating: No description available. ,
Connecting: No description available. ,
Connected: No description available. ,
Running: No description available. ,
PreparingForUpgrade: No description available. ,
ETCDSnapshotFailed: No description available. ,
UpgradePrerequisitesCompleted: No description available. ,
ValidatingSFSConnectivity: No description available. ,
ValidatingImageDownload: No description available. ,
ValidatingImageUpload: No description available. ,
ValidatingETCDHealth: No description available. ,
PreUpgrade: No description available. ,
UpgradingKVAIO: No description available. ,
WaitingForKVAIO: No description available. ,
ImagePending: No description available. ,
ImageProvisioning: No description available. ,
ImageProvisioned: No description available. ,
ImageDownloading: No description available. ,
ImageDownloaded: No description available. ,
ImageDeprovisioning: No description available. ,
ImageUnknown: No description available. ,
UpdatingCloudOperator: No description available. ,
WaitingForCloudOperator: No description available. ,
UpdatingCAPI: No description available. ,
UpdatingCluster: No description available. ,
PostUpgrade: No description available. ,
UpgradeComplete: No description available. ,
UpgradeClusterExtensionFailedToDelete: No description available. ,
UpgradeFailed: No description available. ,
Offline: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the Appliance ,
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 ,
}
,
]
,
}
,
}
Appliances_ListClusterUserCredential (removed)
Description :  Returns the cluster user credentials for the dedicated appliance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/listClusterUserCredential
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
hybridConnectionConfig:
{
Description: Contains the REP (rendezvous endpoint) and “Listener” access token from notification service (NS). ,
Required: False ,
}
{
expirationTime:
{
Description: Timestamp when this token will be expired. ,
Format: int64 ,
Required: False ,
}
integer ,
hybridConnectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
relay:
{
Description: Name of the notification service. ,
Required: False ,
}
string ,
token:
{
Description: Listener access token ,
Required: False ,
}
string ,
}
,
kubeconfigs:
{
Description: The list of appliance kubeconfigs. ,
Required: False ,
}
[
{
name:
{
Description: Name which contains the role of the kubeconfig. ,
Enum:
{
clusterUser: No description available. ,
clusterCustomerUser: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Contains the kubeconfig value. ,
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 ,
}
,
]
,
}
,
}
Appliances_ListKeys (removed)
Description :  Returns the cluster customer credentials for the dedicated appliance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/listkeys
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
artifactType:
{
Description: This sets the type of artifact being returned, when empty no artifact endpoint is returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
artifactProfiles:
{
Description: Map of artifacts that contains a list of ArtifactProfile used to upload artifacts such as logs. ,
Required: False ,
}
object ,
kubeconfigs:
{
Description: The list of appliance kubeconfigs. ,
Required: False ,
}
[
{
name:
{
Description: Name which contains the role of the kubeconfig. ,
Enum:
{
clusterUser: No description available. ,
clusterCustomerUser: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Contains the kubeconfig value. ,
Required: False ,
}
string ,
}
,
]
,
sshKeys:
{
Description: Map of Customer User Public, Private SSH Keys and Certificate when available. ,
Required: False ,
}
object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Appliances_GetUpgradeGraph (removed)
Description :  Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/upgradeGraphs/{upgradeGraph}
{
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 ,
resourceName:
{
Description: Appliances name. ,
Required: True ,
}
string ,
upgradeGraph:
{
Description: Upgrade graph version, ex - stable ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The appliance resource path ,
Required: False ,
}
string ,
name:
{
Description: The release train name. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of supported version ,
Required: False ,
}
{
applianceVersion:
{
Description: The current appliance version ,
Required: False ,
}
string ,
supportedVersions:
{
Description: This contains the current version and supported upgrade versions. ,
Required: False ,
}
[
{
metadata:
{
Description: This is the metadata of the supported newer version. ,
Required: False ,
}
{
catalogVersion:
{
Description: The newer supported version catalog version. ,
Required: False ,
}
{
data:
{
Description: The newer supported version catalog version data. ,
Required: False ,
}
{
audience:
{
Description: The image audience name for the version available for upgrade. ,
Required: False ,
}
string ,
catalog:
{
Description: The image catalog name for the version available for upgrade. ,
Required: False ,
}
string ,
offer:
{
Description: The image offer name for the version available for upgrade. ,
Required: False ,
}
string ,
version:
{
Description: The image version for the version available for upgrade. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The catalog version name for the version available for upgrade. ,
Required: False ,
}
string ,
namespace:
{
Description: The catalog version namespace for the version available for upgrade. ,
Required: False ,
}
string ,
}
,
}
,
version:
{
Description: The newer version available for upgrade. ,
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 ,
}
,
]
,
}
,
}