共用方式為


AutomationClient class

Extends

建構函式

AutomationClient(ServiceClientCredentials | TokenCredential, string, CountType, AutomationClientOptions)

初始化 AutomationClient 類別的新實例。

屬性

activity
agentRegistrationInformation
automationAccount
certificate
connection
connectionType
credential
dscCompilationJob
dscCompilationJobStream
dscConfiguration
dscNode
dscNodeConfiguration
fields
hybridRunbookWorkerGroup
job
jobSchedule
jobStream
keys
linkedWorkspace
module
nodeCountInformation
nodeReports
objectDataTypes
operations
python2Package
runbook
runbookDraft
schedule
softwareUpdateConfigurationMachineRuns
softwareUpdateConfigurationRuns
softwareUpdateConfigurations
sourceControl
sourceControlSyncJob
sourceControlSyncJobStreams
statistics
testJob
testJobStreams
usages
variable
watcher
webhook

繼承的屬性

acceptLanguage
countType1
credentials
longRunningOperationRetryTimeout

長時間執行作業的重試逾時以秒為單位。 預設值為 30。

subscriptionId

繼承的方法

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

傳送 LRO 的初始要求(長時間執行作業),並取得 HttpLongRunningOperationResponse,提供輪詢 LRO 的方法,並檢查 LRO 是否已完成。

restoreLROPoller(LROPollState)

從提供的 LROPollState 還原 LROPoller。 這個方法可用來在不同的進程或計算機上重新建立 LROPoller。

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

提供機制來提出要求,以輪詢並提供最終結果。

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

傳送 LRO 的初始要求(長時間執行作業),並取得 LROPoller,該 LROPoller 提供輪詢 LRO 的方法,並檢查 LRO 是否已完成。

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

傳送使用提供的 OperationSpec 填入的 HTTP 要求。

sendRequest(RequestPrepareOptions | WebResourceLike)

傳送提供的 HTTPRequest。

建構函式詳細資料

AutomationClient(ServiceClientCredentials | TokenCredential, string, CountType, AutomationClientOptions)

初始化 AutomationClient 類別的新實例。

new AutomationClient(credentials: ServiceClientCredentials | TokenCredential, subscriptionId: string, countType1: CountType, options?: AutomationClientOptions)

參數

credentials

ServiceClientCredentials | TokenCredential

用戶端連線至 Azure 所需的認證。 建議從 @azure/identity 套件實作 TokenCredential 介面的認證。 如需這些認證的詳細資訊,請參閱 https://www.npmjs.com/package/@azure/identity。 也支援從舊版套件實作 ServiceClientCredentials 介面的認證,@azure/ms-rest-nodeauth 和 @azure/ms-rest-browserauth。

subscriptionId

string

取得可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。

countType1
CountType

要擷取的計數類型。 可能的值包括:'status'、'nodeconfiguration'

options
AutomationClientOptions

參數選項

屬性詳細資料

activity

activity: ActivityOperations

屬性值

agentRegistrationInformation

agentRegistrationInformation: AgentRegistrationInformation

屬性值

automationAccount

automationAccount: AutomationAccountOperations

屬性值

certificate

certificate: CertificateOperations

屬性值

connection

connection: ConnectionOperations

屬性值

connectionType

connectionType: ConnectionTypeOperations

屬性值

credential

credential: CredentialOperations

屬性值

dscCompilationJob

dscCompilationJob: DscCompilationJobOperations

屬性值

dscCompilationJobStream

dscCompilationJobStream: DscCompilationJobStream

屬性值

dscConfiguration

dscConfiguration: DscConfigurationOperations

屬性值

dscNode

dscNode: DscNodeOperations

屬性值

dscNodeConfiguration

dscNodeConfiguration: DscNodeConfigurationOperations

屬性值

fields

fields: Fields

屬性值

hybridRunbookWorkerGroup

hybridRunbookWorkerGroup: HybridRunbookWorkerGroupOperations

屬性值

job

job: JobOperations

屬性值

jobSchedule

jobSchedule: JobScheduleOperations

屬性值

jobStream

jobStream: JobStreamOperations

屬性值

keys

keys: Keys

屬性值

linkedWorkspace

linkedWorkspace: LinkedWorkspaceOperations

屬性值

module

module: ModuleOperations

屬性值

nodeCountInformation

nodeCountInformation: NodeCountInformation

屬性值

nodeReports

nodeReports: NodeReports

屬性值

objectDataTypes

objectDataTypes: ObjectDataTypes

屬性值

operations

operations: Operations

