@azure/arm-resourceconnector package

Classes

ResourceConnectorManagementClient

Interfaces

Appliance

Appliances definition.

ApplianceCredentialKubeconfig

Cluster User Credential appliance.

ApplianceGetTelemetryConfigResult

The Get Telemetry Config Result appliance.

ApplianceListCredentialResults

The List Cluster User Credential appliance.

ApplianceListKeysResults

The List Cluster Keys Results appliance.

ApplianceListResult

The List Appliances operation response.

ApplianceOperation

Appliances operation.

ApplianceOperationsList

Lists of Appliances operations.

AppliancePropertiesInfrastructureConfig

Contains infrastructure information about the Appliance

Appliances

Interface representing a Appliances.

AppliancesCreateOrUpdateOptionalParams

Optional parameters.

AppliancesDeleteOptionalParams

Optional parameters.

AppliancesGetOptionalParams

Optional parameters.

AppliancesGetTelemetryConfigOptionalParams

Optional parameters.

AppliancesGetUpgradeGraphOptionalParams

Optional parameters.

AppliancesListByResourceGroupNextOptionalParams

Optional parameters.

AppliancesListByResourceGroupOptionalParams

Optional parameters.

AppliancesListBySubscriptionNextOptionalParams

Optional parameters.

AppliancesListBySubscriptionOptionalParams

Optional parameters.

AppliancesListClusterUserCredentialOptionalParams

Optional parameters.

AppliancesListKeysOptionalParams

Optional parameters.

AppliancesListOperationsNextOptionalParams

Optional parameters.

AppliancesListOperationsOptionalParams

Optional parameters.

AppliancesUpdateOptionalParams

Optional parameters.

ArtifactProfile

Appliance ArtifactProfile definition.

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

HybridConnectionConfig

Contains the REP (rendezvous endpoint) and “Listener” access token from notification service (NS).

Identity

Identity for the resource.

PatchableAppliance

The Appliances patchable resource definition.

Resource

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

ResourceConnectorManagementClientOptionalParams

Optional parameters.

SSHKey

Appliance SSHKey definition.

SupportedVersion

The SupportedVersion object for appliance.

SupportedVersionCatalogVersion

The SupportedVersionCatalogVersion object for appliance.

SupportedVersionCatalogVersionData

The SupportedVersionCatalogVersionData object for appliance.

SupportedVersionMetadata

The SupportedVersionMetadata object for appliance.

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'

UpgradeGraph

The Upgrade Graph for appliance.

UpgradeGraphProperties

The Upgrade Graph Properties for appliance.

Type Aliases

AccessProfileType

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

Known values supported by the service

clusterUser
clusterCustomerUser

AppliancesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AppliancesGetResponse

Contains response data for the get operation.

AppliancesGetTelemetryConfigResponse

Contains response data for the getTelemetryConfig operation.

AppliancesGetUpgradeGraphResponse

Contains response data for the getUpgradeGraph operation.

AppliancesListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

AppliancesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

AppliancesListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

AppliancesListBySubscriptionResponse

Contains response data for the listBySubscription operation.

AppliancesListClusterUserCredentialResponse

Contains response data for the listClusterUserCredential operation.

AppliancesListKeysResponse

Contains response data for the listKeys operation.

AppliancesListOperationsNextResponse

Contains response data for the listOperationsNext operation.

AppliancesListOperationsResponse

Contains response data for the listOperations operation.

AppliancesUpdateResponse

Contains response data for the update operation.

ArtifactType

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

Known values supported by the service

LogsArtifactType

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

Distro

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

Known values supported by the service

AKSEdge

Provider

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

Known values supported by the service

VMWare
HCI
SCVMM
KubeVirt
OpenStack

ResourceIdentityType

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

Known values supported by the service

SystemAssigned
None

SSHKeyType

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

Known values supported by the service

SSHCustomerUser
ManagementCAKey
LogsKey
ScopedAccessKey

Status

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

Known values supported by the service

WaitingForHeartbeat
Validating
Connecting
Connected
Running
PreparingForUpgrade
UpgradePrerequisitesCompleted
PreUpgrade
UpgradingKVAIO
WaitingForKVAIO
ImagePending
ImageProvisioning
ImageProvisioned
ImageDownloading
ImageDownloaded
ImageDeprovisioning
ImageUnknown
UpdatingCloudOperator
WaitingForCloudOperator
UpdatingCAPI
UpdatingCluster
PostUpgrade
UpgradeComplete
UpgradeClusterExtensionFailedToDelete
UpgradeFailed
Offline
None

Enums

KnownAccessProfileType

Known values of AccessProfileType that the service accepts.

KnownArtifactType

Known values of ArtifactType that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDistro

Known values of Distro that the service accepts.

KnownProvider

Known values of Provider that the service accepts.

KnownResourceIdentityType

Known values of ResourceIdentityType that the service accepts.

KnownSSHKeyType

Known values of SSHKeyType that the service accepts.

KnownStatus

Known values of Status 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.