@azure/arm-aigateway package

Classes

ApiManagementClient

Interfaces

AiGatewayBackend	Backend networking configuration of an AI Gateway.
AiGatewayFrontend	Frontend configuration of an AI Gateway.
AiGatewayProperties	Properties of an AI Gateway.
AiGatewayResource	An AI Gateway resource.
AiGatewayResourcesCreateOrUpdateOptionalParams	Optional parameters.
AiGatewayResourcesDeleteOptionalParams	Optional parameters.
AiGatewayResourcesGetOptionalParams	Optional parameters.
AiGatewayResourcesListByResourceGroupOptionalParams	Optional parameters.
AiGatewayResourcesListBySubscriptionOptionalParams	Optional parameters.
AiGatewayResourcesOperations	Interface representing a AiGatewayResources operations.
AiGatewayResourcesUpdateOptionalParams	Optional parameters.
AiGatewaySkuUpdate	SKU fields to update on an AI Gateway.
AiGatewaySubnet	Subnet used by an AI Gateway.
AiGatewayUpdateParameters	Parameters for updating an AI Gateway.
ApiManagementClientOptionalParams	Optional parameters for the client.
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.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
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.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
Sku	The resource model definition representing SKU
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'
UserAssignedIdentity	User assigned identity properties

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.
AiGatewayProvisioningState	Provisioning state of an AI Gateway resource. KnownAiGatewayProvisioningState can be used interchangeably with AiGatewayProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: The resource is ready. Failed: The resource operation failed. Canceled: The resource operation was canceled.
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.
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.
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

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.
KnownAiGatewayProvisioningState	Provisioning state of an AI Gateway resource.
KnownCreatedByType	The kind of entity that created the resource.
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"
KnownVersions	The available API versions.

Functions

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

Parameters

client

ApiManagementClient

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