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

2025/11/10 • 3 updated methods

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

⚶ Changes

{
  "#id": "Appliances_ListOperations",
  "$responses": {
    "200": {
      "Description": {
        "new": "Paged collection of ApplianceOperation items",
        "old": "Lists of Appliances operations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ApplianceOperation items on this page",
            "old": "Array of applianceOperation"
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Next page of operations."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The ApplianceOperation items on this page ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Appliances_ListBySubscription (updated)
Description :  Gets a list of Appliances in the specified subscription. The operation returns properties of each Appliance
Reference :  Link ¶

⚶ Changes

{
  "#id": "Appliances_ListBySubscription",
  "$responses": {
    "200": {
      "Description": {
        "new": "Paged collection of Appliance items",
        "old": "The List Appliances operation response."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Appliance items on this page",
            "old": "The list of Appliances."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL to use for getting the next set of results."
          }
        }
      ]
    }
  }
}

⚼ 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)

{
value:
{
Description: The Appliance items on this page ,
Required: True ,
}
[
{
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 ,
}
,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Appliances_ListByResourceGroup (updated)
Description :  Gets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Appliances_ListByResourceGroup",
  "$responses": {
    "200": {
      "Description": {
        "new": "Paged collection of Appliance items",
        "old": "The List Appliances operation response."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Appliance items on this page",
            "old": "The list of Appliances."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL to use for getting the next set of results."
          }
        }
      ]
    }
  }
}

⚼ 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)

{
value:
{
Description: The Appliance items on this page ,
Required: True ,
}
[
{
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 ,
}
,
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 ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}