@azure/arm-containerserviceaimanager package

Classes

Interfaces

AIManager	The AI Manager resource. For more information, see https://aka.ms/aks/aimanager.
AIManagerNamespace	The AI Manager namespace resource.
AIManagerNamespaceProperties	AI Manager namespace properties.
AIManagerNamespacesCreateOrUpdateOptionalParams	Optional parameters.
AIManagerNamespacesDeleteOptionalParams	Optional parameters.
AIManagerNamespacesGetOptionalParams	Optional parameters.
AIManagerNamespacesListAccessKeysOptionalParams	Optional parameters.
AIManagerNamespacesListByAIManagerOptionalParams	Optional parameters.
AIManagerNamespacesListCredentialOptionalParams	Optional parameters.
AIManagerNamespacesOperations	Interface representing a AIManagerNamespaces operations.
AIManagerNamespacesRotateKeysOptionalParams	Optional parameters.
AIManagerPatch	The AI Manager resource patch model.
AIManagerProperties	AI Manager properties.
AIManagersCreateOrUpdateOptionalParams	Optional parameters.
AIManagersDeleteOptionalParams	Optional parameters.
AIManagersGetOptionalParams	Optional parameters.
AIManagersListByResourceGroupOptionalParams	Optional parameters.
AIManagersListBySubscriptionOptionalParams	Optional parameters.
AIManagersListCredentialOptionalParams	Optional parameters.
AIManagersOperations	Interface representing a AIManagers operations.
AIManagersUpdateOptionalParams	Optional parameters.
AIModel	An AI model exposed by Microsoft.ContainerService. Read-only, globally-shared catalog entry that is platform-maintained and auto-provisioned by the resource provider. Can be referenced by `ModelDeployment` resources.
AIModelProperties	AI model properties.
AIModelsCalculateCostOptionalParams	Optional parameters.
AIModelsGetOptionalParams	Optional parameters.
AIModelsListOptionalParams	Optional parameters.
AIModelsOperations	Interface representing a AIModels operations.
AutoscaleProfile	Autoscaling configuration: scale replica count between a minimum and maximum.
CalculateCostPlan	A GPU SKU pricing plan returned by the `calculateCost` action. Describes the cost of running a single model replica on the specified `vmSize`. To estimate the cost of running multiple replicas, scale `totalHourlyPrice` by the desired replica count, bounded by `maxAvailableReplicas`.
CalculateCostRequest	Request body for the AI model `calculateCost` action.
CalculateCostResponse	Response body for the AI model `calculateCost` action.
ContainerServiceClientOptionalParams	Optional parameters for the client.
CredentialResult	The credential result response.
CredentialResults	The list credential result response.
CredentialValue	A credential value. Exactly one variant must be set. In the current API version, only the `inline` variant is supported. Future API versions are expected to add additional credential kinds (for example, managed identity and Key Vault secret references) as sibling variants on this model.
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.
InfeasibilityReason	Reason explaining why a `CalculateCostPlan` is not deployable. This is a per-plan annotation surfaced inside a successful `calculateCost` response, not an ARM error envelope.
InlineCredential	A credential provided inline.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManualScalingProfile	Manual scaling configuration: fixed replica count.
ModelDeployment	A running deployment of a model in an AI Manager namespace. PUT (create or update) on this resource is a full replace: the request body represents the complete desired state, and any optional property omitted from the body is reset to its default value (or cleared, if it has no default). Callers must always send the full desired state on every PUT.
ModelDeploymentOverrides	User overrides for a model deployment.
ModelDeploymentProperties	Model deployment properties.
ModelDeploymentStatus	The runtime status of a model deployment. All fields are read-only and populated once reconciliation has started.
ModelDeploymentsCreateOrUpdateOptionalParams	Optional parameters.
ModelDeploymentsDeleteOptionalParams	Optional parameters.
ModelDeploymentsGetOptionalParams	Optional parameters.
ModelDeploymentsListByAIManagerNamespaceOptionalParams	Optional parameters.
ModelDeploymentsOperations	Interface representing a ModelDeployments operations.
ModelSource	A model source registered with an AI Manager. Describes an external model registry (e.g. Hugging Face) and the credentials the platform uses to pull artifacts from it.
ModelSourceProperties	Model source properties.
ModelSourcesCreateOrUpdateOptionalParams	Optional parameters.
ModelSourcesDeleteOptionalParams	Optional parameters.
ModelSourcesGetOptionalParams	Optional parameters.
ModelSourcesListOptionalParams	Optional parameters.
ModelSourcesOperations	Interface representing a ModelSources operations.
ModelSpec	The specification of a model. All fields are read-only.
NamespaceAccessInfo	Access information for an AI Manager namespace, including the OpenAI-compatible gateway endpoint and the API keys used to authenticate against it.
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.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
ScalingProfile	Scaling configuration for a model deployment. Exactly one of `manual` or `autoscale` must be set. This mutual-exclusion constraint is enforced by the service at request validation time, not by the schema. A PUT request that sets both `manual` and `autoscale`, or sets neither, is rejected with HTTP 400 (Bad Request) and an `InvalidScalingProfile` error code; Scale-to-zero semantics differ between the two modes: `manual` permits `replicas: 0`. This is an explicit operator action to stop serving traffic while keeping the `ModelDeployment` resource (and its configuration) in place. While at zero replicas the endpoint returns errors for inference requests, and the deployment releases its GPU capacity. `autoscale` does not permit `minReplicas: 0`. Autoscaling decisions are driven by serving-server runtime metrics (request rate, queue depth, GPU utilization); at zero replicas there is no signal for the autoscaler to scale back up from. Combined with GPU cold-start time (on the order of minutes) and constrained regional GPU capacity, a scale-from-zero event would produce unacceptable first-request latency and a high risk of capacity unavailability. Callers that want autoscaling with an idle state should delete the `ModelDeployment` instead.
ServingPerformanceEstimation	Estimated relative inference performance of a single model replica on a given GPU SKU. Each metric is a scaling coefficient in the range `[0, 1]` relative to the best-performing SKU for this model, which scores `1`.
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

