settings

Creates, updates, deletes, gets or lists a settings resource.

Overview

Name	settings
Type	Resource
Id	azure.key_vault_administration.settings

Fields

The following fields are returned by SELECT queries:

get_setting

Name	Datatype	Description
name	string	The account setting to be updated. Required.
type	string	The type specifier of the value. "boolean" (boolean)
value	string	The value of the pool setting. Required.

get_settings

Name	Datatype	Description
settings	array	A response message containing a list of account settings with their associated value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_setting	select	setting_name, vault_base_url		Get specified account setting object. Retrieves the setting object of a specified setting name.
get_settings	select	vault_base_url		List account settings. Retrieves a list of all the available account settings that can be configured.
update_setting	update	setting_name, vault_base_url, value		Updates key vault account setting, stores it, then returns the setting name and value to the client. Description of the pool setting to be updated.

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
setting_name	string	The name of the account setting. Must be a valid settings option. Required.
vault_base_url	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client vaultBaseUrl parameter. (default: )

SELECT examples

get_setting

Get specified account setting object. Retrieves the setting object of a specified setting name.

SELECT
name,
type,
value
FROM azure.key_vault_administration.settings
WHERE setting_name = '{{ setting_name }}' -- required
AND vault_base_url = '{{ vault_base_url }}' -- required
;

get_settings

List account settings. Retrieves a list of all the available account settings that can be configured.

SELECT
settings
FROM azure.key_vault_administration.settings
WHERE vault_base_url = '{{ vault_base_url }}' -- required
;

UPDATE examples

update_setting

Updates key vault account setting, stores it, then returns the setting name and value to the client. Description of the pool setting to be updated.

UPDATE azure.key_vault_administration.settings
SET 
value = '{{ value }}'
WHERE 
setting_name = '{{ setting_name }}' --required
AND vault_base_url = '{{ vault_base_url }}' --required
AND value = '{{ value }}' --required
RETURNING
name,
type,
value;