appliances_keys
Creates, updates, deletes, gets or lists an appliances_keys resource.
Overview
| Name | appliances_keys |
| Type | Resource |
| Id | azure.resource_connector.appliances_keys |
Fields
The following fields are returned by SELECT queries:
- list
| Name | Datatype | Description |
|---|---|---|
artifactProfiles | object | Map of artifacts that contains a list of ArtifactProfile used to upload artifacts such as logs. |
kubeconfigs | array | The list of appliance kubeconfigs. |
sshKeys | object | Map of Customer User Public, Private SSH Keys and Certificate when available. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | subscriptionId, resourceGroupName, resourceName | artifactType | Returns the cluster customer credentials for the dedicated appliance. |
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 |
|---|---|---|
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
resourceName | string | Appliances name. |
subscriptionId | string | The ID of the target subscription. |
artifactType | string | This sets the type of artifact being returned, when empty no artifact endpoint is returned. |
SELECT examples
- list
Returns the cluster customer credentials for the dedicated appliance.
SELECT
artifactProfiles,
kubeconfigs,
sshKeys
FROM azure.resource_connector.appliances_keys
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND artifactType = '{{ artifactType }}'
;