HybridConnections interface

Package:

@azure/arm-relay

Interface representing a HybridConnections.

Methods

createOrUpdate(string, string, string, HybridConnection, HybridConnectionsCreateOrUpdateOptionalParams)	Creates or updates a service hybrid connection. This operation is idempotent.
createOrUpdateAuthorizationRule(string, string, string, string, AuthorizationRule, HybridConnectionsCreateOrUpdateAuthorizationRuleOptionalParams)	Creates or updates an authorization rule for a hybrid connection.
delete(string, string, string, HybridConnectionsDeleteOptionalParams)	Deletes a hybrid connection.
deleteAuthorizationRule(string, string, string, string, HybridConnectionsDeleteAuthorizationRuleOptionalParams)	Deletes a hybrid connection authorization rule.
get(string, string, string, HybridConnectionsGetOptionalParams)	Returns the description for the specified hybrid connection.
getAuthorizationRule(string, string, string, string, HybridConnectionsGetAuthorizationRuleOptionalParams)	Hybrid connection authorization rule for a hybrid connection by name.
listAuthorizationRules(string, string, string, HybridConnectionsListAuthorizationRulesOptionalParams)	Authorization rules for a hybrid connection.
listByNamespace(string, string, HybridConnectionsListByNamespaceOptionalParams)	Lists the hybrid connection within the namespace.
listKeys(string, string, string, string, HybridConnectionsListKeysOptionalParams)	Primary and secondary connection strings to the hybrid connection.
regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, HybridConnectionsRegenerateKeysOptionalParams)	Regenerates the primary or secondary connection strings to the hybrid connection.

Method Details

createOrUpdate(string, string, string, HybridConnection, HybridConnectionsCreateOrUpdateOptionalParams)

Creates or updates a service hybrid connection. This operation is idempotent.

function createOrUpdate(resourceGroupName: string, namespaceName: string, hybridConnectionName: string, parameters: HybridConnection, options?: HybridConnectionsCreateOrUpdateOptionalParams): Promise<HybridConnection>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

hybridConnectionName

string

The hybrid connection name.

parameters

HybridConnection

Parameters supplied to create a hybrid connection.

options

HybridConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<HybridConnection>

createOrUpdateAuthorizationRule(string, string, string, string, AuthorizationRule, HybridConnectionsCreateOrUpdateAuthorizationRuleOptionalParams)

Creates or updates an authorization rule for a hybrid connection.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

hybridConnectionName

string

The hybrid connection name.

authorizationRuleName

string

The authorization rule name.

parameters

AuthorizationRule

The authorization rule parameters.

options

HybridConnectionsCreateOrUpdateAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<AuthorizationRule>

delete(string, string, string, HybridConnectionsDeleteOptionalParams)

Deletes a hybrid connection.

function delete(resourceGroupName: string, namespaceName: string, hybridConnectionName: string, options?: HybridConnectionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

hybridConnectionName

string

The hybrid connection name.

options

HybridConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

deleteAuthorizationRule(string, string, string, string, HybridConnectionsDeleteAuthorizationRuleOptionalParams)

Deletes a hybrid connection authorization rule.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

hybridConnectionName

string

The hybrid connection name.

authorizationRuleName

string

The authorization rule name.

options

HybridConnectionsDeleteAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, HybridConnectionsGetOptionalParams)

Returns the description for the specified hybrid connection.

function get(resourceGroupName: string, namespaceName: string, hybridConnectionName: string, options?: HybridConnectionsGetOptionalParams): Promise<HybridConnection>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

hybridConnectionName

string

The hybrid connection name.

options

HybridConnectionsGetOptionalParams

The options parameters.

Returns

Promise<HybridConnection>

getAuthorizationRule(string, string, string, string, HybridConnectionsGetAuthorizationRuleOptionalParams)

Hybrid connection authorization rule for a hybrid connection by name.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

hybridConnectionName

string

The hybrid connection name.

authorizationRuleName

string

The authorization rule name.

options

HybridConnectionsGetAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<AuthorizationRule>

listAuthorizationRules(string, string, string, HybridConnectionsListAuthorizationRulesOptionalParams)

Authorization rules for a hybrid connection.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

hybridConnectionName

string

The hybrid connection name.

options

HybridConnectionsListAuthorizationRulesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AuthorizationRule, AuthorizationRule[], PageSettings>

listByNamespace(string, string, HybridConnectionsListByNamespaceOptionalParams)

Lists the hybrid connection within the namespace.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

options

HybridConnectionsListByNamespaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<HybridConnection, HybridConnection[], PageSettings>

listKeys(string, string, string, string, HybridConnectionsListKeysOptionalParams)

Primary and secondary connection strings to the hybrid connection.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

hybridConnectionName

string

The hybrid connection name.

authorizationRuleName

string

The authorization rule name.

options

HybridConnectionsListKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>

regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, HybridConnectionsRegenerateKeysOptionalParams)

Regenerates the primary or secondary connection strings to the hybrid connection.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

hybridConnectionName

string

The hybrid connection name.

authorizationRuleName

string

The authorization rule name.

parameters

RegenerateAccessKeyParameters

Parameters supplied to regenerate authorization rule.

options

HybridConnectionsRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>