ManagedHsmKeys interface
Interface representing a ManagedHsmKeys.
Methods
| create |
Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys. |
| get(string, string, string, Managed |
Gets the current version of the specified key from the specified managed HSM. |
| get |
Gets the specified version of the specified key in the specified managed HSM. |
| list(string, string, Managed |
Lists the keys in the specified managed HSM. |
| list |
Lists the versions of the specified key in the specified managed HSM. |
Method Details
createIfNotExist(string, string, string, ManagedHsmKeyCreateParameters, ManagedHsmKeysCreateIfNotExistOptionalParams)
Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.
function createIfNotExist(resourceGroupName: string, name: string, keyName: string, parameters: ManagedHsmKeyCreateParameters, options?: ManagedHsmKeysCreateIfNotExistOptionalParams): Promise<ManagedHsmKey>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Managed HSM Pool within the specified resource group.
- keyName
-
string
The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
- parameters
- ManagedHsmKeyCreateParameters
The parameters used to create the specified key.
The options parameters.
Returns
Promise<ManagedHsmKey>
get(string, string, string, ManagedHsmKeysGetOptionalParams)
Gets the current version of the specified key from the specified managed HSM.
function get(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysGetOptionalParams): Promise<ManagedHsmKey>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Managed HSM Pool within the specified resource group.
- keyName
-
string
The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
- options
- ManagedHsmKeysGetOptionalParams
The options parameters.
Returns
Promise<ManagedHsmKey>
getVersion(string, string, string, string, ManagedHsmKeysGetVersionOptionalParams)
Gets the specified version of the specified key in the specified managed HSM.
function getVersion(resourceGroupName: string, name: string, keyName: string, keyVersion: string, options?: ManagedHsmKeysGetVersionOptionalParams): Promise<ManagedHsmKey>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Managed HSM Pool within the specified resource group.
- keyName
-
string
The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
- keyVersion
-
string
The version of the key to be retrieved.
The options parameters.
Returns
Promise<ManagedHsmKey>
list(string, string, ManagedHsmKeysListOptionalParams)
Lists the keys in the specified managed HSM.
function list(resourceGroupName: string, name: string, options?: ManagedHsmKeysListOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey, ManagedHsmKey[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Managed HSM Pool within the specified resource group.
- options
- ManagedHsmKeysListOptionalParams
The options parameters.
Returns
listVersions(string, string, string, ManagedHsmKeysListVersionsOptionalParams)
Lists the versions of the specified key in the specified managed HSM.
function listVersions(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysListVersionsOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey, ManagedHsmKey[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Managed HSM Pool within the specified resource group.
- keyName
-
string
The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
The options parameters.