Skip to content

Sync operation and attributes descriptions with 7.3 #21119

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.

Sign up for GitHub

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
heaths merged 8 commits into from
Oct 13, 2022
Merged

Sync operation and attributes descriptions with 7.3 #21119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4694d8a
Sync operation and attributes descriptions with 7.3
jlichwa Oct 13, 2022
502df59
Update certificates.json
jlichwa Oct 13, 2022
141b16b
Update secrets.json
jlichwa Oct 13, 2022
bd5980b
Update storage.json
jlichwa Oct 13, 2022
e5319e9
Update keys.json
jlichwa Oct 13, 2022
ee62352
Update keys.json
heaths Oct 13, 2022
18f9d15
Remove duplicate double quotes
heaths Oct 13, 2022
f159102
Remove duplicate description from certificates.json
heaths Oct 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/certificates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@
"in": "path",
"required": true,
"type": "string",
"description": "The name of the issuer."
"description": "The name of the issuer. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information."
},
{
"name": "parameter",
Expand Down Expand Up @@ -469,7 +469,7 @@
"required": true,
"type": "string",
"pattern": "^[0-9a-zA-Z-]+$",
"description": "The name of the certificate."
"description": "The name of the certificate. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information."
},
{
"name": "parameters",
Expand Down Expand Up @@ -521,7 +521,7 @@
"required": true,
"type": "string",
"pattern": "^[0-9a-zA-Z-]+$",
"description": "The name of the certificate."
"description": "The name of the certificate. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information."
},
{
"name": "parameters",
Expand Down Expand Up @@ -1557,6 +1557,7 @@
},
"key_usage": {
"type": "array",
"description": "Defines how the certificate's key may be used.",
"items": {
"type": "string",
"enum": [
Expand All @@ -1574,8 +1575,7 @@
"name": "KeyUsageType",
"modelAsString": true
}
},
"description": "List of key usages."
}
},
"validity_months": {
"x-ms-client-name": "ValidityInMonths",
Expand Down
23 changes: 12 additions & 11 deletions specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/keys.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"required": true,
"type": "string",
"pattern": "^[0-9a-zA-Z-]+$",
"description": "The name for the new key. The system will generate the version name for the new key."
"description": "The name for the new key. The system will generate the version name for the new key. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information."
},
{
"name": "parameters",
Expand Down Expand Up @@ -136,7 +136,7 @@
"required": true,
"type": "string",
"pattern": "^[0-9a-zA-Z-]+$",
"description": "Name for the imported key."
"description": "Name for the imported key. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information."
},
{
"name": "parameters",
Expand Down Expand Up @@ -567,7 +567,7 @@
],
"operationId": "decrypt",
"summary": "Decrypts a single block of encrypted data.",
"description": "The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/decrypt permission.",
"description": "The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/decrypt permission. Microsoft recommends not to use CBC algorithms for decryption without first ensuring the integrity of the ciphertext using an HMAC, for example. See https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode for more information.",
"parameters": [
{
"name": "key-name",
Expand Down Expand Up @@ -889,7 +889,7 @@
],
"responses": {
"200": {
"description": "A key bundle containing the key and its attributes.",
"description": "A JWS containing the key, its attributes, the result of the key release, and information about the request.",
"schema": {
"$ref": "#/definitions/KeyReleaseResult"
}
Expand Down Expand Up @@ -1248,12 +1248,13 @@
"type": "boolean"
},
"data": {
"description": "Blob encoding the policy rules under which the key can be released.",
"description": "Blob encoding the policy rules under which the key can be released. Blob must be base64 URL encoded.",
"type": "string",
"format": "base64url",
"x-ms-client-name": "encodedPolicy"
}
}
},
"description": "The policy rules under which the key can be exported."
},
"JsonWebKey": {
"properties": {
Expand Down Expand Up @@ -1488,7 +1489,7 @@
},
"exportable": {
"type": "boolean",
"description": "Indicates if the private key can be exported."
"description": "Indicates if the private key can be exported. Release policy must be provided when creating the first version of an exportable key."
}
},
"description": "The attributes of a key managed by the key vault service."
Expand Down Expand Up @@ -1604,7 +1605,7 @@
"properties": {
"exportable": {
"type": "boolean",
"description": "Indicates if the private key can be exported."
"description": "Indicates if the private key can be exported. Release policy must be provided when creating the first version of an exportable key."
},
"kty": {
"x-ms-client-name": "keyType",
Expand Down Expand Up @@ -1871,7 +1872,7 @@
"iv": {
"type": "string",
"format": "base64url",
"description": "Initialization vector for symmetric algorithms."
"description": "Cryptographically random, non-repeating initialization vector for symmetric algorithms."
},
"aad": {
"type": "string",
Expand Down Expand Up @@ -2207,11 +2208,11 @@
"properties": {
"timeAfterCreate": {
"type": "string",
"description": "Time after creation to attempt rotate. It will be in ISO 8601 format. Example: 90 days : \"P90D\" "
"description": "Time after creation to attempt to rotate. It only applies to rotate. It will be in ISO 8601 duration format. Example: 90 days : \"P90D\" "
},
"timeBeforeExpiry": {
"type": "string",
"description": "Time before expiry to attempt rotate. It will be in ISO 8601 format. Example: 90 days : \"P90D\""
"description": "Time before expiry to attempt to rotate or notify. It will be in ISO 8601 duration format. Example: 90 days : \"P90D\""
}
},
"description": "A condition to be satisfied for an action to be executed."
Expand Down
2 changes: 1 addition & 1 deletion specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/secrets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"required": true,
"type": "string",
"pattern": "^[0-9a-zA-Z-]+$",
"description": "The name of the secret."
"description": "The name of the secret. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information."
},
{
"name": "parameters",
Expand Down
4 changes: 2 additions & 2 deletions specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/storage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,7 @@
"required": true,
"type": "string",
"pattern": "^[0-9a-zA-Z]+$",
"description": "The name of the storage account."
"description": "The name of the storage account. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information."
},
{
"name": "parameters",
Expand Down Expand Up @@ -880,7 +880,7 @@
"required": true,
"type": "string",
"pattern": "^[0-9a-zA-Z]+$",
"description": "The name of the SAS definition."
"description": "The name of the SAS definition. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information."
},
{
"name": "parameters",
Expand Down