online_experimentation_workspaces

Creates, updates, deletes, gets or lists an online_experimentation_workspaces resource.

Overview

Name	online_experimentation_workspaces
Type	Resource
Id	azure.online_experimentation.online_experimentation_workspaces

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
appConfigurationResourceId	string	The resource identifier of App Configuration with which this online experimentation workspace is tied for experimentation. This is a required field for creating an online experimentation workspace. Required.
encryption	object	The encryption configuration for the online experimentation workspace resource.
endpoint	string	The data plane endpoint for the online experimentation workspace resource.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
logAnalyticsWorkspaceResourceId	string	The resource identifier of the Log Analytics workspace which online experimentation workspace uses for generating experiment analysis results. Required.
logsExporterStorageAccountResourceId	string	The resource identifier of storage account where logs are exported from Log Analytics workspace. online experimentation workspace uses it generating experiment analysis results. Required.
provisioningState	string	The provisioning state for the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
sku	object	The SKU (Stock Keeping Unit) assigned to this resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workspaceId	string	The Id of the workspace.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
appConfigurationResourceId	string	The resource identifier of App Configuration with which this online experimentation workspace is tied for experimentation. This is a required field for creating an online experimentation workspace. Required.
encryption	object	The encryption configuration for the online experimentation workspace resource.
endpoint	string	The data plane endpoint for the online experimentation workspace resource.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
logAnalyticsWorkspaceResourceId	string	The resource identifier of the Log Analytics workspace which online experimentation workspace uses for generating experiment analysis results. Required.
logsExporterStorageAccountResourceId	string	The resource identifier of storage account where logs are exported from Log Analytics workspace. online experimentation workspace uses it generating experiment analysis results. Required.
provisioningState	string	The provisioning state for the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
sku	object	The SKU (Stock Keeping Unit) assigned to this resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workspaceId	string	The Id of the workspace.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
appConfigurationResourceId	string	The resource identifier of App Configuration with which this online experimentation workspace is tied for experimentation. This is a required field for creating an online experimentation workspace. Required.
encryption	object	The encryption configuration for the online experimentation workspace resource.
endpoint	string	The data plane endpoint for the online experimentation workspace resource.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
logAnalyticsWorkspaceResourceId	string	The resource identifier of the Log Analytics workspace which online experimentation workspace uses for generating experiment analysis results. Required.
logsExporterStorageAccountResourceId	string	The resource identifier of storage account where logs are exported from Log Analytics workspace. online experimentation workspace uses it generating experiment analysis results. Required.
provisioningState	string	The provisioning state for the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
sku	object	The SKU (Stock Keeping Unit) assigned to this resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workspaceId	string	The Id of the workspace.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, subscription_id		Gets an online experimentation workspace.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all online experimentation workspaces in a resource group.
list_by_subscription	select	subscription_id		Gets all online experimentation workspaces in the specified subscription.
create_or_update	insert	resource_group_name, workspace_name, subscription_id, location		Create an online experimentation workspace, or update an existing workspace.
update	update	resource_group_name, workspace_name, subscription_id		Patch an online experimentation workspace.
create_or_update	replace	resource_group_name, workspace_name, subscription_id, location		Create an online experimentation workspace, or update an existing workspace.
delete	delete	resource_group_name, workspace_name, subscription_id		Deletes an online experimentation workspace.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the OnlineExperimentationWorkspace. Required.

SELECT examples

get

Gets an online experimentation workspace.

SELECT
id,
name,
appConfigurationResourceId,
encryption,
endpoint,
identity,
location,
logAnalyticsWorkspaceResourceId,
logsExporterStorageAccountResourceId,
provisioningState,
sku,
systemData,
tags,
type,
workspaceId
FROM azure.online_experimentation.online_experimentation_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all online experimentation workspaces in a resource group.

SELECT
id,
name,
appConfigurationResourceId,
encryption,
endpoint,
identity,
location,
logAnalyticsWorkspaceResourceId,
logsExporterStorageAccountResourceId,
provisioningState,
sku,
systemData,
tags,
type,
workspaceId
FROM azure.online_experimentation.online_experimentation_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets all online experimentation workspaces in the specified subscription.

SELECT
id,
name,
appConfigurationResourceId,
encryption,
endpoint,
identity,
location,
logAnalyticsWorkspaceResourceId,
logsExporterStorageAccountResourceId,
provisioningState,
sku,
systemData,
tags,
type,
workspaceId
FROM azure.online_experimentation.online_experimentation_workspaces
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create an online experimentation workspace, or update an existing workspace.

INSERT INTO azure.online_experimentation.online_experimentation_workspaces (
tags,
location,
properties,
identity,
sku,
resource_group_name,
workspace_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: online_experimentation_workspaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the online_experimentation_workspaces resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the online_experimentation_workspaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the online_experimentation_workspaces resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      workspaceId: "{{ workspaceId }}"
      provisioningState: "{{ provisioningState }}"
      logAnalyticsWorkspaceResourceId: "{{ logAnalyticsWorkspaceResourceId }}"
      logsExporterStorageAccountResourceId: "{{ logsExporterStorageAccountResourceId }}"
      appConfigurationResourceId: "{{ appConfigurationResourceId }}"
      encryption:
        customerManagedKeyEncryption:
          keyEncryptionKeyIdentity:
            identityType: "{{ identityType }}"
            userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
            federatedClientId: "{{ federatedClientId }}"
          keyEncryptionKeyUrl: "{{ keyEncryptionKeyUrl }}"
      endpoint: "{{ endpoint }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: sku
    description: |
      The SKU (Stock Keeping Unit) assigned to this resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"

UPDATE examples

update

Patch an online experimentation workspace.

UPDATE azure.online_experimentation.online_experimentation_workspaces
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create an online experimentation workspace, or update an existing workspace.

REPLACE azure.online_experimentation.online_experimentation_workspaces
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes an online experimentation workspace.

DELETE FROM azure.online_experimentation.online_experimentation_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;