appliances

Creates, updates, deletes, gets or lists an appliances resource.

Overview

Name	appliances
Type	Resource
Id	azure.resource_connector.appliances

Fields

The following fields are returned by SELECT queries:

get_upgrade_graph

Name	Datatype	Description
id	string	The appliance resource path.
name	string	The release train name.
applianceVersion	string	The current appliance version.
supportedVersions	array	This contains the current version and supported upgrade versions.

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
distro	string	Represents a supported Fabric/Infra. (AKSEdge etc...). "AKSEdge" (AKSEdge)
events	array	A list of events that occurred on the Appliance to relay information to the user.
identity	object	Identity for the resource.
infrastructureConfig	object	Contains infrastructure information about the Appliance.
location	string	The geo-location where the resource lives. Required.
networkProfile	object	Contains network information about the Appliance.
provisioningState	string	The current deployment or provisioning state, which only appears in the response.
publicKey	string	Certificates pair used to download MSI certificate from HIS. Can only be set once.
status	string	Appliance’s health and state of connection to on-prem. This list of values is not exhaustive. Known values are: "WaitingForHeartbeat", "Validating", "Connecting", "Connected", "Running", "PreparingForUpgrade", "ETCDSnapshotFailed", "UpgradePrerequisitesCompleted", "ValidatingSFSConnectivity", "ValidatingImageDownload", "ValidatingImageUpload", "ValidatingETCDHealth", "PreUpgrade", "UpgradingKVAIO", "WaitingForKVAIO", "ImagePending", "ImageProvisioning", "ImageProvisioned", "ImageDownloading", "ImageDownloaded", "ImageDeprovisioning", "ImageUnknown", "UpdatingCloudOperator", "WaitingForCloudOperator", "UpdatingCAPI", "UpdatingCluster", "PostUpgrade", "UpgradeComplete", "UpgradeClusterExtensionFailedToDelete", "UpgradeFailed", "Offline", "None", "NetworkProxyUpdatePreparing", "NetworkProxyUpdating", "NetworkProxyUpdateComplete", "NetworkProxyUpdateFailed", "NetworkDNSUpdatePreparing", "NetworkDNSUpdating", "NetworkDNSUpdateComplete", "NetworkDNSUpdateFailed", "ArcGatewayUpdatePreparing", "ArcGatewayUpdating", "ArcGatewayUpdateComplete", and "ArcGatewayUpdateFailed". (WaitingForHeartbeat, Validating, Connecting, Connected, Running, PreparingForUpgrade, ETCDSnapshotFailed, UpgradePrerequisitesCompleted, ValidatingSFSConnectivity, ValidatingImageDownload, ValidatingImageUpload, ValidatingETCDHealth, PreUpgrade, UpgradingKVAIO, WaitingForKVAIO, ImagePending, ImageProvisioning, ImageProvisioned, ImageDownloading, ImageDownloaded, ImageDeprovisioning, ImageUnknown, UpdatingCloudOperator, WaitingForCloudOperator, UpdatingCAPI, UpdatingCluster, PostUpgrade, UpgradeComplete, UpgradeClusterExtensionFailedToDelete, UpgradeFailed, Offline, None, NetworkProxyUpdatePreparing, NetworkProxyUpdating, NetworkProxyUpdateComplete, NetworkProxyUpdateFailed, NetworkDNSUpdatePreparing, NetworkDNSUpdating, NetworkDNSUpdateComplete, NetworkDNSUpdateFailed, ArcGatewayUpdatePreparing, ArcGatewayUpdating, ArcGatewayUpdateComplete, ArcGatewayUpdateFailed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the Appliance.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
distro	string	Represents a supported Fabric/Infra. (AKSEdge etc...). "AKSEdge" (AKSEdge)
events	array	A list of events that occurred on the Appliance to relay information to the user.
identity	object	Identity for the resource.
infrastructureConfig	object	Contains infrastructure information about the Appliance.
location	string	The geo-location where the resource lives. Required.
networkProfile	object	Contains network information about the Appliance.
provisioningState	string	The current deployment or provisioning state, which only appears in the response.
publicKey	string	Certificates pair used to download MSI certificate from HIS. Can only be set once.
status	string	Appliance’s health and state of connection to on-prem. This list of values is not exhaustive. Known values are: "WaitingForHeartbeat", "Validating", "Connecting", "Connected", "Running", "PreparingForUpgrade", "ETCDSnapshotFailed", "UpgradePrerequisitesCompleted", "ValidatingSFSConnectivity", "ValidatingImageDownload", "ValidatingImageUpload", "ValidatingETCDHealth", "PreUpgrade", "UpgradingKVAIO", "WaitingForKVAIO", "ImagePending", "ImageProvisioning", "ImageProvisioned", "ImageDownloading", "ImageDownloaded", "ImageDeprovisioning", "ImageUnknown", "UpdatingCloudOperator", "WaitingForCloudOperator", "UpdatingCAPI", "UpdatingCluster", "PostUpgrade", "UpgradeComplete", "UpgradeClusterExtensionFailedToDelete", "UpgradeFailed", "Offline", "None", "NetworkProxyUpdatePreparing", "NetworkProxyUpdating", "NetworkProxyUpdateComplete", "NetworkProxyUpdateFailed", "NetworkDNSUpdatePreparing", "NetworkDNSUpdating", "NetworkDNSUpdateComplete", "NetworkDNSUpdateFailed", "ArcGatewayUpdatePreparing", "ArcGatewayUpdating", "ArcGatewayUpdateComplete", and "ArcGatewayUpdateFailed". (WaitingForHeartbeat, Validating, Connecting, Connected, Running, PreparingForUpgrade, ETCDSnapshotFailed, UpgradePrerequisitesCompleted, ValidatingSFSConnectivity, ValidatingImageDownload, ValidatingImageUpload, ValidatingETCDHealth, PreUpgrade, UpgradingKVAIO, WaitingForKVAIO, ImagePending, ImageProvisioning, ImageProvisioned, ImageDownloading, ImageDownloaded, ImageDeprovisioning, ImageUnknown, UpdatingCloudOperator, WaitingForCloudOperator, UpdatingCAPI, UpdatingCluster, PostUpgrade, UpgradeComplete, UpgradeClusterExtensionFailedToDelete, UpgradeFailed, Offline, None, NetworkProxyUpdatePreparing, NetworkProxyUpdating, NetworkProxyUpdateComplete, NetworkProxyUpdateFailed, NetworkDNSUpdatePreparing, NetworkDNSUpdating, NetworkDNSUpdateComplete, NetworkDNSUpdateFailed, ArcGatewayUpdatePreparing, ArcGatewayUpdating, ArcGatewayUpdateComplete, ArcGatewayUpdateFailed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the Appliance.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
distro	string	Represents a supported Fabric/Infra. (AKSEdge etc...). "AKSEdge" (AKSEdge)
events	array	A list of events that occurred on the Appliance to relay information to the user.
identity	object	Identity for the resource.
infrastructureConfig	object	Contains infrastructure information about the Appliance.
location	string	The geo-location where the resource lives. Required.
networkProfile	object	Contains network information about the Appliance.
provisioningState	string	The current deployment or provisioning state, which only appears in the response.
publicKey	string	Certificates pair used to download MSI certificate from HIS. Can only be set once.
status	string	Appliance’s health and state of connection to on-prem. This list of values is not exhaustive. Known values are: "WaitingForHeartbeat", "Validating", "Connecting", "Connected", "Running", "PreparingForUpgrade", "ETCDSnapshotFailed", "UpgradePrerequisitesCompleted", "ValidatingSFSConnectivity", "ValidatingImageDownload", "ValidatingImageUpload", "ValidatingETCDHealth", "PreUpgrade", "UpgradingKVAIO", "WaitingForKVAIO", "ImagePending", "ImageProvisioning", "ImageProvisioned", "ImageDownloading", "ImageDownloaded", "ImageDeprovisioning", "ImageUnknown", "UpdatingCloudOperator", "WaitingForCloudOperator", "UpdatingCAPI", "UpdatingCluster", "PostUpgrade", "UpgradeComplete", "UpgradeClusterExtensionFailedToDelete", "UpgradeFailed", "Offline", "None", "NetworkProxyUpdatePreparing", "NetworkProxyUpdating", "NetworkProxyUpdateComplete", "NetworkProxyUpdateFailed", "NetworkDNSUpdatePreparing", "NetworkDNSUpdating", "NetworkDNSUpdateComplete", "NetworkDNSUpdateFailed", "ArcGatewayUpdatePreparing", "ArcGatewayUpdating", "ArcGatewayUpdateComplete", and "ArcGatewayUpdateFailed". (WaitingForHeartbeat, Validating, Connecting, Connected, Running, PreparingForUpgrade, ETCDSnapshotFailed, UpgradePrerequisitesCompleted, ValidatingSFSConnectivity, ValidatingImageDownload, ValidatingImageUpload, ValidatingETCDHealth, PreUpgrade, UpgradingKVAIO, WaitingForKVAIO, ImagePending, ImageProvisioning, ImageProvisioned, ImageDownloading, ImageDownloaded, ImageDeprovisioning, ImageUnknown, UpdatingCloudOperator, WaitingForCloudOperator, UpdatingCAPI, UpdatingCluster, PostUpgrade, UpgradeComplete, UpgradeClusterExtensionFailedToDelete, UpgradeFailed, Offline, None, NetworkProxyUpdatePreparing, NetworkProxyUpdating, NetworkProxyUpdateComplete, NetworkProxyUpdateFailed, NetworkDNSUpdatePreparing, NetworkDNSUpdating, NetworkDNSUpdateComplete, NetworkDNSUpdateFailed, ArcGatewayUpdatePreparing, ArcGatewayUpdating, ArcGatewayUpdateComplete, ArcGatewayUpdateFailed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the Appliance.

list_operations

Name	Datatype	Description
name	string	The name of the compute operation.
display	object	Describes the properties of an Appliances Operation Value Display.
isDataAction	boolean	Is this Operation a data plane operation.
origin	string	The origin of the compute operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_upgrade_graph	select	resource_group_name, resource_name, upgrade_graph, subscription_id		Gets an Appliance upgrade graph. Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train.
get	select	resource_group_name, resource_name, subscription_id		Gets an Appliance. Gets the details of an Appliance with a specified resource group and name.
list_by_resource_group	select	resource_group_name, subscription_id		Gets a list of Appliances in the specified subscription and resource group. Gets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance.
list_by_subscription	select	subscription_id		Gets a list of Appliances in a subscription. Gets a list of Appliances in the specified subscription. The operation returns properties of each Appliance.
list_operations	select			Lists all available Appliances operations.
create_or_update	insert	resource_group_name, resource_name, subscription_id, location		Creates or updates an Appliance. Creates or updates an Appliance in the specified Subscription and Resource Group.
update	update	resource_group_name, resource_name, subscription_id		Updates an Appliance. Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription.
create_or_update	replace	resource_group_name, resource_name, subscription_id, location		Creates or updates an Appliance. Creates or updates an Appliance in the specified Subscription and Resource Group.
delete	delete	resource_group_name, resource_name, subscription_id		Deletes an Appliance. Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.
list_cluster_user_credential	exec	resource_group_name, resource_name, subscription_id		Returns the cluster user credential. Returns the cluster user credentials for the dedicated appliance.
list_keys	exec	resource_group_name, resource_name, subscription_id	artifactType	Gets the management config. Returns the cluster customer credentials for the dedicated appliance.
get_telemetry_config	exec	subscription_id		Gets the telemetry config. Gets the telemetry config.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	Appliances name. Required.
subscription_id	string
upgrade_graph	string	Upgrade graph version, ex - stable. Required.
artifactType	string	This sets the type of artifact being returned, when empty no artifact endpoint is returned. Default value is None.

SELECT examples

get_upgrade_graph

Gets an Appliance upgrade graph. Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train.

SELECT
id,
name,
applianceVersion,
supportedVersions
FROM azure.resource_connector.appliances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND upgrade_graph = '{{ upgrade_graph }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets an Appliance. Gets the details of an Appliance with a specified resource group and name.

SELECT
id,
name,
distro,
events,
identity,
infrastructureConfig,
location,
networkProfile,
provisioningState,
publicKey,
status,
systemData,
tags,
type,
version
FROM azure.resource_connector.appliances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of Appliances in the specified subscription and resource group. Gets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance.

SELECT
id,
name,
distro,
events,
identity,
infrastructureConfig,
location,
networkProfile,
provisioningState,
publicKey,
status,
systemData,
tags,
type,
version
FROM azure.resource_connector.appliances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets a list of Appliances in a subscription. Gets a list of Appliances in the specified subscription. The operation returns properties of each Appliance.

SELECT
id,
name,
distro,
events,
identity,
infrastructureConfig,
location,
networkProfile,
provisioningState,
publicKey,
status,
systemData,
tags,
type,
version
FROM azure.resource_connector.appliances
WHERE subscription_id = '{{ subscription_id }}' -- required
;

list_operations

Lists all available Appliances operations.

SELECT
name,
display,
isDataAction,
origin
FROM azure.resource_connector.appliances
;

INSERT examples

create_or_update

Creates or updates an Appliance. Creates or updates an Appliance in the specified Subscription and Resource Group.

INSERT INTO azure.resource_connector.appliances (
tags,
location,
properties,
identity,
resource_group_name,
resource_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: appliances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the appliances resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the appliances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the appliances resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The set of properties specific to an Appliance.
    value:
      distro: "{{ distro }}"
      infrastructureConfig:
        provider: "{{ provider }}"
      provisioningState: "{{ provisioningState }}"
      publicKey: "{{ publicKey }}"
      status: "{{ status }}"
      version: "{{ version }}"
      events:
        - type: "{{ type }}"
          code: "{{ code }}"
          status: "{{ status }}"
          message: "{{ message }}"
          severity: "{{ severity }}"
          timestamp: "{{ timestamp }}"
      networkProfile:
        proxyConfiguration:
          version: "{{ version }}"
        dnsConfiguration:
          version: "{{ version }}"
        gatewayConfiguration:
          version: "{{ version }}"
  - name: identity
    description: |
      Identity for the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"

UPDATE examples

update

Updates an Appliance. Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription.

UPDATE azure.resource_connector.appliances
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an Appliance. Creates or updates an Appliance in the specified Subscription and Resource Group.

REPLACE azure.resource_connector.appliances
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes an Appliance. Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.

DELETE FROM azure.resource_connector.appliances
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_cluster_user_credential

Returns the cluster user credential. Returns the cluster user credentials for the dedicated appliance.

EXEC azure.resource_connector.appliances.list_cluster_user_credential 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_keys

Gets the management config. Returns the cluster customer credentials for the dedicated appliance.

EXEC azure.resource_connector.appliances.list_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@artifactType='{{ artifactType }}'
;

get_telemetry_config

Gets the telemetry config. Gets the telemetry config.

EXEC azure.resource_connector.appliances.get_telemetry_config 
@subscription_id='{{ subscription_id }}' --required
;