@azure/arm-fluidrelay package

Classes

FluidRelayManagementClient

Interfaces

CustomerManagedKeyEncryptionProperties

All Customer-managed key encryption properties for the resource.

CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity

All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.

EncryptionProperties

All encryption configuration for a resource.

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. (This also follows the OData error response format.).

FluidRelayContainer

A FluidRelay Container.

FluidRelayContainerList

Paged response

FluidRelayContainers

Interface representing a FluidRelayContainers.

FluidRelayContainersDeleteOptionalParams

Optional parameters.

FluidRelayContainersGetOptionalParams

Optional parameters.

FluidRelayContainersListByFluidRelayServersNextOptionalParams

Optional parameters.

FluidRelayContainersListByFluidRelayServersOptionalParams

Optional parameters.

FluidRelayEndpoints

The Fluid Relay endpoints for this server

FluidRelayManagementClientOptionalParams

Optional parameters.

FluidRelayOperations

Interface representing a FluidRelayOperations.

FluidRelayOperationsListNextOptionalParams

Optional parameters.

FluidRelayOperationsListOptionalParams

Optional parameters.

FluidRelayServer

A FluidRelay Server.

FluidRelayServerKeys

The set of available keys for this server.

FluidRelayServerList

Paged response

FluidRelayServerUpdate

The updatable properties of a Fluid Relay server

FluidRelayServers

Interface representing a FluidRelayServers.

FluidRelayServersCreateOrUpdateOptionalParams

Optional parameters.

FluidRelayServersDeleteOptionalParams

Optional parameters.

FluidRelayServersGetOptionalParams

Optional parameters.

FluidRelayServersListByResourceGroupNextOptionalParams

Optional parameters.

FluidRelayServersListByResourceGroupOptionalParams

Optional parameters.

FluidRelayServersListBySubscriptionNextOptionalParams

Optional parameters.

FluidRelayServersListBySubscriptionOptionalParams

Optional parameters.

FluidRelayServersListKeysOptionalParams

Optional parameters.

FluidRelayServersRegenerateKeyOptionalParams

Optional parameters.

FluidRelayServersUpdateOptionalParams

Optional parameters.

Identity

Identity for the resource.

OperationDisplay

The object that represents the operation.

OperationListResult

Result of GET request to list FluidRelay operations.

OperationResult

A FluidRelay REST API operation.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

RegenerateKeyRequest

Specifies which key should be generated.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

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'

UserAssignedIdentitiesValue

Type Aliases

CmkIdentityType

Defines values for CmkIdentityType.

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

FluidRelayContainersGetResponse

Contains response data for the get operation.

FluidRelayContainersListByFluidRelayServersNextResponse

Contains response data for the listByFluidRelayServersNext operation.

FluidRelayContainersListByFluidRelayServersResponse

Contains response data for the listByFluidRelayServers operation.

FluidRelayOperationsListNextResponse

Contains response data for the listNext operation.

FluidRelayOperationsListResponse

Contains response data for the list operation.

FluidRelayServersCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

FluidRelayServersGetResponse

Contains response data for the get operation.

FluidRelayServersListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

FluidRelayServersListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

FluidRelayServersListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

FluidRelayServersListBySubscriptionResponse

Contains response data for the listBySubscription operation.

FluidRelayServersListKeysResponse

Contains response data for the listKeys operation.

FluidRelayServersRegenerateKeyResponse

Contains response data for the regenerateKey operation.

FluidRelayServersUpdateResponse

Contains response data for the update operation.

KeyName

Defines values for KeyName.

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Failed
Canceled

ResourceIdentityType

Defines values for ResourceIdentityType.

StorageSKU

Defines values for StorageSKU.
KnownStorageSKU can be used interchangeably with StorageSKU, this enum contains the known values that the service supports.

Known values supported by the service

standard
basic

Enums

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownStorageSKU

Known values of StorageSKU that the service accepts.

Functions

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 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 | undefined

Parameters

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.