SqlManagementClientContext class

Extends

AzureServiceClient

Constructors

SqlManagementClientContext(ServiceClientCredentials | TokenCredential, string, Models.SqlManagementClientOptions)

Initializes a new instance of the SqlManagementClient class.

Properties

acceptLanguage
credentials
longRunningOperationRetryTimeout

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

subscriptionId

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 | WebResourceLike)

NOTE: This is an override added manually to workaround bug Azure/ms-rest-js/issues/395 When this library is regenerated, this override needs to be brought back This override adds the header "Accept: application/json" to every request

Constructor Details

SqlManagementClientContext(ServiceClientCredentials | TokenCredential, string, Models.SqlManagementClientOptions)

Initializes a new instance of the SqlManagementClient class.

new SqlManagementClientContext(credentials: ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.SqlManagementClientOptions)

Parameters

credentials

ServiceClientCredentials | TokenCredential

Credentials needed for the client to connect to Azure. Credentials implementing the TokenCredential interface from the @azure/identity package are recommended. For more information about these credentials, see <xref:https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40azure%2Fidentity>. Credentials implementing the ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and

subscriptionId

string

The subscription ID that identifies an Azure subscription.

options
Models.SqlManagementClientOptions

Property Details

acceptLanguage

acceptLanguage: string

Property Value

string

credentials

credentials: ServiceClientCredentials | TokenCredential

Property Value

ServiceClientCredentials | TokenCredential

longRunningOperationRetryTimeout

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

longRunningOperationRetryTimeout?: undefined | number

Property Value

undefined | number

subscriptionId

subscriptionId: string

Property Value

string

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 | WebResourceLike)

NOTE: This is an override added manually to workaround bug Azure/ms-rest-js/issues/395 When this library is regenerated, this override needs to be brought back This override adds the header "Accept: application/json" to every request

function sendRequest(options: RequestPrepareOptions | WebResourceLike)

Parameters

options

RequestPrepareOptions | WebResourceLike

Returns

Promise<HttpOperationResponse>