Merge pull request #130 from fearthecowboy/master
add summary to language.default when summary is on operation
This commit is contained in:
Коммит
0244e1caa0
|
@ -202,7 +202,7 @@ export class Flattener {
|
|||
if (threshold > 0) {
|
||||
// get the count of the (non-readonly) properties in the schema
|
||||
|
||||
flattenOperationPayload = length(values(getAllProperties(schema)).where(property => property.readOnly !== true)) <= threshold;
|
||||
flattenOperationPayload = length(values(getAllProperties(schema)).where(property => property.readOnly !== true && property.schema.type !== SchemaType.Constant)) <= threshold;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
@ -437,6 +437,11 @@ export class ModelerFour {
|
|||
serialization: this.interpret.getSerialization(schema),
|
||||
minProperties: schema.minProperties ? Number(schema.minProperties) : undefined,
|
||||
maxProperties: schema.maxProperties ? Number(schema.maxProperties) : undefined,
|
||||
language: {
|
||||
default: {
|
||||
summary: schema.summary || schema.title
|
||||
}
|
||||
}
|
||||
}));
|
||||
|
||||
// cache this now before we accidentally recurse on this type.
|
||||
|
@ -838,7 +843,12 @@ export class ModelerFour {
|
|||
const opGroup = this.codeModel.getOperationGroup(group);
|
||||
const op = opGroup.addOperation(new Operation(memberName, this.interpret.getDescription('MISSING·OPERATION-DESCRIPTION', operation), {
|
||||
extensions: this.interpret.getExtensionProperties(operation),
|
||||
apiVersions: this.interpret.getApiVersions(pathItem)
|
||||
apiVersions: this.interpret.getApiVersions(pathItem),
|
||||
language: {
|
||||
default: {
|
||||
summary: operation.summary
|
||||
}
|
||||
}
|
||||
}));
|
||||
|
||||
// create $host parameters from servers information.
|
||||
|
|
|
@ -476,6 +476,7 @@ operationGroups:
|
|||
default:
|
||||
name: list
|
||||
description: 'The Products endpoint returns information about the Uber products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order.'
|
||||
summary: Product Types
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -582,6 +583,7 @@ operationGroups:
|
|||
default:
|
||||
name: create
|
||||
description: Resets products.
|
||||
summary: Create products
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -688,6 +690,7 @@ operationGroups:
|
|||
default:
|
||||
name: update
|
||||
description: Resets products.
|
||||
summary: Update products
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
|
@ -476,6 +476,7 @@ operationGroups:
|
|||
default:
|
||||
name: list
|
||||
description: 'The Products endpoint returns information about the Uber products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order.'
|
||||
summary: Product Types
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -569,6 +570,7 @@ operationGroups:
|
|||
default:
|
||||
name: create
|
||||
description: Resets products.
|
||||
summary: Create products
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -662,6 +664,7 @@ operationGroups:
|
|||
default:
|
||||
name: update
|
||||
description: Resets products.
|
||||
summary: Update products
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
|
@ -487,6 +487,7 @@ operationGroups:
|
|||
default:
|
||||
name: list
|
||||
description: 'The Products endpoint returns information about the Uber products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order.'
|
||||
summary: Product Types
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -593,6 +594,7 @@ operationGroups:
|
|||
default:
|
||||
name: create
|
||||
description: Resets products.
|
||||
summary: Create products
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -699,6 +701,7 @@ operationGroups:
|
|||
default:
|
||||
name: update
|
||||
description: Resets products.
|
||||
summary: Update products
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
|
@ -3436,6 +3436,7 @@ operationGroups:
|
|||
default:
|
||||
name: List
|
||||
description: List filesystems and their properties in given account.
|
||||
summary: List Filesystems
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3583,6 +3584,7 @@ operationGroups:
|
|||
default:
|
||||
name: Create
|
||||
description: 'Create a filesystem rooted at the specified location. If the filesystem already exists, the operation fails. This operation does not support conditional HTTP requests.'
|
||||
summary: Create Filesystem
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3752,6 +3754,7 @@ operationGroups:
|
|||
description: >-
|
||||
Set properties for the filesystem. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Set Filesystem Properties
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3889,6 +3892,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetProperties
|
||||
description: All system and user-defined filesystem properties are specified in the response headers.
|
||||
summary: Get Filesystem Properties.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -4040,6 +4044,7 @@ operationGroups:
|
|||
same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or
|
||||
directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for
|
||||
Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Delete Filesystem
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
@ -4251,6 +4256,7 @@ operationGroups:
|
|||
default:
|
||||
name: List
|
||||
description: List filesystem paths and their properties.
|
||||
summary: List Paths
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -4686,6 +4692,7 @@ operationGroups:
|
|||
Create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more
|
||||
information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination
|
||||
already exists, use a conditional request with If-None-Match: "*".
|
||||
summary: Create File | Create Directory | Rename File | Rename Directory
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -5167,6 +5174,7 @@ operationGroups:
|
|||
Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. This
|
||||
operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Append Data | Flush Data | Set Properties | Set Access Control
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -5458,6 +5466,7 @@ operationGroups:
|
|||
description: >-
|
||||
Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Lease Path
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -5792,6 +5801,7 @@ operationGroups:
|
|||
description: >-
|
||||
Read the contents of a file. For read operations, range requests are supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Read File
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -6073,6 +6083,7 @@ operationGroups:
|
|||
Get Properties returns all system and user defined properties for a path. Get Status returns all system defined properties for a path. Get Access Control List returns the access control list for a path. This operation supports
|
||||
conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Get Properties | Get Status | Get Access Control List | Check Access
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -6280,6 +6291,7 @@ operationGroups:
|
|||
description: >-
|
||||
Delete the file or directory. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Delete File | Delete Directory
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
|
@ -3436,6 +3436,7 @@ operationGroups:
|
|||
default:
|
||||
name: List
|
||||
description: List filesystems and their properties in given account.
|
||||
summary: List Filesystems
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3583,6 +3584,7 @@ operationGroups:
|
|||
default:
|
||||
name: Create
|
||||
description: 'Create a filesystem rooted at the specified location. If the filesystem already exists, the operation fails. This operation does not support conditional HTTP requests.'
|
||||
summary: Create Filesystem
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3752,6 +3754,7 @@ operationGroups:
|
|||
description: >-
|
||||
Set properties for the filesystem. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Set Filesystem Properties
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3889,6 +3892,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetProperties
|
||||
description: All system and user-defined filesystem properties are specified in the response headers.
|
||||
summary: Get Filesystem Properties.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -4040,6 +4044,7 @@ operationGroups:
|
|||
same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or
|
||||
directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for
|
||||
Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Delete Filesystem
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
@ -4251,6 +4256,7 @@ operationGroups:
|
|||
default:
|
||||
name: List
|
||||
description: List filesystem paths and their properties.
|
||||
summary: List Paths
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -4686,6 +4692,7 @@ operationGroups:
|
|||
Create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more
|
||||
information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination
|
||||
already exists, use a conditional request with If-None-Match: "*".
|
||||
summary: Create File | Create Directory | Rename File | Rename Directory
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -5167,6 +5174,7 @@ operationGroups:
|
|||
Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. This
|
||||
operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Append Data | Flush Data | Set Properties | Set Access Control
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -5458,6 +5466,7 @@ operationGroups:
|
|||
description: >-
|
||||
Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Lease Path
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -5792,6 +5801,7 @@ operationGroups:
|
|||
description: >-
|
||||
Read the contents of a file. For read operations, range requests are supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Read File
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -6073,6 +6083,7 @@ operationGroups:
|
|||
Get Properties returns all system and user defined properties for a path. Get Status returns all system defined properties for a path. Get Access Control List returns the access control list for a path. This operation supports
|
||||
conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Get Properties | Get Status | Get Access Control List | Check Access
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -6280,6 +6291,7 @@ operationGroups:
|
|||
description: >-
|
||||
Delete the file or directory. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Delete File | Delete Directory
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
|
@ -3452,6 +3452,7 @@ operationGroups:
|
|||
default:
|
||||
name: List
|
||||
description: List filesystems and their properties in given account.
|
||||
summary: List Filesystems
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3599,6 +3600,7 @@ operationGroups:
|
|||
default:
|
||||
name: Create
|
||||
description: 'Create a filesystem rooted at the specified location. If the filesystem already exists, the operation fails. This operation does not support conditional HTTP requests.'
|
||||
summary: Create Filesystem
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3768,6 +3770,7 @@ operationGroups:
|
|||
description: >-
|
||||
Set properties for the filesystem. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Set Filesystem Properties
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3905,6 +3908,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetProperties
|
||||
description: All system and user-defined filesystem properties are specified in the response headers.
|
||||
summary: Get Filesystem Properties.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -4056,6 +4060,7 @@ operationGroups:
|
|||
same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or
|
||||
directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for
|
||||
Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Delete Filesystem
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
@ -4267,6 +4272,7 @@ operationGroups:
|
|||
default:
|
||||
name: List
|
||||
description: List filesystem paths and their properties.
|
||||
summary: List Paths
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -4702,6 +4708,7 @@ operationGroups:
|
|||
Create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more
|
||||
information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination
|
||||
already exists, use a conditional request with If-None-Match: "*".
|
||||
summary: Create File | Create Directory | Rename File | Rename Directory
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -5183,6 +5190,7 @@ operationGroups:
|
|||
Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. This
|
||||
operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Append Data | Flush Data | Set Properties | Set Access Control
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -5474,6 +5482,7 @@ operationGroups:
|
|||
description: >-
|
||||
Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Lease Path
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -5808,6 +5817,7 @@ operationGroups:
|
|||
description: >-
|
||||
Read the contents of a file. For read operations, range requests are supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Read File
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -6089,6 +6099,7 @@ operationGroups:
|
|||
Get Properties returns all system and user defined properties for a path. Get Status returns all system defined properties for a path. Get Access Control List returns the access control list for a path. This operation supports
|
||||
conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Get Properties | Get Status | Get Access Control List | Check Access
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -6296,6 +6307,7 @@ operationGroups:
|
|||
description: >-
|
||||
Delete the file or directory. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service
|
||||
Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).
|
||||
summary: Delete File | Delete Directory
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
|
@ -8780,6 +8780,7 @@ operationGroups:
|
|||
default:
|
||||
name: CreateKey
|
||||
description: 'The create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.'
|
||||
summary: 'Creates a new key, stores it, then returns key parameters and attributes to the client.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -8975,6 +8976,7 @@ operationGroups:
|
|||
default:
|
||||
name: ImportKey
|
||||
description: 'The import key operation may be used to import any key type into an Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission.'
|
||||
summary: 'Imports an externally created key, stores it, and returns key parameters and attributes to the client.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9089,6 +9091,7 @@ operationGroups:
|
|||
description: >-
|
||||
The delete key operation cannot be used to remove individual versions of a key. This operation removes the cryptographic material associated with the key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or
|
||||
Encrypt/Decrypt operations. This operation requires the keys/delete permission.
|
||||
summary: Deletes a key of any type from storage in Azure Key Vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9270,6 +9273,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateKey
|
||||
description: 'In order to perform this operation, the key must already exist in the Key Vault. Note: The cryptographic material of a key itself cannot be changed. This operation requires the keys/update permission.'
|
||||
summary: The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9392,6 +9396,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetKey
|
||||
description: 'The get key operation is applicable to all key types. If the requested key is symmetric, then no key material is released in the response. This operation requires the keys/get permission.'
|
||||
summary: Gets the public part of a stored key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9505,6 +9510,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetKeyVersions
|
||||
description: 'The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.'
|
||||
summary: Retrieves a list of individual key versions with the same key name.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9606,6 +9612,7 @@ operationGroups:
|
|||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags
|
||||
are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.
|
||||
summary: List keys in the specified vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9701,6 +9708,7 @@ operationGroups:
|
|||
Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical
|
||||
boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation
|
||||
requires the key/backup permission.
|
||||
summary: Requests that a backup of the specified key be downloaded to the client.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9836,6 +9844,7 @@ operationGroups:
|
|||
a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key
|
||||
name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security
|
||||
constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.
|
||||
summary: Restores a backed up key to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9992,6 +10001,7 @@ operationGroups:
|
|||
The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the
|
||||
target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the
|
||||
key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.
|
||||
summary: Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10148,6 +10158,7 @@ operationGroups:
|
|||
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.
|
||||
summary: Decrypts a single block of encrypted data.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10301,6 +10312,7 @@ operationGroups:
|
|||
default:
|
||||
name: sign
|
||||
description: The SIGN operation is applicable to asymmetric and symmetric keys stored in Azure Key Vault since this operation uses the private portion of the key. This operation requires the keys/sign permission.
|
||||
summary: Creates a signature from a digest using the specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10467,6 +10479,7 @@ operationGroups:
|
|||
description: >-
|
||||
The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion
|
||||
of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.
|
||||
summary: Verifies a signature using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10623,6 +10636,7 @@ operationGroups:
|
|||
The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault
|
||||
since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the
|
||||
public key material. This operation requires the keys/wrapKey permission.
|
||||
summary: Wraps a symmetric key using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10778,6 +10792,7 @@ operationGroups:
|
|||
description: >-
|
||||
The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP 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/unwrapKey permission.
|
||||
summary: Unwraps a symmetric key using the specified key that was initially used for wrapping that key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10882,6 +10897,7 @@ operationGroups:
|
|||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults
|
||||
enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.
|
||||
summary: Lists the deleted keys in the specified vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10996,6 +11012,7 @@ operationGroups:
|
|||
description: >-
|
||||
The Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the
|
||||
keys/get permission.
|
||||
summary: Gets the public part of a deleted key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11082,6 +11099,7 @@ operationGroups:
|
|||
description: >-
|
||||
The Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the
|
||||
keys/purge permission.
|
||||
summary: Permanently deletes the specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11193,6 +11211,7 @@ operationGroups:
|
|||
description: >-
|
||||
The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error.
|
||||
Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission.
|
||||
summary: Recovers the deleted key to its latest version.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11362,6 +11381,7 @@ operationGroups:
|
|||
default:
|
||||
name: SetSecret
|
||||
description: ' The SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission.'
|
||||
summary: Sets a secret in a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11459,6 +11479,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteSecret
|
||||
description: The DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires the secrets/delete permission.
|
||||
summary: Deletes a secret from a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11633,6 +11654,7 @@ operationGroups:
|
|||
description: >-
|
||||
The UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value of a secret itself cannot be changed. This operation requires the
|
||||
secrets/set permission.
|
||||
summary: Updates the attributes associated with a specified secret in a given key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11741,6 +11763,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetSecret
|
||||
description: The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.
|
||||
summary: Get a specified secret from a given key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11841,6 +11864,7 @@ operationGroups:
|
|||
description: >-
|
||||
The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation
|
||||
requires the secrets/list permission.
|
||||
summary: List secrets in a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11951,6 +11975,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetSecretVersions
|
||||
description: The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.
|
||||
summary: List all versions of the specified secret.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12054,6 +12079,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedSecrets
|
||||
description: The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.
|
||||
summary: Lists deleted secrets for the specified vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12151,6 +12177,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedSecret
|
||||
description: The Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.
|
||||
summary: Gets the specified deleted secret.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12235,6 +12262,7 @@ operationGroups:
|
|||
default:
|
||||
name: PurgeDeletedSecret
|
||||
description: 'The purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.'
|
||||
summary: Permanently deletes the specified secret.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12329,6 +12357,7 @@ operationGroups:
|
|||
default:
|
||||
name: RecoverDeletedSecret
|
||||
description: Recovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission.
|
||||
summary: Recovers the deleted secret to the latest version.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12419,6 +12448,7 @@ operationGroups:
|
|||
default:
|
||||
name: BackupSecret
|
||||
description: Requests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.
|
||||
summary: Backs up the specified secret.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12539,6 +12569,7 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreSecret
|
||||
description: 'Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.'
|
||||
summary: Restores a backed up secret to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12656,6 +12687,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificates
|
||||
description: The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.
|
||||
summary: List certificates in a specified key vault
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12787,6 +12819,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteCertificate
|
||||
description: Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.
|
||||
summary: Deletes a certificate from a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12909,6 +12942,7 @@ operationGroups:
|
|||
default:
|
||||
name: SetCertificateContacts
|
||||
description: Sets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.
|
||||
summary: Sets the certificate contacts for the specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12992,6 +13026,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateContacts
|
||||
description: The GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the certificates/managecontacts permission.
|
||||
summary: Lists the certificate contacts for a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13075,6 +13110,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteCertificateContacts
|
||||
description: Deletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission.
|
||||
summary: Deletes the certificate contacts for a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13171,6 +13207,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateIssuers
|
||||
description: The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.
|
||||
summary: List certificate issuers for a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13357,6 +13394,7 @@ operationGroups:
|
|||
default:
|
||||
name: SetCertificateIssuer
|
||||
description: The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.
|
||||
summary: Sets the specified certificate issuer.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13533,6 +13571,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateCertificateIssuer
|
||||
description: The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission.
|
||||
summary: Updates the specified certificate issuer.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13636,6 +13675,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateIssuer
|
||||
description: The GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.
|
||||
summary: Lists the specified certificate issuer.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13739,6 +13779,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteCertificateIssuer
|
||||
description: The DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers permission.
|
||||
summary: Deletes the specified certificate issuer.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13909,6 +13950,7 @@ operationGroups:
|
|||
default:
|
||||
name: CreateCertificate
|
||||
description: 'If this is the first version, the certificate resource is created. This operation requires the certificates/create permission.'
|
||||
summary: Creates a new certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14136,6 +14178,7 @@ operationGroups:
|
|||
description: >-
|
||||
Imports an existing valid certificate, containing a private key, into Azure Key Vault. The certificate to be imported can be in either PFX or PEM format. If the certificate is in PEM format the PEM file must contain the key as
|
||||
well as x509 certificates. This operation requires the certificates/import permission.
|
||||
summary: Imports a certificate into a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14255,6 +14298,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateVersions
|
||||
description: The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.
|
||||
summary: List the versions of a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14369,6 +14413,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificatePolicy
|
||||
description: The GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get permission.
|
||||
summary: Lists the policy for a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14523,6 +14568,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateCertificatePolicy
|
||||
description: Set specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission.
|
||||
summary: Updates the policy for a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14701,6 +14747,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateCertificate
|
||||
description: The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes. This operation requires the certificates/update permission.
|
||||
summary: Updates the specified attributes associated with the given certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14811,6 +14858,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificate
|
||||
description: Gets information about a specific certificate. This operation requires the certificates/get permission.
|
||||
summary: Gets information about a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14943,6 +14991,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateCertificateOperation
|
||||
description: Updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.
|
||||
summary: Updates a certificate operation.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15040,6 +15089,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateOperation
|
||||
description: Gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.
|
||||
summary: Gets the creation operation of a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15137,6 +15187,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteCertificateOperation
|
||||
description: Deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update permission.
|
||||
summary: Deletes the creation operation for a specific certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15326,6 +15377,7 @@ operationGroups:
|
|||
default:
|
||||
name: MergeCertificate
|
||||
description: The MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation requires the certificates/create permission.
|
||||
summary: Merges a certificate or a certificate chain with a key pair existing on the server.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15416,6 +15468,7 @@ operationGroups:
|
|||
default:
|
||||
name: BackupCertificate
|
||||
description: Requests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires the certificates/backup permission.
|
||||
summary: Backs up the specified certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15571,6 +15624,7 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreCertificate
|
||||
description: 'Restores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.'
|
||||
summary: Restores a backed up certificate to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15688,6 +15742,7 @@ operationGroups:
|
|||
description: >-
|
||||
The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires
|
||||
the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.
|
||||
summary: Lists the deleted certificates in the specified vault currently available for recovery.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15822,6 +15877,7 @@ operationGroups:
|
|||
description: >-
|
||||
The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the
|
||||
certificates/get permission.
|
||||
summary: Retrieves information about the specified deleted certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15908,6 +15964,7 @@ operationGroups:
|
|||
description: >-
|
||||
The PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify 'Purgeable'. This
|
||||
operation requires the certificate/purge permission.
|
||||
summary: Permanently deletes the specified deleted certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16038,6 +16095,7 @@ operationGroups:
|
|||
description: >-
|
||||
The RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must be issued during the retention interval (available in the deleted
|
||||
certificate's attributes). This operation requires the certificates/recover permission.
|
||||
summary: Recovers the deleted certificate back to its current version under /certificates.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16268,6 +16326,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedStorageAccounts
|
||||
description: The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.
|
||||
summary: Lists deleted storage accounts for the specified vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16374,6 +16433,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedStorageAccount
|
||||
description: The Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get permission.
|
||||
summary: Gets the specified deleted storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16462,6 +16522,7 @@ operationGroups:
|
|||
description: >-
|
||||
The purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge
|
||||
permission.
|
||||
summary: Permanently deletes the specified storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16565,6 +16626,7 @@ operationGroups:
|
|||
default:
|
||||
name: RecoverDeletedStorageAccount
|
||||
description: Recovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.
|
||||
summary: Recovers the deleted storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16657,6 +16719,7 @@ operationGroups:
|
|||
default:
|
||||
name: BackupStorageAccount
|
||||
description: Requests that a backup of the specified storage account be downloaded to the client. This operation requires the storage/backup permission.
|
||||
summary: Backs up the specified storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16784,6 +16847,7 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreStorageAccount
|
||||
description: Restores a backed up storage account to a vault. This operation requires the storage/restore permission.
|
||||
summary: Restores a backed up storage account to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -17772,6 +17836,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedSasDefinitions
|
||||
description: The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.
|
||||
summary: Lists deleted SAS definitions for the specified vault and storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -17888,6 +17953,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedSasDefinition
|
||||
description: The Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas permission.
|
||||
summary: Gets the specified deleted sas definition.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -18001,6 +18067,7 @@ operationGroups:
|
|||
default:
|
||||
name: RecoverDeletedSasDefinition
|
||||
description: Recovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.
|
||||
summary: Recovers the deleted SAS definition.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
@ -8701,6 +8701,7 @@ operationGroups:
|
|||
default:
|
||||
name: CreateKey
|
||||
description: 'The create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.'
|
||||
summary: 'Creates a new key, stores it, then returns key parameters and attributes to the client.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -8843,6 +8844,7 @@ operationGroups:
|
|||
default:
|
||||
name: ImportKey
|
||||
description: 'The import key operation may be used to import any key type into an Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission.'
|
||||
summary: 'Imports an externally created key, stores it, and returns key parameters and attributes to the client.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -8957,6 +8959,7 @@ operationGroups:
|
|||
description: >-
|
||||
The delete key operation cannot be used to remove individual versions of a key. This operation removes the cryptographic material associated with the key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or
|
||||
Encrypt/Decrypt operations. This operation requires the keys/delete permission.
|
||||
summary: Deletes a key of any type from storage in Azure Key Vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9101,6 +9104,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateKey
|
||||
description: 'In order to perform this operation, the key must already exist in the Key Vault. Note: The cryptographic material of a key itself cannot be changed. This operation requires the keys/update permission.'
|
||||
summary: The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9223,6 +9227,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetKey
|
||||
description: 'The get key operation is applicable to all key types. If the requested key is symmetric, then no key material is released in the response. This operation requires the keys/get permission.'
|
||||
summary: Gets the public part of a stored key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9336,6 +9341,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetKeyVersions
|
||||
description: 'The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.'
|
||||
summary: Retrieves a list of individual key versions with the same key name.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9437,6 +9443,7 @@ operationGroups:
|
|||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags
|
||||
are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.
|
||||
summary: List keys in the specified vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9532,6 +9539,7 @@ operationGroups:
|
|||
Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical
|
||||
boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation
|
||||
requires the key/backup permission.
|
||||
summary: Requests that a backup of the specified key be downloaded to the client.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9653,6 +9661,7 @@ operationGroups:
|
|||
a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key
|
||||
name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security
|
||||
constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.
|
||||
summary: Restores a backed up key to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9782,6 +9791,7 @@ operationGroups:
|
|||
The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the
|
||||
target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the
|
||||
key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.
|
||||
summary: Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9911,6 +9921,7 @@ operationGroups:
|
|||
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.
|
||||
summary: Decrypts a single block of encrypted data.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10037,6 +10048,7 @@ operationGroups:
|
|||
default:
|
||||
name: sign
|
||||
description: The SIGN operation is applicable to asymmetric and symmetric keys stored in Azure Key Vault since this operation uses the private portion of the key. This operation requires the keys/sign permission.
|
||||
summary: Creates a signature from a digest using the specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10163,6 +10175,7 @@ operationGroups:
|
|||
description: >-
|
||||
The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion
|
||||
of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.
|
||||
summary: Verifies a signature using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10292,6 +10305,7 @@ operationGroups:
|
|||
The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault
|
||||
since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the
|
||||
public key material. This operation requires the keys/wrapKey permission.
|
||||
summary: Wraps a symmetric key using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10420,6 +10434,7 @@ operationGroups:
|
|||
description: >-
|
||||
The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP 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/unwrapKey permission.
|
||||
summary: Unwraps a symmetric key using the specified key that was initially used for wrapping that key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10524,6 +10539,7 @@ operationGroups:
|
|||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults
|
||||
enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.
|
||||
summary: Lists the deleted keys in the specified vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10638,6 +10654,7 @@ operationGroups:
|
|||
description: >-
|
||||
The Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the
|
||||
keys/get permission.
|
||||
summary: Gets the public part of a deleted key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10724,6 +10741,7 @@ operationGroups:
|
|||
description: >-
|
||||
The Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the
|
||||
keys/purge permission.
|
||||
summary: Permanently deletes the specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10835,6 +10853,7 @@ operationGroups:
|
|||
description: >-
|
||||
The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error.
|
||||
Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission.
|
||||
summary: Recovers the deleted key to its latest version.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10951,6 +10970,7 @@ operationGroups:
|
|||
default:
|
||||
name: SetSecret
|
||||
description: ' The SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission.'
|
||||
summary: Sets a secret in a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11048,6 +11068,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteSecret
|
||||
description: The DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires the secrets/delete permission.
|
||||
summary: Deletes a secret from a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11185,6 +11206,7 @@ operationGroups:
|
|||
description: >-
|
||||
The UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value of a secret itself cannot be changed. This operation requires the
|
||||
secrets/set permission.
|
||||
summary: Updates the attributes associated with a specified secret in a given key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11293,6 +11315,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetSecret
|
||||
description: The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.
|
||||
summary: Get a specified secret from a given key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11393,6 +11416,7 @@ operationGroups:
|
|||
description: >-
|
||||
The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation
|
||||
requires the secrets/list permission.
|
||||
summary: List secrets in a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11503,6 +11527,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetSecretVersions
|
||||
description: The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.
|
||||
summary: List all versions of the specified secret.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11606,6 +11631,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedSecrets
|
||||
description: The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.
|
||||
summary: Lists deleted secrets for the specified vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11703,6 +11729,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedSecret
|
||||
description: The Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.
|
||||
summary: Gets the specified deleted secret.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11787,6 +11814,7 @@ operationGroups:
|
|||
default:
|
||||
name: PurgeDeletedSecret
|
||||
description: 'The purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.'
|
||||
summary: Permanently deletes the specified secret.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11881,6 +11909,7 @@ operationGroups:
|
|||
default:
|
||||
name: RecoverDeletedSecret
|
||||
description: Recovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission.
|
||||
summary: Recovers the deleted secret to the latest version.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11971,6 +12000,7 @@ operationGroups:
|
|||
default:
|
||||
name: BackupSecret
|
||||
description: Requests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.
|
||||
summary: Backs up the specified secret.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12077,6 +12107,7 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreSecret
|
||||
description: 'Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.'
|
||||
summary: Restores a backed up secret to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12194,6 +12225,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificates
|
||||
description: The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.
|
||||
summary: List certificates in a specified key vault
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12325,6 +12357,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteCertificate
|
||||
description: Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.
|
||||
summary: Deletes a certificate from a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12434,6 +12467,7 @@ operationGroups:
|
|||
default:
|
||||
name: SetCertificateContacts
|
||||
description: Sets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.
|
||||
summary: Sets the certificate contacts for the specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12517,6 +12551,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateContacts
|
||||
description: The GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the certificates/managecontacts permission.
|
||||
summary: Lists the certificate contacts for a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12600,6 +12635,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteCertificateContacts
|
||||
description: Deletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission.
|
||||
summary: Deletes the certificate contacts for a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12696,6 +12732,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateIssuers
|
||||
description: The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.
|
||||
summary: List certificate issuers for a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12829,6 +12866,7 @@ operationGroups:
|
|||
default:
|
||||
name: SetCertificateIssuer
|
||||
description: The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.
|
||||
summary: Sets the specified certificate issuer.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12956,6 +12994,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateCertificateIssuer
|
||||
description: The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission.
|
||||
summary: Updates the specified certificate issuer.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13059,6 +13098,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateIssuer
|
||||
description: The GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.
|
||||
summary: Lists the specified certificate issuer.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13162,6 +13202,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteCertificateIssuer
|
||||
description: The DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers permission.
|
||||
summary: Deletes the specified certificate issuer.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13295,6 +13336,7 @@ operationGroups:
|
|||
default:
|
||||
name: CreateCertificate
|
||||
description: 'If this is the first version, the certificate resource is created. This operation requires the certificates/create permission.'
|
||||
summary: Creates a new certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13456,6 +13498,7 @@ operationGroups:
|
|||
description: >-
|
||||
Imports an existing valid certificate, containing a private key, into Azure Key Vault. The certificate to be imported can be in either PFX or PEM format. If the certificate is in PEM format the PEM file must contain the key as
|
||||
well as x509 certificates. This operation requires the certificates/import permission.
|
||||
summary: Imports a certificate into a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13575,6 +13618,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateVersions
|
||||
description: The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.
|
||||
summary: List the versions of a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13689,6 +13733,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificatePolicy
|
||||
description: The GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get permission.
|
||||
summary: Lists the policy for a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13843,6 +13888,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateCertificatePolicy
|
||||
description: Set specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission.
|
||||
summary: Updates the policy for a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13984,6 +14030,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateCertificate
|
||||
description: The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes. This operation requires the certificates/update permission.
|
||||
summary: Updates the specified attributes associated with the given certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14094,6 +14141,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificate
|
||||
description: Gets information about a specific certificate. This operation requires the certificates/get permission.
|
||||
summary: Gets information about a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14212,6 +14260,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateCertificateOperation
|
||||
description: Updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.
|
||||
summary: Updates a certificate operation.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14309,6 +14358,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateOperation
|
||||
description: Gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.
|
||||
summary: Gets the creation operation of a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14406,6 +14456,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteCertificateOperation
|
||||
description: Deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update permission.
|
||||
summary: Deletes the creation operation for a specific certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14555,6 +14606,7 @@ operationGroups:
|
|||
default:
|
||||
name: MergeCertificate
|
||||
description: The MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation requires the certificates/create permission.
|
||||
summary: Merges a certificate or a certificate chain with a key pair existing on the server.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14645,6 +14697,7 @@ operationGroups:
|
|||
default:
|
||||
name: BackupCertificate
|
||||
description: Requests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires the certificates/backup permission.
|
||||
summary: Backs up the specified certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14786,6 +14839,7 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreCertificate
|
||||
description: 'Restores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.'
|
||||
summary: Restores a backed up certificate to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14903,6 +14957,7 @@ operationGroups:
|
|||
description: >-
|
||||
The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires
|
||||
the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.
|
||||
summary: Lists the deleted certificates in the specified vault currently available for recovery.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15037,6 +15092,7 @@ operationGroups:
|
|||
description: >-
|
||||
The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the
|
||||
certificates/get permission.
|
||||
summary: Retrieves information about the specified deleted certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15123,6 +15179,7 @@ operationGroups:
|
|||
description: >-
|
||||
The PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify 'Purgeable'. This
|
||||
operation requires the certificate/purge permission.
|
||||
summary: Permanently deletes the specified deleted certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15253,6 +15310,7 @@ operationGroups:
|
|||
description: >-
|
||||
The RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must be issued during the retention interval (available in the deleted
|
||||
certificate's attributes). This operation requires the certificates/recover permission.
|
||||
summary: Recovers the deleted certificate back to its current version under /certificates.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15483,6 +15541,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedStorageAccounts
|
||||
description: The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.
|
||||
summary: Lists deleted storage accounts for the specified vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15589,6 +15648,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedStorageAccount
|
||||
description: The Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get permission.
|
||||
summary: Gets the specified deleted storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15677,6 +15737,7 @@ operationGroups:
|
|||
description: >-
|
||||
The purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge
|
||||
permission.
|
||||
summary: Permanently deletes the specified storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15780,6 +15841,7 @@ operationGroups:
|
|||
default:
|
||||
name: RecoverDeletedStorageAccount
|
||||
description: Recovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.
|
||||
summary: Recovers the deleted storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15872,6 +15934,7 @@ operationGroups:
|
|||
default:
|
||||
name: BackupStorageAccount
|
||||
description: Requests that a backup of the specified storage account be downloaded to the client. This operation requires the storage/backup permission.
|
||||
summary: Backs up the specified storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15985,6 +16048,7 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreStorageAccount
|
||||
description: Restores a backed up storage account to a vault. This operation requires the storage/restore permission.
|
||||
summary: Restores a backed up storage account to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16819,6 +16883,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedSasDefinitions
|
||||
description: The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.
|
||||
summary: Lists deleted SAS definitions for the specified vault and storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16935,6 +17000,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedSasDefinition
|
||||
description: The Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas permission.
|
||||
summary: Gets the specified deleted sas definition.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -17048,6 +17114,7 @@ operationGroups:
|
|||
default:
|
||||
name: RecoverDeletedSasDefinition
|
||||
description: Recovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.
|
||||
summary: Recovers the deleted SAS definition.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
@ -9068,6 +9068,7 @@ operationGroups:
|
|||
default:
|
||||
name: CreateKey
|
||||
description: 'The create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.'
|
||||
summary: 'Creates a new key, stores it, then returns key parameters and attributes to the client.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9263,6 +9264,7 @@ operationGroups:
|
|||
default:
|
||||
name: ImportKey
|
||||
description: 'The import key operation may be used to import any key type into an Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission.'
|
||||
summary: 'Imports an externally created key, stores it, and returns key parameters and attributes to the client.'
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9377,6 +9379,7 @@ operationGroups:
|
|||
description: >-
|
||||
The delete key operation cannot be used to remove individual versions of a key. This operation removes the cryptographic material associated with the key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or
|
||||
Encrypt/Decrypt operations. This operation requires the keys/delete permission.
|
||||
summary: Deletes a key of any type from storage in Azure Key Vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9558,6 +9561,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateKey
|
||||
description: 'In order to perform this operation, the key must already exist in the Key Vault. Note: The cryptographic material of a key itself cannot be changed. This operation requires the keys/update permission.'
|
||||
summary: The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9680,6 +9684,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetKey
|
||||
description: 'The get key operation is applicable to all key types. If the requested key is symmetric, then no key material is released in the response. This operation requires the keys/get permission.'
|
||||
summary: Gets the public part of a stored key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9793,6 +9798,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetKeyVersions
|
||||
description: 'The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.'
|
||||
summary: Retrieves a list of individual key versions with the same key name.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9894,6 +9900,7 @@ operationGroups:
|
|||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags
|
||||
are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.
|
||||
summary: List keys in the specified vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -9989,6 +9996,7 @@ operationGroups:
|
|||
Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical
|
||||
boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation
|
||||
requires the key/backup permission.
|
||||
summary: Requests that a backup of the specified key be downloaded to the client.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10124,6 +10132,7 @@ operationGroups:
|
|||
a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key
|
||||
name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security
|
||||
constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.
|
||||
summary: Restores a backed up key to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10280,6 +10289,7 @@ operationGroups:
|
|||
The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the
|
||||
target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the
|
||||
key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.
|
||||
summary: Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10436,6 +10446,7 @@ operationGroups:
|
|||
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.
|
||||
summary: Decrypts a single block of encrypted data.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10589,6 +10600,7 @@ operationGroups:
|
|||
default:
|
||||
name: sign
|
||||
description: The SIGN operation is applicable to asymmetric and symmetric keys stored in Azure Key Vault since this operation uses the private portion of the key. This operation requires the keys/sign permission.
|
||||
summary: Creates a signature from a digest using the specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10755,6 +10767,7 @@ operationGroups:
|
|||
description: >-
|
||||
The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion
|
||||
of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.
|
||||
summary: Verifies a signature using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -10911,6 +10924,7 @@ operationGroups:
|
|||
The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault
|
||||
since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the
|
||||
public key material. This operation requires the keys/wrapKey permission.
|
||||
summary: Wraps a symmetric key using a specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11066,6 +11080,7 @@ operationGroups:
|
|||
description: >-
|
||||
The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP 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/unwrapKey permission.
|
||||
summary: Unwraps a symmetric key using the specified key that was initially used for wrapping that key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11170,6 +11185,7 @@ operationGroups:
|
|||
description: >-
|
||||
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults
|
||||
enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.
|
||||
summary: Lists the deleted keys in the specified vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11284,6 +11300,7 @@ operationGroups:
|
|||
description: >-
|
||||
The Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the
|
||||
keys/get permission.
|
||||
summary: Gets the public part of a deleted key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11370,6 +11387,7 @@ operationGroups:
|
|||
description: >-
|
||||
The Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the
|
||||
keys/purge permission.
|
||||
summary: Permanently deletes the specified key.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11481,6 +11499,7 @@ operationGroups:
|
|||
description: >-
|
||||
The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error.
|
||||
Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission.
|
||||
summary: Recovers the deleted key to its latest version.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11650,6 +11669,7 @@ operationGroups:
|
|||
default:
|
||||
name: SetSecret
|
||||
description: ' The SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission.'
|
||||
summary: Sets a secret in a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11747,6 +11767,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteSecret
|
||||
description: The DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires the secrets/delete permission.
|
||||
summary: Deletes a secret from a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -11921,6 +11942,7 @@ operationGroups:
|
|||
description: >-
|
||||
The UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value of a secret itself cannot be changed. This operation requires the
|
||||
secrets/set permission.
|
||||
summary: Updates the attributes associated with a specified secret in a given key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12029,6 +12051,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetSecret
|
||||
description: The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.
|
||||
summary: Get a specified secret from a given key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12129,6 +12152,7 @@ operationGroups:
|
|||
description: >-
|
||||
The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation
|
||||
requires the secrets/list permission.
|
||||
summary: List secrets in a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12239,6 +12263,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetSecretVersions
|
||||
description: The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.
|
||||
summary: List all versions of the specified secret.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12342,6 +12367,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedSecrets
|
||||
description: The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.
|
||||
summary: Lists deleted secrets for the specified vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12439,6 +12465,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedSecret
|
||||
description: The Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.
|
||||
summary: Gets the specified deleted secret.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12523,6 +12550,7 @@ operationGroups:
|
|||
default:
|
||||
name: PurgeDeletedSecret
|
||||
description: 'The purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.'
|
||||
summary: Permanently deletes the specified secret.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12617,6 +12645,7 @@ operationGroups:
|
|||
default:
|
||||
name: RecoverDeletedSecret
|
||||
description: Recovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission.
|
||||
summary: Recovers the deleted secret to the latest version.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12707,6 +12736,7 @@ operationGroups:
|
|||
default:
|
||||
name: BackupSecret
|
||||
description: Requests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.
|
||||
summary: Backs up the specified secret.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12827,6 +12857,7 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreSecret
|
||||
description: 'Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.'
|
||||
summary: Restores a backed up secret to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -12944,6 +12975,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificates
|
||||
description: The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.
|
||||
summary: List certificates in a specified key vault
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13075,6 +13107,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteCertificate
|
||||
description: Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.
|
||||
summary: Deletes a certificate from a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13197,6 +13230,7 @@ operationGroups:
|
|||
default:
|
||||
name: SetCertificateContacts
|
||||
description: Sets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.
|
||||
summary: Sets the certificate contacts for the specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13280,6 +13314,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateContacts
|
||||
description: The GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the certificates/managecontacts permission.
|
||||
summary: Lists the certificate contacts for a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13363,6 +13398,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteCertificateContacts
|
||||
description: Deletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission.
|
||||
summary: Deletes the certificate contacts for a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13459,6 +13495,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateIssuers
|
||||
description: The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.
|
||||
summary: List certificate issuers for a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13645,6 +13682,7 @@ operationGroups:
|
|||
default:
|
||||
name: SetCertificateIssuer
|
||||
description: The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.
|
||||
summary: Sets the specified certificate issuer.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13821,6 +13859,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateCertificateIssuer
|
||||
description: The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission.
|
||||
summary: Updates the specified certificate issuer.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -13924,6 +13963,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateIssuer
|
||||
description: The GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.
|
||||
summary: Lists the specified certificate issuer.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14027,6 +14067,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteCertificateIssuer
|
||||
description: The DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers permission.
|
||||
summary: Deletes the specified certificate issuer.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14197,6 +14238,7 @@ operationGroups:
|
|||
default:
|
||||
name: CreateCertificate
|
||||
description: 'If this is the first version, the certificate resource is created. This operation requires the certificates/create permission.'
|
||||
summary: Creates a new certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14424,6 +14466,7 @@ operationGroups:
|
|||
description: >-
|
||||
Imports an existing valid certificate, containing a private key, into Azure Key Vault. The certificate to be imported can be in either PFX or PEM format. If the certificate is in PEM format the PEM file must contain the key as
|
||||
well as x509 certificates. This operation requires the certificates/import permission.
|
||||
summary: Imports a certificate into a specified key vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14543,6 +14586,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateVersions
|
||||
description: The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.
|
||||
summary: List the versions of a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14657,6 +14701,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificatePolicy
|
||||
description: The GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get permission.
|
||||
summary: Lists the policy for a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14811,6 +14856,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateCertificatePolicy
|
||||
description: Set specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission.
|
||||
summary: Updates the policy for a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -14989,6 +15035,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateCertificate
|
||||
description: The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes. This operation requires the certificates/update permission.
|
||||
summary: Updates the specified attributes associated with the given certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15099,6 +15146,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificate
|
||||
description: Gets information about a specific certificate. This operation requires the certificates/get permission.
|
||||
summary: Gets information about a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15231,6 +15279,7 @@ operationGroups:
|
|||
default:
|
||||
name: UpdateCertificateOperation
|
||||
description: Updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.
|
||||
summary: Updates a certificate operation.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15328,6 +15377,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetCertificateOperation
|
||||
description: Gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.
|
||||
summary: Gets the creation operation of a certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15425,6 +15475,7 @@ operationGroups:
|
|||
default:
|
||||
name: DeleteCertificateOperation
|
||||
description: Deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update permission.
|
||||
summary: Deletes the creation operation for a specific certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15614,6 +15665,7 @@ operationGroups:
|
|||
default:
|
||||
name: MergeCertificate
|
||||
description: The MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation requires the certificates/create permission.
|
||||
summary: Merges a certificate or a certificate chain with a key pair existing on the server.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15704,6 +15756,7 @@ operationGroups:
|
|||
default:
|
||||
name: BackupCertificate
|
||||
description: Requests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires the certificates/backup permission.
|
||||
summary: Backs up the specified certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15859,6 +15912,7 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreCertificate
|
||||
description: 'Restores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.'
|
||||
summary: Restores a backed up certificate to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -15976,6 +16030,7 @@ operationGroups:
|
|||
description: >-
|
||||
The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires
|
||||
the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.
|
||||
summary: Lists the deleted certificates in the specified vault currently available for recovery.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16110,6 +16165,7 @@ operationGroups:
|
|||
description: >-
|
||||
The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the
|
||||
certificates/get permission.
|
||||
summary: Retrieves information about the specified deleted certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16196,6 +16252,7 @@ operationGroups:
|
|||
description: >-
|
||||
The PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify 'Purgeable'. This
|
||||
operation requires the certificate/purge permission.
|
||||
summary: Permanently deletes the specified deleted certificate.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16326,6 +16383,7 @@ operationGroups:
|
|||
description: >-
|
||||
The RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must be issued during the retention interval (available in the deleted
|
||||
certificate's attributes). This operation requires the certificates/recover permission.
|
||||
summary: Recovers the deleted certificate back to its current version under /certificates.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16556,6 +16614,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedStorageAccounts
|
||||
description: The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.
|
||||
summary: Lists deleted storage accounts for the specified vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16662,6 +16721,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedStorageAccount
|
||||
description: The Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get permission.
|
||||
summary: Gets the specified deleted storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16750,6 +16810,7 @@ operationGroups:
|
|||
description: >-
|
||||
The purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge
|
||||
permission.
|
||||
summary: Permanently deletes the specified storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16853,6 +16914,7 @@ operationGroups:
|
|||
default:
|
||||
name: RecoverDeletedStorageAccount
|
||||
description: Recovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.
|
||||
summary: Recovers the deleted storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -16945,6 +17007,7 @@ operationGroups:
|
|||
default:
|
||||
name: BackupStorageAccount
|
||||
description: Requests that a backup of the specified storage account be downloaded to the client. This operation requires the storage/backup permission.
|
||||
summary: Backs up the specified storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -17072,6 +17135,7 @@ operationGroups:
|
|||
default:
|
||||
name: RestoreStorageAccount
|
||||
description: Restores a backed up storage account to a vault. This operation requires the storage/restore permission.
|
||||
summary: Restores a backed up storage account to a vault.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -18060,6 +18124,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedSasDefinitions
|
||||
description: The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.
|
||||
summary: Lists deleted SAS definitions for the specified vault and storage account.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -18176,6 +18241,7 @@ operationGroups:
|
|||
default:
|
||||
name: GetDeletedSasDefinition
|
||||
description: The Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas permission.
|
||||
summary: Gets the specified deleted sas definition.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -18289,6 +18355,7 @@ operationGroups:
|
|||
default:
|
||||
name: RecoverDeletedSasDefinition
|
||||
description: Recovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.
|
||||
summary: Recovers the deleted SAS definition.
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
@ -2342,6 +2342,7 @@ operationGroups:
|
|||
description: >-
|
||||
The API returns a list of general named entities in a given document. For the list of supported entity types, check <a href="https://aka.ms/taner">Supported Entity Types in Text Analytics API</a>. See the <a
|
||||
href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Named Entity Recognition
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -2498,6 +2499,7 @@ operationGroups:
|
|||
description: >
|
||||
The API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in the document. For the list of supported entity types, check <a href="https://aka.ms/tanerpii">Supported Entity Types in Text Analytics
|
||||
API</a>. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Entities containing personal information
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -2664,6 +2666,7 @@ operationGroups:
|
|||
default:
|
||||
name: EntitiesLinking
|
||||
description: 'The API returns a list of recognized entities with links to a well-known knowledge base. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.'
|
||||
summary: Linked entities from a well-known knowledge base
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -2806,6 +2809,7 @@ operationGroups:
|
|||
default:
|
||||
name: KeyPhrases
|
||||
description: 'The API returns a list of strings denoting the key phrases in the input text. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.'
|
||||
summary: Key Phrases
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -2951,6 +2955,7 @@ operationGroups:
|
|||
description: >-
|
||||
The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. See the <a href="https://aka.ms/talangs">Supported languages in Text
|
||||
Analytics API</a> for the list of enabled languages.
|
||||
summary: Detect Language
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3139,6 +3144,7 @@ operationGroups:
|
|||
description: >-
|
||||
The API returns a sentiment prediction, as well as sentiment scores for each sentiment class (Positive, Negative, and Neutral) for the document and each sentence within it. See the <a href="https://aka.ms/talangs">Supported
|
||||
languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Sentiment
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
|
@ -2328,6 +2328,7 @@ operationGroups:
|
|||
description: >-
|
||||
The API returns a list of general named entities in a given document. For the list of supported entity types, check <a href="https://aka.ms/taner">Supported Entity Types in Text Analytics API</a>. See the <a
|
||||
href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Named Entity Recognition
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -2470,6 +2471,7 @@ operationGroups:
|
|||
description: >
|
||||
The API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in the document. For the list of supported entity types, check <a href="https://aka.ms/tanerpii">Supported Entity Types in Text Analytics
|
||||
API</a>. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Entities containing personal information
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -2622,6 +2624,7 @@ operationGroups:
|
|||
default:
|
||||
name: EntitiesLinking
|
||||
description: 'The API returns a list of recognized entities with links to a well-known knowledge base. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.'
|
||||
summary: Linked entities from a well-known knowledge base
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -2750,6 +2753,7 @@ operationGroups:
|
|||
default:
|
||||
name: KeyPhrases
|
||||
description: 'The API returns a list of strings denoting the key phrases in the input text. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.'
|
||||
summary: Key Phrases
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -2881,6 +2885,7 @@ operationGroups:
|
|||
description: >-
|
||||
The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. See the <a href="https://aka.ms/talangs">Supported languages in Text
|
||||
Analytics API</a> for the list of enabled languages.
|
||||
summary: Detect Language
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3055,6 +3060,7 @@ operationGroups:
|
|||
description: >-
|
||||
The API returns a sentiment prediction, as well as sentiment scores for each sentiment class (Positive, Negative, and Neutral) for the document and each sentence within it. See the <a href="https://aka.ms/talangs">Supported
|
||||
languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Sentiment
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
|
@ -2432,6 +2432,7 @@ operationGroups:
|
|||
description: >-
|
||||
The API returns a list of general named entities in a given document. For the list of supported entity types, check <a href="https://aka.ms/taner">Supported Entity Types in Text Analytics API</a>. See the <a
|
||||
href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Named Entity Recognition
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -2588,6 +2589,7 @@ operationGroups:
|
|||
description: >
|
||||
The API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in the document. For the list of supported entity types, check <a href="https://aka.ms/tanerpii">Supported Entity Types in Text Analytics
|
||||
API</a>. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Entities containing personal information
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -2754,6 +2756,7 @@ operationGroups:
|
|||
default:
|
||||
name: EntitiesLinking
|
||||
description: 'The API returns a list of recognized entities with links to a well-known knowledge base. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.'
|
||||
summary: Linked entities from a well-known knowledge base
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -2896,6 +2899,7 @@ operationGroups:
|
|||
default:
|
||||
name: KeyPhrases
|
||||
description: 'The API returns a list of strings denoting the key phrases in the input text. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.'
|
||||
summary: Key Phrases
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3041,6 +3045,7 @@ operationGroups:
|
|||
description: >-
|
||||
The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. See the <a href="https://aka.ms/talangs">Supported languages in Text
|
||||
Analytics API</a> for the list of enabled languages.
|
||||
summary: Detect Language
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -3229,6 +3234,7 @@ operationGroups:
|
|||
description: >-
|
||||
The API returns a sentiment prediction, as well as sentiment scores for each sentiment class (Positive, Negative, and Neutral) for the document and each sentence within it. See the <a href="https://aka.ms/talangs">Supported
|
||||
languages in Text Analytics API</a> for the list of enabled languages.
|
||||
summary: Sentiment
|
||||
protocol: !<!Protocols> {}
|
||||
language: !<!Languages>
|
||||
default:
|
||||
|
|
|
@ -594,6 +594,7 @@ operationGroups:
|
|||
default:
|
||||
name: validationOfMethodParameters
|
||||
description: Validates input parameters on the method. See swagger for details.
|
||||
summary: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -687,6 +688,7 @@ operationGroups:
|
|||
default:
|
||||
name: validationOfBody
|
||||
description: Validates body parameters on the method. See swagger for details.
|
||||
summary: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
@ -594,6 +594,7 @@ operationGroups:
|
|||
default:
|
||||
name: validationOfMethodParameters
|
||||
description: Validates input parameters on the method. See swagger for details.
|
||||
summary: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -687,6 +688,7 @@ operationGroups:
|
|||
default:
|
||||
name: validationOfBody
|
||||
description: Validates body parameters on the method. See swagger for details.
|
||||
summary: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
|
@ -609,6 +609,7 @@ operationGroups:
|
|||
default:
|
||||
name: validationOfMethodParameters
|
||||
description: Validates input parameters on the method. See swagger for details.
|
||||
summary: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
@ -702,6 +703,7 @@ operationGroups:
|
|||
default:
|
||||
name: validationOfBody
|
||||
description: Validates body parameters on the method. See swagger for details.
|
||||
summary: ''
|
||||
protocol: !<!Protocols> {}
|
||||
- !<!Operation>
|
||||
apiVersions:
|
||||
|
|
Загрузка…
Ссылка в новой задаче