configuration_stores_keys
Creates, updates, deletes, gets or lists a configuration_stores_keys
resource.
Overview
Name | configuration_stores_keys |
Type | Resource |
Id | azure.app_configuration.configuration_stores_keys |
Fields
The following fields are returned by SELECT
queries:
- list
The request was successful; the request was well-formed and received properly.
Name | Datatype | Description |
---|---|---|
id | string | The key ID. |
name | string | A name for the key describing its usage. |
connectionString | string | A connection string that can be used by supporting clients for authentication. |
lastModified | string (date-time) | The last time any of the key's properties were modified. |
readOnly | boolean | Whether this key can only be used for read operations. |
value | string | The value of the key that is used for authentication purposes. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
list | select | subscriptionId , resourceGroupName , configStoreName | $skipToken | Lists the access key for the specified configuration store. |
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 |
---|---|---|
configStoreName | string | The name of the configuration store. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
$skipToken | string | A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. |
SELECT
examples
- list
Lists the access key for the specified configuration store.
SELECT
id,
name,
connectionString,
lastModified,
readOnly,
value
FROM azure.app_configuration.configuration_stores_keys
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND configStoreName = '{{ configStoreName }}' -- required
AND $skipToken = '{{ $skipToken }}'
;