-
Notifications
You must be signed in to change notification settings - Fork 5.8k
settings-specs #20937
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
lmazuel
merged 23 commits into
Azure:dev-keyvault-Microsoft.KeyVault-7.4-preview
from
maddiemlucas:settings-api-spec
Oct 12, 2022
Merged
settings-specs #20937
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
2dc1c0c
settings-specs
maddiemlucas b4b5334
my embarrassing typo errors
maddiemlucas f959490
pr feedback changes
maddiemlucas 807da21
description change
maddiemlucas c72eb60
setting name param
maddiemlucas 4746808
type specifier
maddiemlucas c2e1648
modelAsString
maddiemlucas 2ae65f4
only support at
maddiemlucas 4de6b64
reference in readme
maddiemlucas 48707ae
prettier fixes
maddiemlucas 5a02c14
fixes
maddiemlucas d5f27a6
prettier
maddiemlucas bf6fe64
lint fixes
maddiemlucas c0eef96
ran prettier
maddiemlucas 69b4dda
lint fix
maddiemlucas 213b51b
prettier on common.json
maddiemlucas 81e120f
remove from common.json
maddiemlucas b91baf2
make all APIVersionParams equal
maddiemlucas e7a1062
fix breaking change
maddiemlucas 433d296
setting name
maddiemlucas 5aab6fc
setting name param
maddiemlucas d60152b
Make ApiVersionParameter global
heaths 109c3e1
Merge securitydomain.json changes from stable/7.3
heaths File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
21 changes: 21 additions & 0 deletions
21
...lt/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/ListSettings-example.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| { | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "api-version": "7.4-preview.1" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "value": [ | ||
| { | ||
| "name": "AllowKeyManagementOperationsThroughARM", | ||
| "value": "true", | ||
| "description": "If false, all key management operations must happen through the Managed HSM data plane. If true, allows users to manage keys via the Azure Resource Manager." | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
26 changes: 26 additions & 0 deletions
26
...t/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/UpdateSetting-example.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| { | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "setting-name": "AllowKeyManagementOperationsThroughARM", | ||
| "api-version": "7.4-preview.1", | ||
| "parameters": { | ||
| "value":"true" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "value": [ | ||
| { | ||
| "name": "AllowKeyManagementOperationsThroughARM", | ||
| "value": "true", | ||
| "description": "If false, all key management operations must happen through the Managed HSM data plane. If true, allows users to manage keys via the Azure Resource Manager." | ||
|
|
||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
208 changes: 208 additions & 0 deletions
208
specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/settings.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,208 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "KeyVaultClient", | ||
| "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", | ||
| "version": "7.4-preview.1" | ||
| }, | ||
| "x-ms-parameterized-host": { | ||
| "hostTemplate": "{vaultBaseUrl}", | ||
| "useSchemePrefix": false, | ||
| "positionInOperation": "first", | ||
| "parameters": [ | ||
| { | ||
| "name": "vaultBaseUrl", | ||
| "description": "The vault name, for example https://myvault.vault.azure.net.", | ||
| "required": true, | ||
| "type": "string", | ||
| "in": "path", | ||
| "x-ms-skip-url-encoding": true | ||
|
|
||
| } | ||
| ] | ||
| }, | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "paths": { | ||
| "/settings/{setting-name}": { | ||
| "patch": { | ||
| "tags": [ | ||
| "Settings" | ||
| ], | ||
| "operationId": "UpdateSettings", | ||
| "summary": "Updates key vault account setting, stores it, then returns the setting name and value to the client.", | ||
| "description": "If false, all key management operations must happen through the Managed HSM data plane. If true, allows users to manage keys via the Azure Resource Manager.", | ||
| "parameters": [ | ||
| { | ||
| "name": "setting-name", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the account setting. Must be a valid settings option." | ||
| }, | ||
| { | ||
| "name": "parameters", | ||
| "in": "body", | ||
| "required": true, | ||
| "x-ms-client-flatten": true, | ||
| "schema": { | ||
| "$ref": "#/definitions/UpdateSettingsRequest" | ||
|
maddiemlucas marked this conversation as resolved.
Outdated
|
||
| }, | ||
| "description": "The parameters to update an account setting." | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "An account setting containing the name of the setting and the value it is set to. ", | ||
| "schema": { | ||
| "$ref": "#/definitions/Setting" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Key Vault error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "common.json#/definitions/KeyVaultError" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "Create key": { | ||
|
maddiemlucas marked this conversation as resolved.
Outdated
|
||
| "$ref": "./examples/UpdateSetting-example.json" | ||
| } | ||
| } | ||
| }, | ||
| "get": { | ||
| "tags": [ | ||
| "Settings" | ||
| ], | ||
| "operationId": "GetSettingValue", | ||
| "summary": "Get specified account setting value.", | ||
| "description": "Retrieves the value of a specified, value account setting.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
|
maddiemlucas marked this conversation as resolved.
Outdated
|
||
| "responses": { | ||
| "200": { | ||
| "description": "An account setting containing the name of the setting and the value it is set to.", | ||
| "schema": { | ||
| "$ref": "#/definitions/Setting" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Key Vault error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "common.json#/definitions/KeyVaultError" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-pageable": { | ||
| "nextLinkName": "nextLink" | ||
| }, | ||
|
maddiemlucas marked this conversation as resolved.
Outdated
|
||
| "x-ms-examples": { | ||
| "GetKeys": { | ||
|
maddiemlucas marked this conversation as resolved.
Outdated
|
||
| "$ref": "./examples/UpdateSetting-example.json" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/settings": { | ||
| "get": { | ||
| "tags": [ | ||
| "Settings" | ||
| ], | ||
| "operationId": "GetSettings", | ||
| "summary": "List account settings.", | ||
| "description": "Retrieves a list of all the available account settings that can be configured.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "A response message containing a list of account settings with their associated value.", | ||
| "schema": { | ||
| "$ref": "#/definitions/SettingsListResult" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Key Vault error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "common.json#/definitions/KeyVaultError" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-pageable": { | ||
| "nextLinkName": "nextLink" | ||
| }, | ||
| "x-ms-examples": { | ||
| "GetKeys": { | ||
|
maddiemlucas marked this conversation as resolved.
Outdated
|
||
| "$ref": "./examples/ListSettings-example.json" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "UpdateSettingsRequest": { | ||
| "properties": { | ||
| "value": { | ||
| "type": "string", | ||
| "description": "The account setting value. True if setting is enabled, false if disabled" | ||
|
maddiemlucas marked this conversation as resolved.
Outdated
|
||
| } | ||
| }, | ||
| "description": "The update settings request object.", | ||
| "required": [ | ||
| "value" | ||
| ] | ||
| }, | ||
| "Setting": { | ||
| "properties": { | ||
| "name": { | ||
| "type": "string", | ||
| "description": "The account setting to be updated" | ||
| }, | ||
| "value": { | ||
| "type": "string", | ||
| "description": "The account setting value. True if setting is enabled, false if disabled" | ||
|
maddiemlucas marked this conversation as resolved.
Outdated
|
||
| } | ||
| }, | ||
| "required": [ | ||
| "name", | ||
| "value" | ||
| ], | ||
| "description": "The update settings response object containing the setting name and its value." | ||
| }, | ||
| "SettingsListResult": { | ||
| "properties": { | ||
|
maddiemlucas marked this conversation as resolved.
Outdated
|
||
| "value": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/Setting" | ||
| }, | ||
| "readOnly": true, | ||
| "description": "A response message containing a list of account settings with their associated value." | ||
| } | ||
| }, | ||
| "description": "The settings list result." | ||
| } | ||
| }, | ||
| "parameters": { | ||
| "ApiVersionParameter": { | ||
| "name": "api-version", | ||
| "in": "query", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "Client API version." | ||
| } | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.