@azure/arm-koreaiartemis package

Classes

Interfaces

ActivateSaaSParameterRequest	SaaS guid & PublisherId for Activate and Validate SaaS Resource.
AgentPlatformClientOptionalParams	Optional parameters for the client.
CompanyDetails	Organization-tier company metadata.
DefaultWorkspaceProperties	Properties of the default Workspace created with the Organization.
DiscoveredWorkspace	Workspace returned by the Organization listWorkspaces discovery action.
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.
ListWorkspacesResponse	Response containing all Workspaces in a Kore Organization.
MarketplaceDetails	Marketplace details for an organization
OfferDetails	Offer details for the marketplace that is selected by the user
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.
OrganizationPartnerProperties	Partner-specific (Kore) properties for an Organization.
OrganizationPartnerPropertiesUpdate	Mutable partner properties for PATCH.
OrganizationProperties	Properties of a Kore.AgentPlatform Organization.
OrganizationPropertiesUpdate	Mutable Organization properties (subset of OrganizationProperties).
OrganizationResource	An Organization resource in the Kore.AgentPlatform provider. Top-level tracked ARM resource. Each Organization is provisioned with a default Workspace atomically; additional Workspaces are managed via the `createWorkspace` and `deleteWorkspace` actions defined below.
OrganizationResourceUpdate	PATCH body for the Organization resource.
OrganizationsCreateOptionalParams	Optional parameters.
OrganizationsDeleteOptionalParams	Optional parameters.
OrganizationsGetOptionalParams	Optional parameters.
OrganizationsListByResourceGroupOptionalParams	Optional parameters.
OrganizationsListBySubscriptionOptionalParams	Optional parameters.
OrganizationsListWorkspacesOptionalParams	Optional parameters.
OrganizationsOperations	Interface representing a Organizations operations.
OrganizationsUpdateOptionalParams	Optional parameters.
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
SaaSOperationGroupActivateResourceOptionalParams	Optional parameters.
SaaSOperationGroupOperations	Interface representing a SaaSOperationGroup operations.
SaaSResourceDetailsResponse	Marketplace SaaS resource details.
SingleSignOnProperties	Single Sign-On metadata returned by the partner after Organization creation. Spreads the standard `LiftrBase.SingleSignOnPropertiesV2` shape (`type`, `state`, `enterpriseAppId`, `url`, `aadDomains`).
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'
UserDetails	Azure customer profile metadata used by the partner for JIT provisioning. Composes the standard `LiftrBase.UserDetails` (firstName, lastName, emailAddress, upn, phoneNumber) with Kore-specific extensions.
WorkspaceDetail	Complete Workspace details returned by Kore.
WorkspaceDetailPartnerProperties	Partner-specific fields returned by the Workspace details action.
WorkspaceLinkedSaaSItem	Individual SaaS resource linked to the Workspace.
WorkspaceLinkedSaaSListResponse	Response containing the list of SaaS resources linked to the Workspace.
WorkspaceMarketplaceDetails	Marketplace SaaS subscription details returned by Kore.
WorkspacePartnerProperties	Partner-specific (Kore) properties for a Workspace.
WorkspaceProject	Project summary returned with complete Workspace details.
WorkspaceProperties	Properties of a Kore.AgentPlatform Workspace.
WorkspaceResource	A Workspace resource in the Kore.AgentPlatform provider. Child proxy resource type under an Organization. Workspaces are not tracked (no `location`/`tags`). Lifecycle is managed through the standard ARM verbs on the child URL: PUT .../organizations/{org}/workspaces/{workspaceName} (create or update) DELETE .../organizations/{org}/workspaces/{workspaceName} GET .../organizations/{org}/workspaces/{workspaceName} GET .../organizations/{org}/workspaces (list by parent) A default Workspace is also provisioned atomically when the parent Organization is created (see `OrganizationProperties.defaultWorkspace`); additional Workspaces are managed via the operations defined here.
WorkspaceSaaSData	SaaS-related data properties. Contains the full list of SaaS resource IDs to link.
WorkspacesCreateOrUpdateOptionalParams	Optional parameters.
WorkspacesDeleteOptionalParams	Optional parameters.
WorkspacesGetDetailsOptionalParams	Optional parameters.
WorkspacesGetOptionalParams	Optional parameters.
WorkspacesLinkSaaSOptionalParams	Optional parameters.
WorkspacesListByOrganizationOptionalParams	Optional parameters.
WorkspacesListLinkedSaaSOptionalParams	Optional parameters.
WorkspacesOperations	Interface representing a Workspaces operations.

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
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.
MarketplaceSubscriptionStatus	Marketplace subscription status of a resource. KnownMarketplaceSubscriptionStatus can be used interchangeably with MarketplaceSubscriptionStatus, this enum contains the known values that the service supports. Known values supported by the service PendingFulfillmentStart: Purchased but not yet activated Subscribed: Marketplace subscription is activated Suspended: This state indicates that a customer's payment for the Marketplace service was not received Unsubscribed: Customer has cancelled the subscription
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.
Product	Marketplace product options available for a Workspace. KnownProduct can be used interchangeably with Product, this enum contains the known values that the service supports. Known values supported by the service aiforwork: AI for Work product. aiforservice: AI for Service product.
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.
SingleSignOnStates	Various states of the SSO resource KnownSingleSignOnStates can be used interchangeably with SingleSignOnStates, this enum contains the known values that the service supports. Known values supported by the service Initial: Initial state of the SSO resource Enable: State of the SSO resource when it is enabled Disable: State of the SSO resource when it is disabled
SingleSignOnType	Defines the type of Single Sign-On (SSO) mechanism being used KnownSingleSignOnType can be used interchangeably with SingleSignOnType, this enum contains the known values that the service supports. Known values supported by the service Saml: Security Assertion Markup Language (SAML) based Single Sign-On OpenId: OpenID Connect based Single Sign-On.
WorkspaceLifecycleStatus	Lifecycle status of a Workspace as reported by the Kore partner. KnownWorkspaceLifecycleStatus can be used interchangeably with WorkspaceLifecycleStatus, this enum contains the known values that the service supports. Known values supported by the service active: Workspace is active and operational. suspended: Workspace is suspended; operations are blocked but resource is retained. archived: Workspace is archived (delete pending).
WorkspaceMarketplaceStatus	Azure Marketplace fulfillment status reported by Kore. KnownWorkspaceMarketplaceStatus can be used interchangeably with WorkspaceMarketplaceStatus, this enum contains the known values that the service supports. Known values supported by the service PendingFulfillmentStart: Fulfillment has not started. Subscribed: The subscription is active. Suspended: The subscription is suspended. Unsubscribed: The subscription is unsubscribed.
WorkspaceProjectStatus	Lifecycle status of a Workspace Project. KnownWorkspaceProjectStatus can be used interchangeably with WorkspaceProjectStatus, this enum contains the known values that the service supports. Known values supported by the service active: The Project is active. in-development: The Project is under development. deployed: The Project is deployed. archived: The Project is archived.

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.
KnownCreatedByType	The kind of entity that created the resource.
KnownMarketplaceSubscriptionStatus	Marketplace subscription status of a resource.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProduct	Marketplace product options available for a Workspace.
KnownResourceProvisioningState	The provisioning state of a resource type.
KnownSingleSignOnStates	Various states of the SSO resource
KnownSingleSignOnType	Defines the type of Single Sign-On (SSO) mechanism being used
KnownVersions	Supported versions for the Kore.AgentPlatform resource model
KnownWorkspaceLifecycleStatus	Lifecycle status of a Workspace as reported by the Kore partner.
KnownWorkspaceMarketplaceStatus	Azure Marketplace fulfillment status reported by Kore.
KnownWorkspaceProjectStatus	Lifecycle status of a Workspace Project.

Functions

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

Parameters

e: unknown

Something caught by a catch clause.

Returns

e is RestError

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

Parameters

client: AgentPlatformClient

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-koreaiartemis 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

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

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

Parameters

Returns

Variable Details

RestError

Type

Feedback