@azure/arm-relay package
Classes
| RelayAPI |
Interfaces
| AccessKeys |
Namespace/Relay Connection String |
| AuthorizationRule |
Description of a namespace authorization rule. |
| AuthorizationRuleListResult |
The response from the list namespace operation. |
| CheckNameAvailability |
Description of the check name availability request properties. |
| CheckNameAvailabilityResult |
Description of the check name availability request properties. |
| ErrorResponse |
Error reponse indicates Relay service is not able to process the incoming request. The reason is provided in the error message. |
| HybridConnection |
Description of hybrid connection resource. |
| HybridConnectionListResult |
The response of the list hybrid connection operation. |
| HybridConnections |
Interface representing a HybridConnections. |
| HybridConnectionsCreateOrUpdateAuthorizationRuleOptionalParams |
Optional parameters. |
| HybridConnectionsCreateOrUpdateOptionalParams |
Optional parameters. |
| HybridConnectionsDeleteAuthorizationRuleOptionalParams |
Optional parameters. |
| HybridConnectionsDeleteOptionalParams |
Optional parameters. |
| HybridConnectionsGetAuthorizationRuleOptionalParams |
Optional parameters. |
| HybridConnectionsGetOptionalParams |
Optional parameters. |
| HybridConnectionsListAuthorizationRulesNextOptionalParams |
Optional parameters. |
| HybridConnectionsListAuthorizationRulesOptionalParams |
Optional parameters. |
| HybridConnectionsListByNamespaceNextOptionalParams |
Optional parameters. |
| HybridConnectionsListByNamespaceOptionalParams |
Optional parameters. |
| HybridConnectionsListKeysOptionalParams |
Optional parameters. |
| HybridConnectionsRegenerateKeysOptionalParams |
Optional parameters. |
| Namespaces |
Interface representing a Namespaces. |
| NamespacesCheckNameAvailabilityOptionalParams |
Optional parameters. |
| NamespacesCreateOrUpdateAuthorizationRuleOptionalParams |
Optional parameters. |
| NamespacesCreateOrUpdateOptionalParams |
Optional parameters. |
| NamespacesDeleteAuthorizationRuleOptionalParams |
Optional parameters. |
| NamespacesDeleteOptionalParams |
Optional parameters. |
| NamespacesGetAuthorizationRuleOptionalParams |
Optional parameters. |
| NamespacesGetOptionalParams |
Optional parameters. |
| NamespacesListAuthorizationRulesNextOptionalParams |
Optional parameters. |
| NamespacesListAuthorizationRulesOptionalParams |
Optional parameters. |
| NamespacesListByResourceGroupNextOptionalParams |
Optional parameters. |
| NamespacesListByResourceGroupOptionalParams |
Optional parameters. |
| NamespacesListKeysOptionalParams |
Optional parameters. |
| NamespacesListNextOptionalParams |
Optional parameters. |
| NamespacesListOptionalParams |
Optional parameters. |
| NamespacesRegenerateKeysOptionalParams |
Optional parameters. |
| NamespacesUpdateOptionalParams |
Optional parameters. |
| Operation |
A Relay REST API operation. |
| OperationDisplay |
The object that represents the operation. |
| OperationListResult |
Result of the request to list Relay operations. It contains a list of operations and a URL link to get the next set of results. |
| Operations |
Interface representing a Operations. |
| OperationsListNextOptionalParams |
Optional parameters. |
| OperationsListOptionalParams |
Optional parameters. |
| RegenerateAccessKeyParameters |
Parameters supplied to the regenerate authorization rule operation, specifies which key neeeds to be reset. |
| RelayAPIOptionalParams |
Optional parameters. |
| RelayNamespace |
Description of a namespace resource. |
| RelayNamespaceListResult |
The response from the list namespace operation. |
| RelayUpdateParameters |
Description of a namespace resource. |
| Resource |
The resource definition. |
| ResourceNamespacePatch |
Definition of resource. |
| Sku |
SKU of the namespace. |
| TrackedResource |
Definition of resource. |
| WCFRelays |
Interface representing a WCFRelays. |
| WCFRelaysCreateOrUpdateAuthorizationRuleOptionalParams |
Optional parameters. |
| WCFRelaysCreateOrUpdateOptionalParams |
Optional parameters. |
| WCFRelaysDeleteAuthorizationRuleOptionalParams |
Optional parameters. |
| WCFRelaysDeleteOptionalParams |
Optional parameters. |
| WCFRelaysGetAuthorizationRuleOptionalParams |
Optional parameters. |
| WCFRelaysGetOptionalParams |
Optional parameters. |
| WCFRelaysListAuthorizationRulesNextOptionalParams |
Optional parameters. |
| WCFRelaysListAuthorizationRulesOptionalParams |
Optional parameters. |
| WCFRelaysListByNamespaceNextOptionalParams |
Optional parameters. |
| WCFRelaysListByNamespaceOptionalParams |
Optional parameters. |
| WCFRelaysListKeysOptionalParams |
Optional parameters. |
| WCFRelaysRegenerateKeysOptionalParams |
Optional parameters. |
| WcfRelay |
Description of the WCF relay resource. |
| WcfRelaysListResult |
The response of the list WCF relay operation. |
Type Aliases
| AccessRights |
Defines values for AccessRights. |
| HybridConnectionsCreateOrUpdateAuthorizationRuleResponse |
Contains response data for the createOrUpdateAuthorizationRule operation. |
| HybridConnectionsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| HybridConnectionsGetAuthorizationRuleResponse |
Contains response data for the getAuthorizationRule operation. |
| HybridConnectionsGetResponse |
Contains response data for the get operation. |
| HybridConnectionsListAuthorizationRulesNextResponse |
Contains response data for the listAuthorizationRulesNext operation. |
| HybridConnectionsListAuthorizationRulesResponse |
Contains response data for the listAuthorizationRules operation. |
| HybridConnectionsListByNamespaceNextResponse |
Contains response data for the listByNamespaceNext operation. |
| HybridConnectionsListByNamespaceResponse |
Contains response data for the listByNamespace operation. |
| HybridConnectionsListKeysResponse |
Contains response data for the listKeys operation. |
| HybridConnectionsRegenerateKeysResponse |
Contains response data for the regenerateKeys operation. |
| KeyType |
Defines values for KeyType. |
| NamespacesCheckNameAvailabilityResponse |
Contains response data for the checkNameAvailability operation. |
| NamespacesCreateOrUpdateAuthorizationRuleResponse |
Contains response data for the createOrUpdateAuthorizationRule operation. |
| NamespacesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| NamespacesGetAuthorizationRuleResponse |
Contains response data for the getAuthorizationRule operation. |
| NamespacesGetResponse |
Contains response data for the get operation. |
| NamespacesListAuthorizationRulesNextResponse |
Contains response data for the listAuthorizationRulesNext operation. |
| NamespacesListAuthorizationRulesResponse |
Contains response data for the listAuthorizationRules operation. |
| NamespacesListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| NamespacesListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| NamespacesListKeysResponse |
Contains response data for the listKeys operation. |
| NamespacesListNextResponse |
Contains response data for the listNext operation. |
| NamespacesListResponse |
Contains response data for the list operation. |
| NamespacesRegenerateKeysResponse |
Contains response data for the regenerateKeys operation. |
| NamespacesUpdateResponse |
Contains response data for the update operation. |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| ProvisioningStateEnum |
Defines values for ProvisioningStateEnum. |
| Relaytype |
Defines values for Relaytype. |
| UnavailableReason |
Defines values for UnavailableReason. |
| WCFRelaysCreateOrUpdateAuthorizationRuleResponse |
Contains response data for the createOrUpdateAuthorizationRule operation. |
| WCFRelaysCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| WCFRelaysGetAuthorizationRuleResponse |
Contains response data for the getAuthorizationRule operation. |
| WCFRelaysGetResponse |
Contains response data for the get operation. |
| WCFRelaysListAuthorizationRulesNextResponse |
Contains response data for the listAuthorizationRulesNext operation. |
| WCFRelaysListAuthorizationRulesResponse |
Contains response data for the listAuthorizationRules operation. |
| WCFRelaysListByNamespaceNextResponse |
Contains response data for the listByNamespaceNext operation. |
| WCFRelaysListByNamespaceResponse |
Contains response data for the listByNamespace operation. |
| WCFRelaysListKeysResponse |
Contains response data for the listKeys operation. |
| WCFRelaysRegenerateKeysResponse |
Contains response data for the regenerateKeys operation. |
Functions
| get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value produced by the byPage iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefinedParameters
- page
-
unknown
An object from accessing value on the IteratorResult from a byPage iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.