@azure/arm-appnetwork package

Classes

AppLinkClient

Interfaces

AppLink	An Azure Kubernetes Application Network resource.
AppLinkClientOptionalParams	Optional parameters for the client.
AppLinkMember	A member of an Azure Kubernetes Application Network resource.
AppLinkMemberProperties	AppLink Member properties
AppLinkMemberUpdate	The type used for update operations of the AppLinkMember.
AppLinkMemberUpdateProperties	The updatable properties of the AppLinkMember.
AppLinkMembersCreateOrUpdateOptionalParams	Optional parameters.
AppLinkMembersDeleteOptionalParams	Optional parameters.
AppLinkMembersGetOptionalParams	Optional parameters.
AppLinkMembersListByAppLinkOptionalParams	Optional parameters.
AppLinkMembersOperations	Interface representing a AppLinkMembers operations.
AppLinkMembersUpdateOptionalParams	Optional parameters.
AppLinkProperties	AppLink properties
AppLinkUpdate	The type used for update operations of the AppLink.
AppLinksCreateOrUpdateOptionalParams	Optional parameters.
AppLinksDeleteOptionalParams	Optional parameters.
AppLinksGetOptionalParams	Optional parameters.
AppLinksListByResourceGroupOptionalParams	Optional parameters.
AppLinksListBySubscriptionOptionalParams	Optional parameters.
AppLinksOperations	Interface representing a AppLinks operations.
AppLinksUpdateOptionalParams	Optional parameters.
AvailableVersion	AppLink available version resource
AvailableVersionProperties	AppLink available version properties
AvailableVersionsListByLocationOptionalParams	Optional parameters.
AvailableVersionsOperations	Interface representing a AvailableVersions operations.
ConnectivityProfile	AppLinkMember connectivity profile.
ConnectivityProfileUpdate	The updatable AppLinkMember connectivity profile.
EastWestGatewayProfile	AppLinkMember east-west gateway profile.
EastWestGatewayProfileUpdate	The updatable AppLinkMember east-west gateway profile.
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.
FullyManagedUpgradeProfile	AppLinkMember fully managed upgrade profile
FullyManagedUpgradeProfileUpdate	The updatable AppLinkMember fully managed upgrade profile.
FullyManagedVersions	Fully managed versions
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityUpdate	The update-specific managed service identity (all fields optional for PATCH).
Metadata	AppLinkMember metadata
MetricsProfile	AppLinkMember metrics profile
ObservabilityProfile	AppLinkMember observability profile
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an 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.
PrivateConnectProfile	AppLinkMember private connect profile.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
ReleaseChannelInfo	Release channel information
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SelfManagedUpgradeProfile	AppLinkMember self managed upgrade profile
SelfManagedUpgradeProfileUpdate	The updatable AppLinkMember self managed upgrade profile.
SelfManagedVersions	Self managed versions
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'
UpgradeHistoriesListByAppLinkMemberOptionalParams	Optional parameters.
UpgradeHistoriesOperations	Interface representing a UpgradeHistories operations.
UpgradeHistory	AppLinkMember upgrade history
UpgradeHistoryProperties	AppLinkMember upgrade history properties
UpgradeProfile	AppLinkMember upgrade profile.
UpgradeProfileUpdate	The updatable AppLinkMember upgrade profile.
UserAssignedIdentity	User assigned identity properties
VersionInfo	Version information

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
ClusterType	AppLinkMember cluster type KnownClusterType can be used interchangeably with ClusterType, this enum contains the known values that the service supports. Known values supported by the service AKS: Azure Kubernetes Service
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.
EastWestGatewayVisibility	East-West gateway visibility. KnownEastWestGatewayVisibility can be used interchangeably with EastWestGatewayVisibility, this enum contains the known values that the service supports. Known values supported by the service Internal: Use an internal load balancer for the east-west gateway. External: Use an external load balancer for the east-west gateway.
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
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	Provisioning state of the resource KnownProvisioningState can be used interchangeably with ProvisioningState, 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. Provisioning: Resource is getting provisioned. Updating: Resource is Updating. Deleting: Resource is Deleting. Accepted: Resource has been Accepted.
UpgradeMode	AppLinkMember upgrade mode KnownUpgradeMode can be used interchangeably with UpgradeMode, this enum contains the known values that the service supports. Known values supported by the service FullyManaged: Fully managed upgrade mode SelfManaged: Self managed upgrade mode
UpgradeReleaseChannel	AppLinkMember upgrade release channel KnownUpgradeReleaseChannel can be used interchangeably with UpgradeReleaseChannel, this enum contains the known values that the service supports. Known values supported by the service Rapid: Rapid release channel Stable: Stable release channel

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownClusterType	AppLinkMember cluster type
KnownCreatedByType	The kind of entity that created the resource.
KnownEastWestGatewayVisibility	East-West gateway visibility.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProvisioningState	Provisioning state of the resource
KnownUpgradeMode	AppLinkMember upgrade mode
KnownUpgradeReleaseChannel	AppLinkMember upgrade release channel
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(AppLinkClient, 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.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

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

Parameters

client

AppLinkClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor