@azure/arm-relay package

Classes

RelayAPI

Interfaces

AccessKeys	Namespace/Relay Connection String
AuthorizationRule	Single item in a List or Get AuthorizationRule operation
AuthorizationRuleProperties	Properties supplied to create or update AuthorizationRule
CheckNameAvailability	Description of the check name availability request properties.
CheckNameAvailabilityResult	Description of the check name availability request properties.
ConnectionState	ConnectionState information.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
HybridConnection	Description of hybrid connection resource.
HybridConnectionProperties	Properties of the HybridConnection.
HybridConnectionsCreateOrUpdateAuthorizationRuleOptionalParams	Optional parameters.
HybridConnectionsCreateOrUpdateOptionalParams	Optional parameters.
HybridConnectionsDeleteAuthorizationRuleOptionalParams	Optional parameters.
HybridConnectionsDeleteOptionalParams	Optional parameters.
HybridConnectionsGetAuthorizationRuleOptionalParams	Optional parameters.
HybridConnectionsGetOptionalParams	Optional parameters.
HybridConnectionsListAuthorizationRulesOptionalParams	Optional parameters.
HybridConnectionsListByNamespaceOptionalParams	Optional parameters.
HybridConnectionsListKeysOptionalParams	Optional parameters.
HybridConnectionsOperations	Interface representing a HybridConnections operations.
HybridConnectionsRegenerateKeysOptionalParams	Optional parameters.
NWRuleSetIpRules	The response from the List namespace operation.
NamespacesCheckNameAvailabilityOptionalParams	Optional parameters.
NamespacesCreateOrUpdateAuthorizationRuleOptionalParams	Optional parameters.
NamespacesCreateOrUpdateNetworkRuleSetOptionalParams	Optional parameters.
NamespacesCreateOrUpdateOptionalParams	Optional parameters.
NamespacesDeleteAuthorizationRuleOptionalParams	Optional parameters.
NamespacesDeleteOptionalParams	Optional parameters.
NamespacesGetAuthorizationRuleOptionalParams	Optional parameters.
NamespacesGetNetworkRuleSetOptionalParams	Optional parameters.
NamespacesGetOptionalParams	Optional parameters.
NamespacesListAuthorizationRulesOptionalParams	Optional parameters.
NamespacesListByResourceGroupOptionalParams	Optional parameters.
NamespacesListKeysOptionalParams	Optional parameters.
NamespacesListOptionalParams	Optional parameters.
NamespacesOperations	Interface representing a Namespaces operations.
NamespacesRegenerateKeysOptionalParams	Optional parameters.
NamespacesUpdateOptionalParams	Optional parameters.
NetworkRuleSet	Description of topic resource.
NetworkRuleSetProperties	NetworkRuleSet properties
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateEndpoint	PrivateEndpoint information.
PrivateEndpointConnection	Properties of the PrivateEndpointConnection.
PrivateEndpointConnectionProperties	Properties of the private endpoint connection resource.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateLinkResource	A resource that supports private link capabilities.
PrivateLinkResourceProperties	Properties of PrivateLinkResource
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListOptionalParams	Optional parameters.
PrivateLinkResourcesListResult	Result of the List private link resources operation.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RegenerateAccessKeyParameters	Parameters supplied to the regenerate authorization rule operation, specifies which key needs to be reset.
RelayAPIOptionalParams	Optional parameters for the client.
RelayNamespace	Description of a namespace resource.
RelayNamespaceProperties	Properties of the namespace.
RelayUpdateParameters	Description of a namespace resource.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceNamespacePatch	Definition of resource.
RestorePollerOptions
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	SKU of the namespace.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
WcfRelay	Description of the WCF relay resource.
WcfRelayProperties	Properties of the WCF relay.
wCFRelaysCreateOrUpdateAuthorizationRuleOptionalParams	Optional parameters.
wCFRelaysCreateOrUpdateOptionalParams	Optional parameters.
wCFRelaysDeleteAuthorizationRuleOptionalParams	Optional parameters.
wCFRelaysDeleteOptionalParams	Optional parameters.
wCFRelaysGetAuthorizationRuleOptionalParams	Optional parameters.
wCFRelaysGetOptionalParams	Optional parameters.
wCFRelaysListAuthorizationRulesOptionalParams	Optional parameters.
wCFRelaysListByNamespaceOptionalParams	Optional parameters.
wCFRelaysListKeysOptionalParams	Optional parameters.
wCFRelaysOperations	Interface representing a wCFRelays operations.
wCFRelaysRegenerateKeysOptionalParams	Optional parameters.

Type Aliases

AccessRights	Type of AccessRights
ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DefaultAction	Default Action for Network Rule Set KnownDefaultAction can be used interchangeably with DefaultAction, this enum contains the known values that the service supports. Known values supported by the service Allow Deny
EndPointProvisioningState	Provisioning state of the Private Endpoint Connection. KnownEndPointProvisioningState can be used interchangeably with EndPointProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed
KeyType	The access key to regenerate. KnownKeyType can be used interchangeably with KeyType, this enum contains the known values that the service supports. Known values supported by the service PrimaryKey SecondaryKey
NetworkRuleIPAction	The IP Filter Action KnownNetworkRuleIPAction can be used interchangeably with NetworkRuleIPAction, this enum contains the known values that the service supports. Known values supported by the service Allow
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
PrivateLinkConnectionStatus	Status of the connection. KnownPrivateLinkConnectionStatus can be used interchangeably with PrivateLinkConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected Disconnected
PublicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled SecuredByPerimeter
Relaytype	WCF relay type.
SkuName	Name of this SKU. KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports. Known values supported by the service Standard
SkuTier	The tier of this SKU. KnownSkuTier can be used interchangeably with SkuTier, this enum contains the known values that the service supports. Known values supported by the service Standard
UnavailableReason	Specifies the reason for the unavailability of the service. KnownUnavailableReason can be used interchangeably with UnavailableReason, this enum contains the known values that the service supports. Known values supported by the service None InvalidName SubscriptionIsDisabled NameInUse NameInLockdown TooManyNamespaceInCurrentSubscription

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccessRights	Known values of AccessRights that the service accepts.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownCreatedByType	The kind of entity that created the resource.
KnownDefaultAction	Default Action for Network Rule Set
KnownEndPointProvisioningState	Provisioning state of the Private Endpoint Connection.
KnownKeyType	The access key to regenerate.
KnownNetworkRuleIPAction	The IP Filter Action
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPrivateLinkConnectionStatus	Status of the connection.
KnownPublicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled.
KnownSkuName	Name of this SKU.
KnownSkuTier	The tier of this SKU.
KnownUnavailableReason	Specifies the reason for the unavailability of the service.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(RelayAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(RelayAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: RelayAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

RelayAPI

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor