WCFRelays interface

Package:

@azure/arm-relay

Interface representing a WCFRelays.

Methods

createOrUpdate(string, string, string, WcfRelay, WCFRelaysCreateOrUpdateOptionalParams)	Creates or updates a WCF relay. This operation is idempotent.
createOrUpdateAuthorizationRule(string, string, string, string, AuthorizationRule, WCFRelaysCreateOrUpdateAuthorizationRuleOptionalParams)	Creates or updates an authorization rule for a WCF relay.
delete(string, string, string, WCFRelaysDeleteOptionalParams)	Deletes a WCF relay.
deleteAuthorizationRule(string, string, string, string, WCFRelaysDeleteAuthorizationRuleOptionalParams)	Deletes a WCF relay authorization rule.
get(string, string, string, WCFRelaysGetOptionalParams)	Returns the description for the specified WCF relay.
getAuthorizationRule(string, string, string, string, WCFRelaysGetAuthorizationRuleOptionalParams)	Get authorizationRule for a WCF relay by name.
listAuthorizationRules(string, string, string, WCFRelaysListAuthorizationRulesOptionalParams)	Authorization rules for a WCF relay.
listByNamespace(string, string, WCFRelaysListByNamespaceOptionalParams)	Lists the WCF relays within the namespace.
listKeys(string, string, string, string, WCFRelaysListKeysOptionalParams)	Primary and secondary connection strings to the WCF relay.
regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, WCFRelaysRegenerateKeysOptionalParams)	Regenerates the primary or secondary connection strings to the WCF relay.

Method Details

createOrUpdate(string, string, string, WcfRelay, WCFRelaysCreateOrUpdateOptionalParams)

Creates or updates a WCF relay. This operation is idempotent.

function createOrUpdate(resourceGroupName: string, namespaceName: string, relayName: string, parameters: WcfRelay, options?: WCFRelaysCreateOrUpdateOptionalParams): Promise<WcfRelay>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

relayName

string

The relay name.

parameters

WcfRelay

Parameters supplied to create a WCF relay.

options

WCFRelaysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<WcfRelay>

createOrUpdateAuthorizationRule(string, string, string, string, AuthorizationRule, WCFRelaysCreateOrUpdateAuthorizationRuleOptionalParams)

Creates or updates an authorization rule for a WCF relay.

function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, parameters: AuthorizationRule, options?: WCFRelaysCreateOrUpdateAuthorizationRuleOptionalParams): Promise<AuthorizationRule>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

relayName

string

The relay name.

authorizationRuleName

string

The authorization rule name.

parameters

AuthorizationRule

The authorization rule parameters.

options

WCFRelaysCreateOrUpdateAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<AuthorizationRule>

delete(string, string, string, WCFRelaysDeleteOptionalParams)

Deletes a WCF relay.

function delete(resourceGroupName: string, namespaceName: string, relayName: string, options?: WCFRelaysDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

relayName

string

The relay name.

options

WCFRelaysDeleteOptionalParams

The options parameters.

Returns

Promise<void>

deleteAuthorizationRule(string, string, string, string, WCFRelaysDeleteAuthorizationRuleOptionalParams)

Deletes a WCF relay authorization rule.

function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, options?: WCFRelaysDeleteAuthorizationRuleOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

relayName

string

The relay name.

authorizationRuleName

string

The authorization rule name.

options

WCFRelaysDeleteAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, WCFRelaysGetOptionalParams)

Returns the description for the specified WCF relay.

function get(resourceGroupName: string, namespaceName: string, relayName: string, options?: WCFRelaysGetOptionalParams): Promise<WcfRelay>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

relayName

string

The relay name.

options

WCFRelaysGetOptionalParams

The options parameters.

Returns

Promise<WcfRelay>

getAuthorizationRule(string, string, string, string, WCFRelaysGetAuthorizationRuleOptionalParams)

Get authorizationRule for a WCF relay by name.

function getAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, options?: WCFRelaysGetAuthorizationRuleOptionalParams): Promise<AuthorizationRule>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

relayName

string

The relay name.

authorizationRuleName

string

The authorization rule name.

options

WCFRelaysGetAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<AuthorizationRule>

listAuthorizationRules(string, string, string, WCFRelaysListAuthorizationRulesOptionalParams)

Authorization rules for a WCF relay.

function listAuthorizationRules(resourceGroupName: string, namespaceName: string, relayName: string, options?: WCFRelaysListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<AuthorizationRule, AuthorizationRule[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

relayName

string

The relay name.

options

WCFRelaysListAuthorizationRulesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AuthorizationRule, AuthorizationRule[], PageSettings>

listByNamespace(string, string, WCFRelaysListByNamespaceOptionalParams)

Lists the WCF relays within the namespace.

function listByNamespace(resourceGroupName: string, namespaceName: string, options?: WCFRelaysListByNamespaceOptionalParams): PagedAsyncIterableIterator<WcfRelay, WcfRelay[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

options

WCFRelaysListByNamespaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WcfRelay, WcfRelay[], PageSettings>

listKeys(string, string, string, string, WCFRelaysListKeysOptionalParams)

Primary and secondary connection strings to the WCF relay.

function listKeys(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, options?: WCFRelaysListKeysOptionalParams): Promise<AccessKeys>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

relayName

string

The relay name.

authorizationRuleName

string

The authorization rule name.

options

WCFRelaysListKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>

regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, WCFRelaysRegenerateKeysOptionalParams)

Regenerates the primary or secondary connection strings to the WCF relay.

function regenerateKeys(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: WCFRelaysRegenerateKeysOptionalParams): Promise<AccessKeys>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

relayName

string

The relay name.

authorizationRuleName

string

The authorization rule name.

parameters

RegenerateAccessKeyParameters

Parameters supplied to regenerate authorization rule.

options

WCFRelaysRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>