Microsoft.OnlineExperimentation (preview:2025-05-31)

2025/04/28 • 1 updated methods

OnlineExperimentWorkspaces_Update (updated)
Description :  Patch an experiment workspace
Reference :  Link ¶

⚶ Changes

{
  "#id": "OnlineExperimentWorkspaces_Update",
  "$parameters": {
    "properties": {
      "Description": {
        "new": "Partial update of an online experiment workspace resource.",
        "old": "An online experiment workspace resource."
      },
      "$properties": [
        {
          "@added_14cfbfe71ae640b29e65ced6608bc10c": {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          }
        },
        {
          "#name": "properties",
          "Description": {
            "new": "Updatable properties of the online experiment workspace resource.",
            "old": "The resource-specific properties for this resource."
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OnlineExperimentation/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the OnlineExperimentWorkspace ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity assigned to this resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The identities assigned to this resource by the user. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - F0, P0. It is typically a letter+number code ,
Enum:
{
F0: The Free service sku name. ,
S0: The Standard service sku name. ,
P0: The Premium service sku name. ,
D0: The Developer service sku name. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Updatable properties of the online experiment workspace resource. ,
Required: False ,
}
{
logAnalyticsWorkspaceResourceId:
{
Description: The resource identifier of the Log Analytics workspace which online experiment workspace uses for generating experiment analysis results. ,
Format: arm-id ,
Required: False ,
}
string ,
logsExporterStorageAccountResourceId:
{
Description: The resource identifier of storage account where logs are exported from Log Analytics workspace. Online Experiment workspace uses it generating experiment analysis results. ,
Format: arm-id ,
Required: False ,
}
string ,
encryption:
{
Description: The encryption configuration for the online experiment workspace resource. ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: All Customer-managed key encryption properties for the resource. ,
Required: False ,
}
{
keyEncryptionKeyIdentity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
identityType:
{
Description: The type of identity to use. Values can be systemAssignedIdentity, userAssignedIdentity, or delegatedResourceIdentity. ,
Enum:
{
SystemAssignedIdentity: System assigned identity ,
UserAssignedIdentity: User assigned identity ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity. ,
Format: arm-id ,
Required: False ,
}
string ,
federatedClientId:
{
Description: application client identity to use for accessing key encryption key Url in a different tenant. Ex: f83c6b1b-4d34-47e4-bb34-9d83df58b540 ,
Format: uuid ,
Required: False ,
}
string ,
}
,
keyEncryptionKeyUrl:
{
Description: key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
workspaceId:
{
Description: The Id of the workspace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state for the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
logAnalyticsWorkspaceResourceId:
{
Description: The resource identifier of the Log Analytics workspace which online experiment workspace uses for generating experiment analysis results. ,
Format: arm-id ,
Required: True ,
}
string ,
logsExporterStorageAccountResourceId:
{
Description: The resource identifier of storage account where logs are exported from Log Analytics workspace. Online Experiment workspace uses it generating experiment analysis results. ,
Format: arm-id ,
Required: True ,
}
string ,
appConfigurationResourceId:
{
Description: The resource identifier of App Configuration with which this online experiment workspace is tied for experimentation. This is a required field for creating an online experiment workspace. ,
Format: arm-id ,
Required: True ,
}
string ,
encryption:
{
Description: The encryption configuration for the online experiment workspace resource. ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: All Customer-managed key encryption properties for the resource. ,
Required: False ,
}
{
keyEncryptionKeyIdentity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
identityType:
{
Description: The type of identity to use. Values can be systemAssignedIdentity, userAssignedIdentity, or delegatedResourceIdentity. ,
Enum:
{
SystemAssignedIdentity: System assigned identity ,
UserAssignedIdentity: User assigned identity ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity. ,
Format: arm-id ,
Required: False ,
}
string ,
federatedClientId:
{
Description: application client identity to use for accessing key encryption key Url in a different tenant. Ex: f83c6b1b-4d34-47e4-bb34-9d83df58b540 ,
Format: uuid ,
Required: False ,
}
string ,
}
,
keyEncryptionKeyUrl:
{
Description: key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
endpoint:
{
Description: The data plane endpoint for the online experiment workspace resource. ,
Format: uri ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - F0, P0. It is typically a letter+number code ,
Enum:
{
F0: The Free service sku name. ,
S0: The Standard service sku name. ,
P0: The Premium service sku name. ,
D0: The Developer service sku name. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The name of the SKU tier ,
Enum:
{
Free: The Free service tier. ,
Standard: The Standard service tier. ,
Premium: The Premium service tier. ,
Developer: The Developer service tier. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}