你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

AzureStackManagementClient class

扩展

构造函数

AzureStackManagementClient(ServiceClientCredentials | TokenCredential, string, AzureStackManagementClientOptions)

初始化 AzureStackManagementClient 类的新实例。

属性

customerSubscriptions
operations
products
registrations

继承属性

acceptLanguage
apiVersion
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,该 LROLer 提供轮询 LRO 的方法,并检查 LRO 是否已完成。

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

发送使用提供的 OperationSpec 填充的 HTTP 请求。

sendRequest(RequestPrepareOptions | WebResourceLike)

发送提供的 httpRequest。

构造函数详细信息

AzureStackManagementClient(ServiceClientCredentials | TokenCredential, string, AzureStackManagementClientOptions)

初始化 AzureStackManagementClient 类的新实例。

new AzureStackManagementClient(credentials: ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: AzureStackManagementClientOptions)

参数

credentials

ServiceClientCredentials | TokenCredential

客户端连接到 Azure 所需的凭据。 建议使用从 @azure/identity 包实现 TokenCredential 接口的凭据。 有关这些凭据的详细信息,请参阅 https://www.npmjs.com/package/@azure/identity。 还支持从旧包 @azure/ms-rest-nodeauth 和 @azure/ms-rest-browserauth 实现 ServiceClientCredentials 接口的凭据。

subscriptionId

string

唯一标识Microsoft Azure 订阅的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。

options
AzureStackManagementClientOptions

参数选项

属性详细信息

customerSubscriptions

customerSubscriptions: CustomerSubscriptions

属性值

operations

operations: Operations

属性值

products

products: Products

属性值

registrations

registrations: Registrations

属性值

继承属性详细信息

acceptLanguage

acceptLanguage: string

属性值

string

继承自AzureStackManagementClientContext.acceptLanguage

apiVersion

apiVersion?: string

属性值

string

继承自AzureStackManagementClientContext.apiVersion

credentials

credentials: ServiceClientCredentials | TokenCredential

属性值

继承自AzureStackManagementClientContext.credentials

longRunningOperationRetryTimeout

长时间运行的作的重试超时(以秒为单位)。 默认值为 30。

longRunningOperationRetryTimeout?: number

属性值

number

继承自AzureStackManagementClientContext.longRunningOperationRetryTimeout

subscriptionId

subscriptionId: string

属性值

string

继承自AzureStackManagementClientContext.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 交互的方法。

继承自AzureStackManagementClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

从提供的 LROPollState 还原 LROPoller。 此方法可用于在不同的进程或计算机上重新创建 LROPoller。

function restoreLROPoller(lroPollState: LROPollState): LROPoller

参数

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

返回

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

继承自AzureStackManagementClientContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

提供一种机制,用于发出将轮询和提供最终结果的请求。

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

参数

request

RequestPrepareOptions | WebResource

请求对象

options
RequestOptionsBase

发出请求时要发送的其他选项

返回

包含最终轮询请求、响应和 responseBody 的 HttpOperationResponse。

继承自AzureStackManagementClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

发送 LRO(长时间运行的作)的初始请求,并返回一个 LROPoller,该 LROLer 提供轮询 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 对象。

继承自azureStackManagementClientContext.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>

继承自AzureStackManagementClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

发送提供的 httpRequest。

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

参数

返回

继承自AzureStackManagementClientContext.sendRequest