KeyVaultManagementClient class

Extends

Constructors

KeyVaultManagementClient(ServiceClientCredentials, string, Models.KeyVaultManagementClientOptions)

Initializes a new instance of the KeyVaultManagementClient class.

Properties

acceptLanguage
apiVersion
credentials
longRunningOperationRetryTimeout

The retry timeout in seconds for Long Running Operations. Default value is 30.

operations
subscriptionId
vaults

Methods

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an HttpLongRunningOperationResponse that provides methods for polling the LRO and checking if the LRO is finished.

restoreLROPoller(LROPollState)

Restore an LROPoller from the provided LROPollState. This method can be used to recreate an LROPoller on a different process or machine.

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Provides a mechanism to make a request that will poll and provide the final result.

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an LROPoller that provides methods for polling the LRO and checking if the LRO is finished.

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Send an HTTP request that is populated using the provided OperationSpec.

sendRequest(RequestPrepareOptions | WebResource)

Send the provided httpRequest.

Constructor Details

KeyVaultManagementClient(ServiceClientCredentials, string, Models.KeyVaultManagementClientOptions)

Initializes a new instance of the KeyVaultManagementClient class.

new KeyVaultManagementClient(credentials: ServiceClientCredentials, subscriptionId: string, options?: Models.KeyVaultManagementClientOptions)

Parameters

credentials

ServiceClientCredentials

Credentials needed for the client to connect to Azure.

subscriptionId

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options
Models.KeyVaultManagementClientOptions

Property Details

acceptLanguage

acceptLanguage: string

Property Value

string

apiVersion

apiVersion?: undefined | string

Property Value

undefined | string

credentials

credentials: ServiceClientCredentials

Property Value

ServiceClientCredentials

longRunningOperationRetryTimeout

The retry timeout in seconds for Long Running Operations. Default value is 30.

longRunningOperationRetryTimeout?: undefined | number

Property Value

undefined | number

operations

operations: Operations

Property Value

subscriptionId

subscriptionId: string

Property Value

string

vaults

vaults: Vaults

Property Value

Method Details

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an HttpLongRunningOperationResponse that provides methods for polling the LRO and checking if the LRO is finished.

function beginLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase)

Parameters

request

RequestPrepareOptions | WebResource

The request object

options

RequestOptionsBase

Returns

Promise<LROPoller>

The HttpLongRunningOperationResponse that provides methods for interacting with the LRO.

restoreLROPoller(LROPollState)

Restore an LROPoller from the provided LROPollState. This method can be used to recreate an LROPoller on a different process or machine.

function restoreLROPoller(lroPollState: LROPollState)

Parameters

lroPollState

LROPollState

Returns

LROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Provides a mechanism to make a request that will poll and provide the final result.

function sendLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase)

Parameters

request

RequestPrepareOptions | WebResource

The request object

options

RequestOptionsBase

Returns

Promise<HttpOperationResponse>

The HttpOperationResponse containing the final polling request, response and the responseBody.

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Send the initial request of a LRO (long running operation) and get back an LROPoller that provides methods for polling the LRO and checking if the LRO is finished.

function sendLRORequest(operationArguments: OperationArguments, operationSpec: OperationSpec, options?: RequestOptionsBase)

Parameters

operationArguments

OperationArguments

The arguments to the operation.

operationSpec

OperationSpec

The specification for the operation.

options

RequestOptionsBase

Additional options to be sent while making the request.

Returns

Promise<LROPoller>

The LROPoller object that provides methods for interacting with the LRO.

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>)

Parameters

operationArguments

OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec

OperationSpec

The OperationSpec to use to populate the httpRequest.

callback

ServiceCallback<any>

The callback to call when the response is received.

Returns

Promise<RestResponse>

sendRequest(RequestPrepareOptions | WebResource)

Send the provided httpRequest.

function sendRequest(options: RequestPrepareOptions | WebResource)

Parameters

options

RequestPrepareOptions | WebResource

Returns

Promise<HttpOperationResponse>