ServerKeys interface
Interface representing a ServerKeys.
Methods
| begin |
Creates or updates a server key. |
| begin |
Creates or updates a server key. |
| begin |
Deletes the server key with the given name. |
| begin |
Deletes the server key with the given name. |
| get(string, string, string, Server |
Gets a server key. |
| list |
Gets a list of server keys. |
Method Details
beginCreateOrUpdate(string, string, string, ServerKey, ServerKeysCreateOrUpdateOptionalParams)
Creates or updates a server key.
function beginCreateOrUpdate(resourceGroupName: string, serverName: string, keyName: string, parameters: ServerKey, options?: ServerKeysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServerKey>, ServerKey>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- keyName
-
string
The name of the server key to be operated on (updated or created). The key name is
required to be in the format of 'vault_key_version'. For example, if the keyId is
https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name
should be formatted as: YourVaultName_YourKeyName_YourKeyVersion
- parameters
- ServerKey
The requested server key resource state.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServerKey>, ServerKey>>
beginCreateOrUpdateAndWait(string, string, string, ServerKey, ServerKeysCreateOrUpdateOptionalParams)
Creates or updates a server key.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, keyName: string, parameters: ServerKey, options?: ServerKeysCreateOrUpdateOptionalParams): Promise<ServerKey>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- keyName
-
string
The name of the server key to be operated on (updated or created). The key name is
required to be in the format of 'vault_key_version'. For example, if the keyId is
https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name
should be formatted as: YourVaultName_YourKeyName_YourKeyVersion
- parameters
- ServerKey
The requested server key resource state.
The options parameters.
Returns
Promise<ServerKey>
beginDelete(string, string, string, ServerKeysDeleteOptionalParams)
Deletes the server key with the given name.
function beginDelete(resourceGroupName: string, serverName: string, keyName: string, options?: ServerKeysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- keyName
-
string
The name of the server key to be deleted.
- options
- ServerKeysDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ServerKeysDeleteOptionalParams)
Deletes the server key with the given name.
function beginDeleteAndWait(resourceGroupName: string, serverName: string, keyName: string, options?: ServerKeysDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- keyName
-
string
The name of the server key to be deleted.
- options
- ServerKeysDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, ServerKeysGetOptionalParams)
Gets a server key.
function get(resourceGroupName: string, serverName: string, keyName: string, options?: ServerKeysGetOptionalParams): Promise<ServerKey>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- keyName
-
string
The name of the server key to be retrieved.
- options
- ServerKeysGetOptionalParams
The options parameters.
Returns
Promise<ServerKey>
listByServer(string, string, ServerKeysListByServerOptionalParams)
Gets a list of server keys.
function listByServer(resourceGroupName: string, serverName: string, options?: ServerKeysListByServerOptionalParams): PagedAsyncIterableIterator<ServerKey, ServerKey[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
The options parameters.