ServerKeys interface

Package:

@azure/arm-postgresql

Interface representing a ServerKeys.

Methods

beginCreateOrUpdate(string, string, string, ServerKey, ServerKeysCreateOrUpdateOptionalParams)	Creates or updates a PostgreSQL Server key.
beginCreateOrUpdateAndWait(string, string, string, ServerKey, ServerKeysCreateOrUpdateOptionalParams)	Creates or updates a PostgreSQL Server key.
beginDelete(string, string, string, ServerKeysDeleteOptionalParams)	Deletes the PostgreSQL Server key with the given name.
beginDeleteAndWait(string, string, string, ServerKeysDeleteOptionalParams)	Deletes the PostgreSQL Server key with the given name.
get(string, string, string, ServerKeysGetOptionalParams)	Gets a PostgreSQL Server key.
list(string, string, ServerKeysListOptionalParams)	Gets a list of Server keys.

Method Details

beginCreateOrUpdate(string, string, string, ServerKey, ServerKeysCreateOrUpdateOptionalParams)

Creates or updates a PostgreSQL Server key.

function beginCreateOrUpdate(serverName: string, keyName: string, resourceGroupName: string, parameters: ServerKey, options?: ServerKeysCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ServerKey>, ServerKey>>

Parameters

serverName

string

The name of the server.

keyName

string

The name of the PostgreSQL Server key to be operated on (updated or created).

resourceGroupName

string

The name of the resource group. The name is case insensitive.

parameters

ServerKey

The requested PostgreSQL Server key resource state.

options

ServerKeysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<ServerKey>, ServerKey>>

beginCreateOrUpdateAndWait(string, string, string, ServerKey, ServerKeysCreateOrUpdateOptionalParams)

Creates or updates a PostgreSQL Server key.

function beginCreateOrUpdateAndWait(serverName: string, keyName: string, resourceGroupName: string, parameters: ServerKey, options?: ServerKeysCreateOrUpdateOptionalParams): Promise<ServerKey>

Parameters

serverName

string

The name of the server.

keyName

string

The name of the PostgreSQL Server key to be operated on (updated or created).

resourceGroupName

string

The name of the resource group. The name is case insensitive.

parameters

ServerKey

The requested PostgreSQL Server key resource state.

options

ServerKeysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ServerKey>

beginDelete(string, string, string, ServerKeysDeleteOptionalParams)

Deletes the PostgreSQL Server key with the given name.

function beginDelete(serverName: string, keyName: string, resourceGroupName: string, options?: ServerKeysDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

serverName

string

The name of the server.

keyName

string

The name of the PostgreSQL Server key to be deleted.

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

ServerKeysDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, ServerKeysDeleteOptionalParams)

Deletes the PostgreSQL Server key with the given name.

function beginDeleteAndWait(serverName: string, keyName: string, resourceGroupName: string, options?: ServerKeysDeleteOptionalParams): Promise<void>

Parameters

serverName

string

The name of the server.

keyName

string

The name of the PostgreSQL Server key to be deleted.

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

ServerKeysDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ServerKeysGetOptionalParams)

Gets a PostgreSQL Server key.

function get(resourceGroupName: string, serverName: string, keyName: string, options?: ServerKeysGetOptionalParams): Promise<ServerKey>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

keyName

string

The name of the PostgreSQL Server key to be retrieved.

options

ServerKeysGetOptionalParams

The options parameters.

Returns

Promise<ServerKey>

list(string, string, ServerKeysListOptionalParams)

Gets a list of Server keys.

function list(resourceGroupName: string, serverName: string, options?: ServerKeysListOptionalParams): PagedAsyncIterableIterator<ServerKey, ServerKey[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options

ServerKeysListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ServerKey, ServerKey[], PageSettings>