DataBoxManagementClient class
- Extends
Constructors
| Data |
Initializes a new instance of the DataBoxManagementClient class. |
Properties
| $host | |
| api |
|
| jobs | |
| operations | |
| service | |
| subscription |
Inherited Properties
| pipeline | The pipeline used by this client to make requests |
Methods
| mitigate(string, string, Mitigate |
Request to mitigate for a given job |
Inherited Methods
| send |
Send an HTTP request that is populated using the provided OperationSpec. |
| send |
Send the provided httpRequest. |
Constructor Details
DataBoxManagementClient(TokenCredential, string, DataBoxManagementClientOptionalParams)
Initializes a new instance of the DataBoxManagementClient class.
new DataBoxManagementClient(credentials: TokenCredential, subscriptionId: string, options?: DataBoxManagementClientOptionalParams)Parameters
- credentials
- TokenCredential
Subscription credentials which uniquely identify client subscription.
- subscriptionId
-
string
The Subscription Id
The parameter options
Property Details
$host
$host: stringProperty Value
string
apiVersion
apiVersion: stringProperty Value
string
jobs
operations
service
subscriptionId
subscriptionId: stringProperty Value
string
Inherited Property Details
pipeline
The pipeline used by this client to make requests
pipeline: PipelineProperty Value
Inherited From coreClient.ServiceClient.pipeline
Method Details
mitigate(string, string, MitigateJobRequest, MitigateOptionalParams)
Request to mitigate for a given job
function mitigate(jobName: string, resourceGroupName: string, mitigateJobRequest: MitigateJobRequest, options?: MitigateOptionalParams): Promise<void>Parameters
- jobName
-
string
The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
- resourceGroupName
-
string
The Resource Group Name
- mitigateJobRequest
- MitigateJobRequest
Mitigation Request
- options
- MitigateOptionalParams
The options parameters.
Returns
Promise<void>
Inherited Method Details
sendOperationRequest<T>(OperationArguments, OperationSpec)
Send an HTTP request that is populated using the provided OperationSpec.
function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>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.
Returns
Promise<T>
Inherited From coreClient.ServiceClient.sendOperationRequest
sendRequest(PipelineRequest)
Send the provided httpRequest.
function sendRequest(request: PipelineRequest): Promise<PipelineResponse>Parameters
- request
- PipelineRequest
Returns
Promise<PipelineResponse>
Inherited From coreClient.ServiceClient.sendRequest