屬性值

python2Package

python2Package: Python2Package

屬性值

runbook

runbook: RunbookOperations

屬性值

runbookDraft

runbookDraft: RunbookDraftOperations

屬性值

schedule

schedule: ScheduleOperations

屬性值

softwareUpdateConfigurationMachineRuns

softwareUpdateConfigurationMachineRuns: SoftwareUpdateConfigurationMachineRuns

屬性值

softwareUpdateConfigurationRuns

softwareUpdateConfigurationRuns: SoftwareUpdateConfigurationRuns

屬性值

softwareUpdateConfigurations

softwareUpdateConfigurations: SoftwareUpdateConfigurations

屬性值

sourceControl

sourceControl: SourceControlOperations

屬性值

sourceControlSyncJob

sourceControlSyncJob: SourceControlSyncJobOperations

屬性值

sourceControlSyncJobStreams

sourceControlSyncJobStreams: SourceControlSyncJobStreams

屬性值

statistics

statistics: StatisticsOperations

屬性值

testJob

testJob: TestJobOperations

屬性值

testJobStreams

testJobStreams: TestJobStreams

屬性值

usages

usages: Usages

屬性值

variable

variable: VariableOperations

屬性值

watcher

watcher: WatcherOperations

屬性值

webhook

webhook: WebhookOperations

屬性值

繼承的屬性詳細資料

acceptLanguage

acceptLanguage: string

屬性值

string

繼承自AutomationClientContext.acceptLanguage

countType1

countType1: CountType

屬性值

繼承自AutomationClientContext.countType1

credentials

credentials: ServiceClientCredentials | TokenCredential

屬性值

繼承自AutomationClientContext.credentials

longRunningOperationRetryTimeout

長時間執行作業的重試逾時以秒為單位。 預設值為 30。

longRunningOperationRetryTimeout?: number

屬性值

number

繼承自AutomationClientContext.longRunningOperationRetryTimeout

subscriptionId

subscriptionId: string

屬性值

string

繼承自AutomationClientContext.subscriptionId

繼承的方法的詳細資料

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

傳送 LRO 的初始要求(長時間執行作業),並取得 HttpLongRunningOperationResponse,提供輪詢 LRO 的方法,並檢查 LRO 是否已完成。

function beginLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<LROPoller>

參數

request

RequestPrepareOptions | WebResource

要求物件

options
RequestOptionsBase

提出要求時要傳送的其他選項

傳回

Promise<@azure/ms-rest-azure-js.LROPoller>

HttpLongRunningOperationResponse,提供與 LRO 互動的方法。

繼承自AutomationClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

從提供的 LROPollState 還原 LROPoller。 這個方法可用來在不同的進程或計算機上重新建立 LROPoller。

function restoreLROPoller(lroPollState: LROPollState): LROPoller

參數

lroPollState
@azure/ms-rest-azure-js.LROPollState

傳回

@azure/ms-rest-azure-js.LROPoller

繼承自AutomationClientContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

提供機制來提出要求,以輪詢並提供最終結果。

function sendLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<HttpOperationResponse>

參數

request

RequestPrepareOptions | WebResource

要求物件

options
RequestOptionsBase

提出要求時要傳送的其他選項

傳回

包含最終輪詢要求、回應和 responseBody 的 HttpOperationResponse。

繼承自AutomationClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

傳送 LRO 的初始要求(長時間執行作業),並取得 LROPoller,該 LROPoller 提供輪詢 LRO 的方法,並檢查 LRO 是否已完成。

function sendLRORequest(operationArguments: OperationArguments, operationSpec: OperationSpec, options?: RequestOptionsBase): Promise<LROPoller>

參數

operationArguments
OperationArguments

作業的自變數。

operationSpec
OperationSpec

作業的規格。

options
RequestOptionsBase

提出要求時要傳送的其他選項。

傳回

Promise<@azure/ms-rest-azure-js.LROPoller>

提供與 LRO 互動之方法的 LROPoller 物件。

繼承自AutomationClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

傳送使用提供的 OperationSpec 填入的 HTTP 要求。

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

參數

operationArguments
OperationArguments

HTTP 要求樣板化值的自變數將會從 中填入。

operationSpec
OperationSpec

要用來填入 HTTPRequest 的 OperationSpec。

callback

ServiceCallback<any>

收到回應時要呼叫的回呼。

傳回

Promise<RestResponse>

繼承自AutomationClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

傳送提供的 HTTPRequest。

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

參數

傳回

繼承自AutomationClientContext.sendRequest