ServicemapManagementClient class

Package:

@azure/arm-servicemap

Extends

ServicemapManagementClientContext

Constructors

ServicemapManagementClient(ServiceClientCredentials | TokenCredential, string, ServicemapManagementClientOptions)

Initializes a new instance of the ServicemapManagementClient class.

Properties

clientGroups
machineGroups
machines
maps
ports
processes
summaries

Inherited Properties

acceptLanguage
apiVersion
credentials
longRunningOperationRetryTimeout	The retry timeout in seconds for Long Running Operations. Default value is 30.
subscriptionId

Inherited Methods

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.
restoreLROPoller(LROPollState)	Restore an LROPoller from the provided LROPollState. This method can be used to recreate an LROPoller on a different process or machine.
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)	Provides a mechanism to make a request that will poll and provide the final result.
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.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)	Send the provided httpRequest.

Constructor Details

ServicemapManagementClient(ServiceClientCredentials | TokenCredential, string, ServicemapManagementClientOptions)

Initializes a new instance of the ServicemapManagementClient class.

new ServicemapManagementClient(credentials: ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: ServicemapManagementClientOptions)

Parameters

credentials

ServiceClientCredentials | TokenCredential

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

Azure subscription identifier.

options

ServicemapManagementClientOptions

The parameter options

Property Details

clientGroups

clientGroups: ClientGroups

Property Value

ClientGroups

machineGroups

machineGroups: MachineGroups

Property Value

MachineGroups

machines

machines: Machines

Property Value

Machines

maps

maps: Maps

Property Value

Maps

ports

ports: Ports

Property Value

Ports

processes

processes: Processes

Property Value

Processes

summaries

summaries: Summaries

Property Value

Summaries

Inherited Property Details

acceptLanguage

acceptLanguage: string

Property Value

string

Inherited From ServicemapManagementClientContext.acceptLanguage

apiVersion

apiVersion?: string

Property Value

string

Inherited From ServicemapManagementClientContext.apiVersion

credentials

credentials: ServiceClientCredentials | TokenCredential

Property Value

ServiceClientCredentials | TokenCredential

Inherited From ServicemapManagementClientContext.credentials

longRunningOperationRetryTimeout

The retry timeout in seconds for Long Running Operations. Default value is 30.

longRunningOperationRetryTimeout?: number

Property Value

number

Inherited From ServicemapManagementClientContext.longRunningOperationRetryTimeout

subscriptionId

subscriptionId: string

Property Value

string

Inherited From ServicemapManagementClientContext.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

RequestPrepareOptions | WebResource

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 ServicemapManagementClientContext.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): LROPoller

Parameters

lroPollState

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

Returns

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

Inherited From ServicemapManagementClientContext.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

RequestPrepareOptions | WebResource

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 ServicemapManagementClientContext.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 ServicemapManagementClientContext.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 ServicemapManagementClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

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

Parameters

options

RequestPrepareOptions | WebResourceLike

Returns

Promise<HttpOperationResponse>

Inherited From ServicemapManagementClientContext.sendRequest