StorageImportExportManagementClientContext class
- Extends
-
AzureServiceClient
Constructors
| Storage |
Initializes a new instance of the StorageImportExportManagementClient class. |
Properties
| accept |
|
| api |
|
| credentials | |
| long |
The retry timeout in seconds for Long Running Operations. Default value is 30. |
| subscription |
Methods
| begin |
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. |
| restore |
Restore an LROPoller from the provided LROPollState. This method can be used to recreate an LROPoller on a different process or machine. |
| send |
Provides a mechanism to make a request that will poll and provide the final result. |
| send |
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. |
| send |
Send an HTTP request that is populated using the provided OperationSpec. |
| send |
Send the provided httpRequest. |
Constructor Details
StorageImportExportManagementClientContext(ServiceClientCredentials | TokenCredential, string, Models.StorageImportExportManagementClientOptions)
Initializes a new instance of the StorageImportExportManagementClient class.
new StorageImportExportManagementClientContext(credentials: ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.StorageImportExportManagementClientOptions)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 for the Azure user.
- options
- Models.StorageImportExportManagementClientOptions
Property Details
acceptLanguage
acceptLanguage: stringProperty Value
string
apiVersion
apiVersion?: undefined | stringProperty Value
undefined | string
credentials
credentials: ServiceClientCredentials | TokenCredentialProperty Value
ServiceClientCredentials | TokenCredential
longRunningOperationRetryTimeout
The retry timeout in seconds for Long Running Operations. Default value is 30.
longRunningOperationRetryTimeout?: undefined | numberProperty Value
undefined | number
subscriptionId
subscriptionId: stringProperty 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 | WebResource)
Send the provided httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResource)Parameters
- options
-
RequestPrepareOptions | WebResource
Returns
Promise<HttpOperationResponse>
Azure SDK for JavaScript