@azure/arm-hybridconnectivity package

Classes

HybridConnectivityManagementAPI

Interfaces

AADProfileProperties	The AAD Profile
AwsCloudProfile	cloud profile for AWS.
AwsCloudProfileUpdate	cloud profile for AWS.
EndpointAccessResource	The endpoint access for the target resource.
EndpointProperties	Endpoint details
EndpointResource	The endpoint for the target resource.
EndpointsCreateOrUpdateOptionalParams	Optional parameters.
EndpointsDeleteOptionalParams	Optional parameters.
EndpointsGetOptionalParams	Optional parameters.
EndpointsListCredentialsOptionalParams	Optional parameters.
EndpointsListIngressGatewayCredentialsOptionalParams	Optional parameters.
EndpointsListManagedProxyDetailsOptionalParams	Optional parameters.
EndpointsListOptionalParams	Optional parameters.
EndpointsOperations	Interface representing a Endpoints operations.
EndpointsUpdateOptionalParams	Optional parameters.
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.
ExtensionResource	The base extension resource.
GenerateAwsTemplateOperations	Interface representing a GenerateAwsTemplate operations.
GenerateAwsTemplatePostOptionalParams	Optional parameters.
GenerateAwsTemplateRequest	ConnectorId and SolutionTypes and their properties to Generate AWS CFT Template.
GenerateAwsTemplateResponse	The HybridConnectivity post operation response
HybridConnectivityManagementAPIOptionalParams	Optional parameters for the client.
IngressGatewayResource	The ingress gateway access credentials
IngressProfileProperties	Ingress gateway profile
InventoryGetOptionalParams	Optional parameters.
InventoryListBySolutionConfigurationOptionalParams	Optional parameters.
InventoryOperations	Interface representing a Inventory operations.
InventoryProperties	Definition of inventory.
InventoryResource	Concrete proxy resource types can be created by aliasing this type using a specific property type.
ListCredentialsRequest	The details of the service for which credentials needs to be returned.
ListIngressGatewayCredentialsRequest	Represent ListIngressGatewayCredentials Request object.
ManagedProxyRequest	Represent ManageProxy Request object.
ManagedProxyResource	Managed Proxy
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for and operation.
OperationStatusResult	The current status of an async 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.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PublicCloudConnector	Public Cloud Connector
PublicCloudConnectorProperties	Properties of public cloud connectors.
PublicCloudConnectorPropertiesUpdate	Properties of public cloud connectors.
PublicCloudConnectorUpdate	Public Cloud Connector
PublicCloudConnectorsCreateOrUpdateOptionalParams	Optional parameters.
PublicCloudConnectorsDeleteOptionalParams	Optional parameters.
PublicCloudConnectorsGetOptionalParams	Optional parameters.
PublicCloudConnectorsListByResourceGroupOptionalParams	Optional parameters.
PublicCloudConnectorsListBySubscriptionOptionalParams	Optional parameters.
PublicCloudConnectorsOperations	Interface representing a PublicCloudConnectors operations.
PublicCloudConnectorsTestPermissionsOptionalParams	Optional parameters.
PublicCloudConnectorsUpdateOptionalParams	Optional parameters.
RelayNamespaceAccessProperties	Azure relay hybrid connection access properties
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
ServiceConfigurationProperties	Service configuration details
ServiceConfigurationPropertiesPatch	Service configuration details
ServiceConfigurationResource	The service configuration details associated with the target resource.
ServiceConfigurationResourcePatch	The service details under service configuration for the target endpoint resource.
ServiceConfigurationsCreateOrupdateOptionalParams	Optional parameters.
ServiceConfigurationsDeleteOptionalParams	Optional parameters.
ServiceConfigurationsGetOptionalParams	Optional parameters.
ServiceConfigurationsListByEndpointResourceOptionalParams	Optional parameters.
ServiceConfigurationsOperations	Interface representing a ServiceConfigurations operations.
ServiceConfigurationsUpdateOptionalParams	Optional parameters.
SolutionConfiguration	Solution Configuration
SolutionConfigurationProperties	Solution configuration resource.
SolutionConfigurationPropertiesUpdate	Solution configuration resource.
SolutionConfigurationUpdate	Solution Configuration
SolutionConfigurationsCreateOrUpdateOptionalParams	Optional parameters.
SolutionConfigurationsDeleteOptionalParams	Optional parameters.
SolutionConfigurationsGetOptionalParams	Optional parameters.
SolutionConfigurationsListOptionalParams	Optional parameters.
SolutionConfigurationsOperations	Interface representing a SolutionConfigurations operations.
SolutionConfigurationsSyncNowOptionalParams	Optional parameters.
SolutionConfigurationsUpdateOptionalParams	Optional parameters.
SolutionSettings	Solution settings
SolutionTypeProperties	Definition of Solution type resource.
SolutionTypeResource	Concrete proxy resource types can be created by aliasing this type using a specific property type.
SolutionTypeSettings	The properties of Solution Type
SolutionTypeSettingsProperties	Represent Solution settings properties description array.
SolutionTypesGetOptionalParams	Optional parameters.
SolutionTypesListByResourceGroupOptionalParams	Optional parameters.
SolutionTypesListBySubscriptionOptionalParams	Optional parameters.
SolutionTypesOperations	Interface representing a SolutionTypes operations.
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'
TrackedResourceUpdate	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

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
CloudNativeType	Cloud Native Type enum. KnownCloudNativeType can be used interchangeably with CloudNativeType, this enum contains the known values that the service supports. Known values supported by the service ec2: ec2 enum.
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. <xref: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.
HostType	Enum of host cloud the public cloud connector is referencing. KnownHostType can be used interchangeably with HostType, this enum contains the known values that the service supports. Known values supported by the service AWS: AWS state
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.
ProvisioningState	The resource provisioning state. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Creating Updating Failed Canceled
ResourceProvisioningState	The provisioning state of a resource type. KnownResourceProvisioningState can be used interchangeably with ResourceProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled.
ServiceName	Name of the service. KnownServiceName can be used interchangeably with ServiceName, this enum contains the known values that the service supports. Known values supported by the service SSH WAC
SolutionConfigurationStatus	Solution Configuration Status. KnownSolutionConfigurationStatus can be used interchangeably with SolutionConfigurationStatus, this enum contains the known values that the service supports. Known values supported by the service New: New status InProgress: InProgress status Completed: Canceled status Failed: Failed status
Type	The type of endpoint. KnownType can be used interchangeably with Type, this enum contains the known values that the service supports. Known values supported by the service default custom

Enums

AzureClouds	An enum to describe Azure Cloud.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownCloudNativeType	Cloud Native Type enum.
KnownCreatedByType	The kind of entity that created the resource.
KnownHostType	Enum of host cloud the public cloud connector is referencing.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProvisioningState	The resource provisioning state.
KnownResourceProvisioningState	The provisioning state of a resource type.
KnownServiceName	Name of the service.
KnownSolutionConfigurationStatus	Solution Configuration Status.
KnownType	The type of endpoint.
KnownVersions	Hybrid Connectivity Management service version.

Functions

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

Parameters

client

HybridConnectivityManagementAPI

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>