Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WCFRelays

Package version

Class representing a WCFRelays.

Hierarchy

  • WCFRelays

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • createOrUpdate(resourceGroupName: string, namespaceName: string, relayName: string, parameters: WcfRelay, options?: msRest.RequestOptionsBase): Promise<Models.WCFRelaysCreateOrUpdateResponse>
  • createOrUpdate(resourceGroupName: string, namespaceName: string, relayName: string, parameters: WcfRelay, callback: msRest.ServiceCallback<WcfRelay>): void
  • createOrUpdate(resourceGroupName: string, namespaceName: string, relayName: string, parameters: WcfRelay, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WcfRelay>): void

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

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WCFRelaysCreateOrUpdateResponse>

    Promise<Models.WCFRelaysCreateOrUpdateResponse>

  • 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.

    • callback: msRest.ServiceCallback<WcfRelay>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<WcfRelay>

      The callback

    Returns void

createOrUpdateAuthorizationRule

  • createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, parameters: AuthorizationRule, options?: msRest.RequestOptionsBase): Promise<Models.WCFRelaysCreateOrUpdateAuthorizationRuleResponse>
  • createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, parameters: AuthorizationRule, callback: msRest.ServiceCallback<AuthorizationRule>): void
  • createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, parameters: AuthorizationRule, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AuthorizationRule>): void

  • Creates or updates an authorization rule for a WCF relay.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WCFRelaysCreateOrUpdateAuthorizationRuleResponse>

    Promise<Models.WCFRelaysCreateOrUpdateAuthorizationRuleResponse>

  • 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.

    • callback: msRest.ServiceCallback<AuthorizationRule>

      The callback

    Returns 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.

    • parameters: AuthorizationRule

      The authorization rule parameters.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AuthorizationRule>

      The callback

    Returns void

deleteAuthorizationRule

  • deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, callback: msRest.ServiceCallback<void>): void
  • deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes a WCF relay authorization rule.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • 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.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, namespaceName: string, relayName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, namespaceName: string, relayName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, namespaceName: string, relayName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes a WCF relay.

    Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • relayName: string

      The relay name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • relayName: string

      The relay name.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • relayName: string

      The relay name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, namespaceName: string, relayName: string, options?: msRest.RequestOptionsBase): Promise<Models.WCFRelaysGetResponse>
  • get(resourceGroupName: string, namespaceName: string, relayName: string, callback: msRest.ServiceCallback<WcfRelay>): void
  • get(resourceGroupName: string, namespaceName: string, relayName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WcfRelay>): void

  • Returns the description for the specified WCF relay.

    Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • relayName: string

      The relay name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WCFRelaysGetResponse>

    Promise<Models.WCFRelaysGetResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • relayName: string

      The relay name.

    • callback: msRest.ServiceCallback<WcfRelay>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • relayName: string

      The relay name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<WcfRelay>

      The callback

    Returns void

getAuthorizationRule

  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, options?: msRest.RequestOptionsBase): Promise<Models.WCFRelaysGetAuthorizationRuleResponse>
  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, callback: msRest.ServiceCallback<AuthorizationRule>): void
  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AuthorizationRule>): void

  • Get authorizationRule for a WCF relay by name.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WCFRelaysGetAuthorizationRuleResponse>

    Promise<Models.WCFRelaysGetAuthorizationRuleResponse>

  • 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.

    • callback: msRest.ServiceCallback<AuthorizationRule>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AuthorizationRule>

      The callback

    Returns void

listAuthorizationRules

  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, relayName: string, options?: msRest.RequestOptionsBase): Promise<Models.WCFRelaysListAuthorizationRulesResponse>
  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, relayName: string, callback: msRest.ServiceCallback<AuthorizationRuleListResult>): void
  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, relayName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AuthorizationRuleListResult>): void

  • Authorization rules for a WCF relay.

    Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • relayName: string

      The relay name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WCFRelaysListAuthorizationRulesResponse>

    Promise<Models.WCFRelaysListAuthorizationRulesResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • relayName: string

      The relay name.

    • callback: msRest.ServiceCallback<AuthorizationRuleListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • relayName: string

      The relay name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AuthorizationRuleListResult>

      The callback

    Returns void

listAuthorizationRulesNext

  • listAuthorizationRulesNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.WCFRelaysListAuthorizationRulesNextResponse>
  • listAuthorizationRulesNext(nextPageLink: string, callback: msRest.ServiceCallback<AuthorizationRuleListResult>): void
  • listAuthorizationRulesNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AuthorizationRuleListResult>): void

  • Authorization rules for a WCF relay.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WCFRelaysListAuthorizationRulesNextResponse>

    Promise<Models.WCFRelaysListAuthorizationRulesNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<AuthorizationRuleListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AuthorizationRuleListResult>

      The callback

    Returns void

listByNamespace

  • listByNamespace(resourceGroupName: string, namespaceName: string, options?: msRest.RequestOptionsBase): Promise<Models.WCFRelaysListByNamespaceResponse>
  • listByNamespace(resourceGroupName: string, namespaceName: string, callback: msRest.ServiceCallback<WcfRelaysListResult>): void
  • listByNamespace(resourceGroupName: string, namespaceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WcfRelaysListResult>): void

  • Lists the WCF relays within the namespace.

    Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WCFRelaysListByNamespaceResponse>

    Promise<Models.WCFRelaysListByNamespaceResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • callback: msRest.ServiceCallback<WcfRelaysListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<WcfRelaysListResult>

      The callback

    Returns void

listByNamespaceNext

  • listByNamespaceNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.WCFRelaysListByNamespaceNextResponse>
  • listByNamespaceNext(nextPageLink: string, callback: msRest.ServiceCallback<WcfRelaysListResult>): void
  • listByNamespaceNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WcfRelaysListResult>): void

  • Lists the WCF relays within the namespace.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WCFRelaysListByNamespaceNextResponse>

    Promise<Models.WCFRelaysListByNamespaceNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<WcfRelaysListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<WcfRelaysListResult>

      The callback

    Returns void

listKeys

  • listKeys(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, options?: msRest.RequestOptionsBase): Promise<Models.WCFRelaysListKeysResponse>
  • listKeys(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, callback: msRest.ServiceCallback<AccessKeys>): void
  • listKeys(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AccessKeys>): void

  • Primary and secondary connection strings to the WCF relay.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WCFRelaysListKeysResponse>

    Promise<Models.WCFRelaysListKeysResponse>

  • 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.

    • callback: msRest.ServiceCallback<AccessKeys>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AccessKeys>

      The callback

    Returns void

regenerateKeys

  • regenerateKeys(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: msRest.RequestOptionsBase): Promise<Models.WCFRelaysRegenerateKeysResponse>
  • regenerateKeys(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, callback: msRest.ServiceCallback<AccessKeys>): void
  • regenerateKeys(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AccessKeys>): void

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

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WCFRelaysRegenerateKeysResponse>

    Promise<Models.WCFRelaysRegenerateKeysResponse>

  • 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.

    • callback: msRest.ServiceCallback<AccessKeys>

      The callback

    Returns 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.

    • parameters: RegenerateAccessKeyParameters

      Parameters supplied to regenerate authorization rule.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AccessKeys>

      The callback

    Returns void

Generated using TypeDoc