AutomationClient class
- Extends
Constructors
| Automation |
Initializes a new instance of the AutomationClient class. |
Properties
Inherited Properties
| accept |
|
| count |
|
| 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
AutomationClient(ServiceClientCredentials | TokenCredential, string, CountType, AutomationClientOptions)
Initializes a new instance of the AutomationClient class.
new AutomationClient(credentials: ServiceClientCredentials | TokenCredential, subscriptionId: string, countType1: CountType, options?: AutomationClientOptions)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
Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- countType1
- CountType
The type of counts to retrieve. Possible values include: 'status', 'nodeconfiguration'
- options
- AutomationClientOptions
The parameter options
Property Details
activity
agentRegistrationInformation
agentRegistrationInformation: AgentRegistrationInformationProperty Value
automationAccount
certificate
connection
connectionType
credential
dscCompilationJob
dscCompilationJobStream
dscConfiguration
dscNode
dscNodeConfiguration
fields
hybridRunbookWorkerGroup
hybridRunbookWorkerGroup: HybridRunbookWorkerGroupOperationsProperty Value
job
jobSchedule
jobStream
keys
linkedWorkspace
module
nodeCountInformation
nodeReports
objectDataTypes
operations
python2Package
runbook
runbookDraft
schedule
softwareUpdateConfigurationMachineRuns
softwareUpdateConfigurationMachineRuns: SoftwareUpdateConfigurationMachineRunsProperty Value
softwareUpdateConfigurationRuns
softwareUpdateConfigurationRuns: SoftwareUpdateConfigurationRunsProperty Value
softwareUpdateConfigurations
softwareUpdateConfigurations: SoftwareUpdateConfigurationsProperty Value
sourceControl
sourceControlSyncJob
sourceControlSyncJobStreams
statistics
testJob
testJobStreams
usages
variable
watcher
webhook
Inherited Property Details
acceptLanguage
countType1
credentials
credentials: ServiceClientCredentials | TokenCredentialProperty Value
Inherited From AutomationClientContext.credentials
longRunningOperationRetryTimeout
The retry timeout in seconds for Long Running Operations. Default value is 30.
longRunningOperationRetryTimeout?: numberProperty Value
number
Inherited From AutomationClientContext.longRunningOperationRetryTimeout
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 AutomationClientContext.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 AutomationClientContext.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 AutomationClientContext.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 AutomationClientContext.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 AutomationClientContext.sendOperationRequest
sendRequest(RequestPrepareOptions | WebResourceLike)
Send the provided httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>Parameters
- options
Returns
Promise<HttpOperationResponse>
Inherited From AutomationClientContext.sendRequest