Get Setting - Get Setting

Service:

Key Vault

API Version:

7.4

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

GET {vaultBaseUrl}/settings/{setting-name}?api-version=7.4

URI Parameters

Name	In	Required	Type	Description
setting-name	path	True	string	The name of the account setting. Must be a valid settings option.
vaultBaseUrl	path	True	string	The vault name, for example https://myvault.vault.azure.net.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	Setting	An account setting containing the name of the setting and the value it is set to.
Other Status Codes	KeyVaultError	Key Vault error response describing why the operation failed.

Examples

GetSetting

Sample Request

HTTP

GET https://myvault.vault.azure.net//settings/AllowKeyManagementOperationsThroughARM?api-version=7.4

Sample Response

Status code:

200

{
  "name": "AllowKeyManagementOperationsThroughARM",
  "value": "true",
  "type": "boolean"
}

Definitions

Name	Description
Error	The key vault server error.
KeyVaultError	The key vault error exception.
Setting
SettingTypeEnum	The type specifier of the value.

Error

The key vault server error.

Name	Type	Description
code	string	The error code.
innererror	Error	The key vault server error.
message	string	The error message.

KeyVaultError

The key vault error exception.

Name	Type	Description
error	Error	The key vault server error.

Setting

Name	Type	Description
name	string	The account setting to be updated
type	SettingTypeEnum	The type specifier of the value.
value	string	The value of the pool setting.

SettingTypeEnum

The type specifier of the value.

Name	Type	Description
boolean	string