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

2025/11/21 • 5 updated methods

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": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "status",
                "Description": {
                  "new": "Appliance\u2019s health and state of connection to on-prem. This list of values is not exhaustive.",
                  "old": "Appliance\u2019s health and state of connection to on-prem"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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. This list of values is not exhaustive. ,
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": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "status",
                "Description": {
                  "new": "Appliance\u2019s health and state of connection to on-prem. This list of values is not exhaustive.",
                  "old": "Appliance\u2019s health and state of connection to on-prem"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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. This list of values is not exhaustive. ,
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_Get (updated)
Description :  Gets the details of an Appliance with a specified resource group and name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Appliances_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "status",
            "Description": {
              "new": "Appliance\u2019s health and state of connection to on-prem. This list of values is not exhaustive.",
              "old": "Appliance\u2019s health and state of connection to on-prem"
            }
          }
        ]
      }
    }
  }
}

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

{
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. This list of values is not exhaustive. ,
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 ,
}
,
}

⚐ 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 (updated)
Description :  Creates or updates an Appliance in the specified Subscription and Resource Group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Appliances_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "status",
            "Description": {
              "new": "Appliance\u2019s health and state of connection to on-prem. This list of values is not exhaustive.",
              "old": "Appliance\u2019s health and state of connection to on-prem"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "status",
            "Description": {
              "new": "Appliance\u2019s health and state of connection to on-prem. This list of values is not exhaustive.",
              "old": "Appliance\u2019s health and state of connection to on-prem"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "status",
            "Description": {
              "new": "Appliance\u2019s health and state of connection to on-prem. This list of values is not exhaustive.",
              "old": "Appliance\u2019s health and state of connection to on-prem"
            }
          }
        ]
      }
    }
  }
}

⚼ 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 ,
}
{
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. This list of values is not exhaustive. ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
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. This list of values is not exhaustive. ,
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 ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Appliances definition. ,
}
{
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. This list of values is not exhaustive. ,
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 ,
}
,
}
,
}

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

⚶ Changes

{
  "#id": "Appliances_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "status",
            "Description": {
              "new": "Appliance\u2019s health and state of connection to on-prem. This list of values is not exhaustive.",
              "old": "Appliance\u2019s health and state of connection to on-prem"
            }
          }
        ]
      }
    }
  }
}

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

{
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. This list of values is not exhaustive. ,
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 ,
}
,
}

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