RelayAPI class

Package:

@azure/arm-relay

Extends

ServiceClient

Constructors

RelayAPI(TokenCredential, string, RelayAPIOptionalParams)

Initializes a new instance of the RelayAPI class.

Properties

$host
apiVersion
hybridConnections
namespaces
operations
subscriptionId
wCFRelays

Inherited Properties

pipeline

The pipeline used by this client to make requests

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)	Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(PipelineRequest)	Send the provided httpRequest.

Constructor Details

RelayAPI(TokenCredential, string, RelayAPIOptionalParams)

Initializes a new instance of the RelayAPI class.

new RelayAPI(credentials: TokenCredential, subscriptionId: string, options?: RelayAPIOptionalParams)

Parameters

credentials

TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options

RelayAPIOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

apiVersion

apiVersion: string

Property Value

string

hybridConnections

hybridConnections: HybridConnections

Property Value

HybridConnections

namespaces

namespaces: Namespaces

Property Value

Namespaces

operations

operations: Operations

Property Value

Operations

subscriptionId

subscriptionId: string

Property Value

string

wCFRelays

wCFRelays: WCFRelays

Property Value

WCFRelays

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

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