Workspace Manager Configurations - Create Or Update

Service:

Sentinel

API Version:

2025-07-01-preview

Creates or updates a workspace manager configuration.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/{workspaceManagerConfigurationName}?api-version=2025-07-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
workspaceManagerConfigurationName	path	True	string pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	The name of the workspace manager configuration
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	The name of the workspace.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
properties.mode	True	Mode	The current mode of the workspace manager configuration

Responses

Name	Type	Description
200 OK	WorkspaceManagerConfiguration	Resource 'WorkspaceManagerConfiguration' update operation succeeded
201 Created	WorkspaceManagerConfiguration	Resource 'WorkspaceManagerConfiguration' create operation succeeded
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create or Update a workspace manager Configuration

Sample request

HTTP

PUT https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default?api-version=2025-07-01-preview

{
  "properties": {
    "mode": "Enabled"
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.securityinsight import SecurityInsightsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-securityinsight
# USAGE
    python create_or_update_workspace_manager_configuration.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SecurityInsightsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.workspace_manager_configurations.create_or_update(
        resource_group_name="myRg",
        workspace_name="myWorkspace",
        workspace_manager_configuration_name="default",
        workspace_manager_configuration={"properties": {"mode": "Enabled"}},
    )
    print(response)


# x-ms-original-file: 2025-07-01-preview/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsecurityinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/securityinsights/armsecurityinsights/v2"
)

// Generated from example definition: 2025-07-01-preview/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json
func ExampleWorkspaceManagerConfigurationsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurityinsights.NewClientFactory("d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceManagerConfigurationsClient().CreateOrUpdate(ctx, "myRg", "myWorkspace", "default", armsecurityinsights.WorkspaceManagerConfiguration{
		Properties: &armsecurityinsights.WorkspaceManagerConfigurationProperties{
			Mode: to.Ptr(armsecurityinsights.ModeEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsecurityinsights.WorkspaceManagerConfigurationsClientCreateOrUpdateResponse{
	// 	WorkspaceManagerConfiguration: armsecurityinsights.WorkspaceManagerConfiguration{
	// 		Name: to.Ptr("default"),
	// 		Type: to.Ptr("Microsoft.SecurityInsights/workspaceManagerConfigurations"),
	// 		Etag: to.Ptr("\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\""),
	// 		ID: to.Ptr("/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default"),
	// 		Properties: &armsecurityinsights.WorkspaceManagerConfigurationProperties{
	// 			Mode: to.Ptr(armsecurityinsights.ModeEnabled),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SecurityInsights } = require("@azure/arm-securityinsight");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to creates or updates a workspace manager configuration.
 *
 * @summary creates or updates a workspace manager configuration.
 * x-ms-original-file: 2025-07-01-preview/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json
 */
async function createOrUpdateAWorkspaceManagerConfiguration() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0";
  const client = new SecurityInsights(credential, subscriptionId);
  const result = await client.workspaceManagerConfigurations.createOrUpdate(
    "myRg",
    "myWorkspace",
    "default",
    { mode: "Enabled" },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "name": "default",
  "type": "Microsoft.SecurityInsights/workspaceManagerConfigurations",
  "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"",
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default",
  "properties": {
    "mode": "Enabled"
  }
}

Status code:

201

{
  "name": "default",
  "type": "Microsoft.SecurityInsights/workspaceManagerConfigurations",
  "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"",
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default",
  "properties": {
    "mode": "Enabled"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Mode	The current mode of the workspace manager configuration
systemData	Metadata pertaining to creation and last modification of the resource.
WorkspaceManagerConfiguration	The workspace manager configuration

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Mode

Enumeration

The current mode of the workspace manager configuration

Value	Description
Enabled	The workspace manager configuration is enabled
Disabled	The workspace manager configuration is disabled

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

WorkspaceManagerConfiguration

Object

The workspace manager configuration

Name	Type	Description
etag	string	Resource Etag.
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.mode	Mode	The current mode of the workspace manager configuration
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"