Share via

FluidRelayServers interface

Package:
@azure/arm-fluidrelay

Interface representing a FluidRelayServers.

Methods

createOrUpdate(string, string, FluidRelayServer, FluidRelayServersCreateOrUpdateOptionalParams)

Create or Update a Fluid Relay server.
delete(string, string, FluidRelayServersDeleteOptionalParams)

Delete a Fluid Relay server.
get(string, string, FluidRelayServersGetOptionalParams)

Get a Fluid Relay server.
listByResourceGroup(string, FluidRelayServersListByResourceGroupOptionalParams)

List all Fluid Relay servers in a resource group.
listBySubscription(FluidRelayServersListBySubscriptionOptionalParams)

List all Fluid Relay servers in a subscription.
listKeys(string, string, FluidRelayServersListKeysOptionalParams)

Get primary and secondary key for this server.
regenerateKey(string, string, RegenerateKeyRequest, FluidRelayServersRegenerateKeyOptionalParams)

Regenerate the primary or secondary key for this server.
update(string, string, FluidRelayServerUpdate, FluidRelayServersUpdateOptionalParams)

Update a Fluid Relay server.

Method Details

createOrUpdate(string, string, FluidRelayServer, FluidRelayServersCreateOrUpdateOptionalParams)

Create or Update a Fluid Relay server.

function createOrUpdate(resourceGroup: string, fluidRelayServerName: string, resource: FluidRelayServer, options?: FluidRelayServersCreateOrUpdateOptionalParams): Promise<FluidRelayServer>

Parameters

resourceGroup

string

The resource group containing the resource.

fluidRelayServerName

string

The Fluid Relay server resource name.

resource
FluidRelayServer

The details of the Fluid Relay server resource.

options
FluidRelayServersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<FluidRelayServer>

delete(string, string, FluidRelayServersDeleteOptionalParams)

Delete a Fluid Relay server.

function delete(resourceGroup: string, fluidRelayServerName: string, options?: FluidRelayServersDeleteOptionalParams): Promise<void>

Parameters

resourceGroup

string

The resource group containing the resource.

fluidRelayServerName

string

The Fluid Relay server resource name.

options
FluidRelayServersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, FluidRelayServersGetOptionalParams)

Get a Fluid Relay server.

function get(resourceGroup: string, fluidRelayServerName: string, options?: FluidRelayServersGetOptionalParams): Promise<FluidRelayServer>

Parameters

resourceGroup

string

The resource group containing the resource.

fluidRelayServerName

string

The Fluid Relay server resource name.

options
FluidRelayServersGetOptionalParams

The options parameters.

Returns

Promise<FluidRelayServer>

listByResourceGroup(string, FluidRelayServersListByResourceGroupOptionalParams)

List all Fluid Relay servers in a resource group.

function listByResourceGroup(resourceGroup: string, options?: FluidRelayServersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<FluidRelayServer, FluidRelayServer[], PageSettings>

Parameters

resourceGroup

string

The resource group containing the resource.

options
FluidRelayServersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FluidRelayServer, FluidRelayServer[], PageSettings>

listBySubscription(FluidRelayServersListBySubscriptionOptionalParams)

List all Fluid Relay servers in a subscription.

function listBySubscription(options?: FluidRelayServersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<FluidRelayServer, FluidRelayServer[], PageSettings>

Parameters

options
FluidRelayServersListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FluidRelayServer, FluidRelayServer[], PageSettings>

listKeys(string, string, FluidRelayServersListKeysOptionalParams)

Get primary and secondary key for this server.

function listKeys(resourceGroup: string, fluidRelayServerName: string, options?: FluidRelayServersListKeysOptionalParams): Promise<FluidRelayServerKeys>

Parameters

resourceGroup

string

The resource group containing the resource.

fluidRelayServerName

string

The Fluid Relay server resource name.

options
FluidRelayServersListKeysOptionalParams

The options parameters.

Returns

Promise<FluidRelayServerKeys>

regenerateKey(string, string, RegenerateKeyRequest, FluidRelayServersRegenerateKeyOptionalParams)

Regenerate the primary or secondary key for this server.

function regenerateKey(resourceGroup: string, fluidRelayServerName: string, parameters: RegenerateKeyRequest, options?: FluidRelayServersRegenerateKeyOptionalParams): Promise<FluidRelayServerKeys>

Parameters

resourceGroup

string

The resource group containing the resource.

fluidRelayServerName

string

The Fluid Relay server resource name.

parameters
RegenerateKeyRequest

The details of which keys to generate.

options
FluidRelayServersRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<FluidRelayServerKeys>

update(string, string, FluidRelayServerUpdate, FluidRelayServersUpdateOptionalParams)

Update a Fluid Relay server.

function update(resourceGroup: string, fluidRelayServerName: string, resource: FluidRelayServerUpdate, options?: FluidRelayServersUpdateOptionalParams): Promise<FluidRelayServer>

Parameters

resourceGroup

string

The resource group containing the resource.

fluidRelayServerName

string

The Fluid Relay server resource name.

resource
FluidRelayServerUpdate

The details of the Fluid Relay server resource included in update calls.

options
FluidRelayServersUpdateOptionalParams

The options parameters.

Returns

Promise<FluidRelayServer>