UsageManagementClient class
- Extends
Constructors
| Usage |
Initializes a new instance of the UsageManagementClient class. |
Properties
| rate |
|
| usage |
Inherited Properties
| accept |
|
| api |
|
| credentials | |
| long |
The retry timeout in seconds for Long Running Operations. Default value is 30. |
| subscription |
Inherited 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
UsageManagementClient(ServiceClientCredentials | TokenCredential, string, UsageManagementClientOptions)
Initializes a new instance of the UsageManagementClient class.
new UsageManagementClient(credentials: ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: UsageManagementClientOptions)Parameters
- credentials
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 https://www.npmjs.com/package/@azure/identity. Credentials implementing the ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and @azure/ms-rest-browserauth are also supported.
- subscriptionId
-
string
It uniquely identifies Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- options
- UsageManagementClientOptions
The parameter options
Property Details
rateCard
usageAggregates
Inherited Property Details
acceptLanguage
acceptLanguage: stringProperty Value
string
Inherited From UsageManagementClientContext.acceptLanguage
apiVersion
credentials
credentials: ServiceClientCredentials | TokenCredentialProperty Value
Inherited From UsageManagementClientContext.credentials
longRunningOperationRetryTimeout
The retry timeout in seconds for Long Running Operations. Default value is 30.
longRunningOperationRetryTimeout?: numberProperty Value
number
Inherited From UsageManagementClientContext.longRunningOperationRetryTimeout
subscriptionId
subscriptionId: stringProperty Value
string
Inherited From UsageManagementClientContext.subscriptionId
Inherited 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): Promise<LROPoller>Parameters
- request
The request object
- options
- RequestOptionsBase
Additional options to be sent while making the request
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
The HttpLongRunningOperationResponse that provides methods for interacting with the LRO.
Inherited From UsageManagementClientContext.beginLongRunningRequest
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): LROPollerParameters
- lroPollState
- @azure/ms-rest-azure-js.LROPollState
Returns
Inherited From UsageManagementClientContext.restoreLROPoller
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): Promise<HttpOperationResponse>Parameters
- request
The request object
- options
- RequestOptionsBase
Additional options to be sent while making the request
Returns
Promise<HttpOperationResponse>
The HttpOperationResponse containing the final polling request, response and the responseBody.
Inherited From UsageManagementClientContext.sendLongRunningRequest
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): Promise<LROPoller>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<@azure/ms-rest-azure-js.LROPoller>
The LROPoller object that provides methods for interacting with the LRO.
Inherited From UsageManagementClientContext.sendLRORequest
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>): Promise<RestResponse>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>
Inherited From UsageManagementClientContext.sendOperationRequest
sendRequest(RequestPrepareOptions | WebResourceLike)
Send the provided httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>Parameters
- options
Returns
Promise<HttpOperationResponse>
Inherited From UsageManagementClientContext.sendRequest