Package version:

Interface ServerKeys

Interface representing a ServerKeys.

Hierarchy

ServerKeys

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait get listByServer

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, keyName: string, parameters: ServerKey, options?: ServerKeysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServerKey>, ServerKey>>
Creates or updates a server key.
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.
- Optional options: ServerKeysCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ServerKey>, ServerKey>>
- Defined in operationsInterfaces/serverKeys.ts:62

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, keyName: string, parameters: ServerKey, options?: ServerKeysCreateOrUpdateOptionalParams): Promise<ServerKey>
Creates or updates a server key.
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.
- Optional options: ServerKeysCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ServerKey>
- Defined in operationsInterfaces/serverKeys.ts:86

beginDelete

beginDelete(resourceGroupName: string, serverName: string, keyName: string, options?: ServerKeysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes the server key with the given name.
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.
- Optional options: ServerKeysDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/serverKeys.ts:101

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, keyName: string, options?: ServerKeysDeleteOptionalParams): Promise<void>
Deletes the server key with the given name.
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.
- Optional options: ServerKeysDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/serverKeys.ts:115

get

get(resourceGroupName: string, serverName: string, keyName: string, options?: ServerKeysGetOptionalParams): Promise<ServerKey>
Gets a server key.
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.
- Optional options: ServerKeysGetOptionalParams
  
  The options parameters.
Returns Promise<ServerKey>
- Defined in operationsInterfaces/serverKeys.ts:44

listByServer

listByServer(resourceGroupName: string, serverName: string, options?: ServerKeysListByServerOptionalParams): PagedAsyncIterableIterator<ServerKey>
Gets a list of server keys.
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.
- Optional options: ServerKeysListByServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ServerKey>
- Defined in operationsInterfaces/serverKeys.ts:31

Interface ServerKeys

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

keyName: string

parameters: ServerKey

Optional options: ServerKeysCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<ServerKey>, ServerKey>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

keyName: string

parameters: ServerKey

Optional options: ServerKeysCreateOrUpdateOptionalParams

Returns Promise<ServerKey>

beginDelete

Parameters

resourceGroupName: string

serverName: string

keyName: string

Optional options: ServerKeysDeleteOptionalParams

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

keyName: string

Optional options: ServerKeysDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serverName: string

keyName: string

Optional options: ServerKeysGetOptionalParams

Returns Promise<ServerKey>

listByServer

Parameters

resourceGroupName: string

serverName: string

Optional options: ServerKeysListByServerOptionalParams

Returns PagedAsyncIterableIterator<ServerKey>

Settings

Member Visibility

Theme

`Optional` options: ServerKeysCreateOrUpdateOptionalParams

`Optional` options: ServerKeysCreateOrUpdateOptionalParams

`Optional` options: ServerKeysDeleteOptionalParams

`Optional` options: ServerKeysDeleteOptionalParams

`Optional` options: ServerKeysGetOptionalParams

`Optional` options: ServerKeysListByServerOptionalParams