AIManagerNamespaceProvisioningState	The provisioning state of the AI Manager namespace resource. KnownAIManagerNamespaceProvisioningState can be used interchangeably with AIManagerNamespaceProvisioningState, 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. Creating: The provisioning state of a namespace being created. Updating: The provisioning state of a namespace being updated. Deleting: The provisioning state of a namespace being deleted.
AIManagerProvisioningState	The provisioning state of the AI Manager resource. KnownAIManagerProvisioningState can be used interchangeably with AIManagerProvisioningState, 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. Creating: Resource is being created. Updating: Resource is updating. Deleting: Resource is deleting.
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
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.
DeletePolicy	Delete options of the AI Manager. KnownDeletePolicy can be used interchangeably with DeletePolicy, this enum contains the known values that the service supports. Known values supported by the service Keep: Keep the underlying cluster resources even if the AIManager resource is deleted. Delete: Delete both the underlying cluster resources and the AIManager resource together.
InfeasibleCode	The reason a `CalculateCostPlan` is not deployable. KnownInfeasibleCode can be used interchangeably with InfeasibleCode, this enum contains the known values that the service supports. Known values supported by the service InsufficientQuota: The caller's subscription does not have enough GPU quota in the target region to deploy this plan. RegionUnavailable: The VM SKU is not available in the target region. InefficientDeployment: The deployment can start successfully on this SKU, but its estimated runtime performance falls below the acceptable threshold for serving this model.
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.
ModelDeploymentPerformanceMode	The runtime performance mode of a model deployment. KnownModelDeploymentPerformanceMode can be used interchangeably with ModelDeploymentPerformanceMode, this enum contains the known values that the service supports. Known values supported by the service Balanced: A balanced trade-off between latency and throughput (default). Latency: Optimize for low request latency. Throughput: Optimize for high aggregate throughput.
ModelDeploymentProvisioningState	The provisioning state of a model deployment resource. KnownModelDeploymentProvisioningState can be used interchangeably with ModelDeploymentProvisioningState, 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. Creating: Resource is being created. Updating: Resource is updating. Deleting: Resource is deleting.
ModelSourceType	The type of a model source. KnownModelSourceType can be used interchangeably with ModelSourceType, this enum contains the known values that the service supports. Known values supported by the service HuggingFace: A Hugging Face model registry.
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.
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.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAIManagerNamespaceProvisioningState	The provisioning state of the AI Manager namespace resource.
KnownAIManagerProvisioningState	The provisioning state of the AI Manager resource.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownCreatedByType	The kind of entity that created the resource.
KnownDeletePolicy	Delete options of the AI Manager.
KnownInfeasibleCode	The reason a `CalculateCostPlan` is not deployable.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownModelDeploymentPerformanceMode	The runtime performance mode of a model deployment.
KnownModelDeploymentProvisioningState	The provisioning state of a model deployment resource.
KnownModelSourceType	The type of a model source.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownResourceProvisioningState	The provisioning state of a resource type.
KnownVersions	Azure Kubernetes AI Manager api versions.

Functions

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

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

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

Parameters

client: ContainerServiceClient

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-containerserviceaimanager package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(ContainerServiceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type

Feedback