Share via


@azure/arm-onlineexperimentation package

Classes

OnlineExperimentationClient

Interfaces

CustomerManagedKeyEncryption

Customer-managed key encryption properties for the resource.

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.

KeyEncryptionKeyIdentity

All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

OnlineExperimentationClientOptionalParams

Optional parameters for the client.

OnlineExperimentationWorkspace

An online experimentation workspace resource.

OnlineExperimentationWorkspacePatch

Partial update of an online experimentation workspace resource.

OnlineExperimentationWorkspaceProperties

The properties of an online experimentation workspace.

OnlineExperimentationWorkspaceSku

The SKU (Stock Keeping Unit) assigned to this resource.

OnlineExperimentationWorkspacesCreateOrUpdateOptionalParams

Optional parameters.

OnlineExperimentationWorkspacesDeleteOptionalParams

Optional parameters.

OnlineExperimentationWorkspacesGetOptionalParams

Optional parameters.

OnlineExperimentationWorkspacesListByResourceGroupOptionalParams

Optional parameters.

OnlineExperimentationWorkspacesListBySubscriptionOptionalParams

Optional parameters.

OnlineExperimentationWorkspacesOperations

Interface representing a OnlineExperimentationWorkspaces operations.

OnlineExperimentationWorkspacesUpdateOptionalParams

Optional parameters.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for and 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

ResourceEncryptionConfiguration

The encryption configuration for the online experimentation workspace resource.

RestorePollerOptions
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.

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.

KeyEncryptionKeyIdentityType

The type of identity to use.
KnownKeyEncryptionKeyIdentityType can be used interchangeably with KeyEncryptionKeyIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssignedIdentity: System assigned identity
UserAssignedIdentity: User assigned identity

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.

OnlineExperimentationWorkspaceSkuName

The allowed SKU names for the online experimentation workspace.
KnownOnlineExperimentationWorkspaceSkuName can be used interchangeably with OnlineExperimentationWorkspaceSkuName, this enum contains the known values that the service supports.

Known values supported by the service

F0: The Free service sku name.
S0: The Standard service sku name.
P0: The Premium service sku name.
D0: The Developer service sku name.

OnlineExperimentationWorkspaceSkuTier

The allowed SKU tiers for the online experimentation workspace.
KnownOnlineExperimentationWorkspaceSkuTier can be used interchangeably with OnlineExperimentationWorkspaceSkuTier, this enum contains the known values that the service supports.

Known values supported by the service

Free: The Free service tier.
Standard: The Standard service tier.
Premium: The Premium service tier.
Developer: The Developer service tier.

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

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.

KnownKeyEncryptionKeyIdentityType

The type of identity to use.

KnownManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

KnownOnlineExperimentationWorkspaceSkuName

The allowed SKU names for the online experimentation workspace.

KnownOnlineExperimentationWorkspaceSkuTier

The allowed SKU tiers for the online experimentation workspace.

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

The available API versions.

Functions

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

Parameters

serializedState

string

sourceOperation

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

Returns

PollerLike<OperationState<TResult>, TResult>