@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.
ApplianceOperation	Appliances operation.
ApplianceOperationValueDisplay	Describes the properties of an Appliances Operation Value Display.
ApplianceProperties	Properties for an appliance.
AppliancePropertiesInfrastructureConfig	Contains infrastructure information about the Appliance
AppliancesCreateOrUpdateOptionalParams	Optional parameters.
AppliancesDeleteOptionalParams	Optional parameters.
AppliancesGetOptionalParams	Optional parameters.
AppliancesGetTelemetryConfigOptionalParams	Optional parameters.
AppliancesGetUpgradeGraphOptionalParams	Optional parameters.
AppliancesListByResourceGroupOptionalParams	Optional parameters.
AppliancesListBySubscriptionOptionalParams	Optional parameters.
AppliancesListClusterUserCredentialOptionalParams	Optional parameters.
AppliancesListKeysOptionalParams	Optional parameters.
AppliancesListOperationsOptionalParams	Optional parameters.
AppliancesOperations	Interface representing a Appliances operations.
AppliancesUpdateOptionalParams	Optional parameters.
ArtifactProfile	Appliance ArtifactProfile definition.
DnsConfiguration	Contains DNS information about the Appliance
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.
Event	Event contains information about customer driven, platform driven, or unplanned events that occurred on the Appliance
GatewayConfiguration	Contains Arc Gateway information about the Appliance
HybridConnectionConfig	Contains the REP (rendezvous endpoint) and “Listener” access token from notification service (NS).
Identity	Identity for the resource.
NetworkProfile	Contains network information about the Appliance
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PatchableAppliance	The Appliances patchable resource definition.
ProxyConfiguration	Contains proxy information about the Appliance
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceConnectorManagementClientOptionalParams	Optional parameters for the client.
RestorePollerOptions
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	Name which contains the role of the kubeconfig. 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
ArtifactType	Appliance ArtifactType definition. KnownArtifactType can be used interchangeably with ArtifactType, this enum contains the known values that the service supports. Known values supported by the service LogsArtifactType
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.
Distro	Represents a supported Fabric/Infra. (AKSEdge etc...). 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	Information about the connected appliance. 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
ResourceIdentityType	The identity type. 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	Appliance SSHKeyType definition. 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 UserManagementKey
Status	Appliance’s health and state of connection to on-prem. This list of values is not exhaustive. 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 ETCDSnapshotFailed UpgradePrerequisitesCompleted ValidatingSFSConnectivity ValidatingImageDownload ValidatingImageUpload ValidatingETCDHealth PreUpgrade UpgradingKVAIO WaitingForKVAIO ImagePending ImageProvisioning ImageProvisioned ImageDownloading ImageDownloaded ImageDeprovisioning ImageUnknown UpdatingCloudOperator WaitingForCloudOperator UpdatingCAPI UpdatingCluster PostUpgrade UpgradeComplete UpgradeClusterExtensionFailedToDelete UpgradeFailed Offline None NetworkProxyUpdatePreparing NetworkProxyUpdating NetworkProxyUpdateComplete NetworkProxyUpdateFailed NetworkDNSUpdatePreparing NetworkDNSUpdating NetworkDNSUpdateComplete NetworkDNSUpdateFailed ArcGatewayUpdatePreparing ArcGatewayUpdating ArcGatewayUpdateComplete ArcGatewayUpdateFailed

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccessProfileType	Name which contains the role of the kubeconfig.
KnownArtifactType	Appliance ArtifactType definition.
KnownCreatedByType	The kind of entity that created the resource.
KnownDistro	Represents a supported Fabric/Infra. (AKSEdge etc...).
KnownProvider	Information about the connected appliance.
KnownResourceIdentityType	The identity type.
KnownSSHKeyType	Appliance SSHKeyType definition.
KnownStatus	Appliance’s health and state of connection to on-prem. This list of values is not exhaustive.
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(ResourceConnectorManagementClient, 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 Details

restorePoller<TResponse, TResult>(ResourceConnectorManagementClient, 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: ResourceConnectorManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

ResourceConnectorManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>