OperationalInsightsWorkspaceResource Class

Definition

Namespace:
Azure.ResourceManager.OperationalInsights
Assembly:
Azure.ResourceManager.OperationalInsights.dll
Package:
Azure.ResourceManager.OperationalInsights v1.3.2
Package:
Azure.ResourceManager.OperationalInsights v1.3.0-beta.2
Source:
OperationalInsightsWorkspaceResource.cs
Source:
OperationalInsightsWorkspaceResource.cs

A class representing a OperationalInsightsWorkspace along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a OperationalInsightsWorkspaceResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetOperationalInsightsWorkspaces method.

public class OperationalInsightsWorkspaceResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.OperationalInsights.OperationalInsightsWorkspaceData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.OperationalInsights.OperationalInsightsWorkspaceData>
type OperationalInsightsWorkspaceResource = class
    inherit ArmResource
    interface IJsonModel<OperationalInsightsWorkspaceData>
    interface IPersistableModel<OperationalInsightsWorkspaceData>
Public Class OperationalInsightsWorkspaceResource
Inherits ArmResource
Implements IJsonModel(Of OperationalInsightsWorkspaceData), IPersistableModel(Of OperationalInsightsWorkspaceData)
Inheritance
Object
ArmResource
OperationalInsightsWorkspaceResource
Implements
IJsonModel<OperationalInsightsWorkspaceData> IPersistableModel<OperationalInsightsWorkspaceData> IPersistableModel<T>

Constructors

Name Description
OperationalInsightsWorkspaceResource()

Initializes a new instance of OperationalInsightsWorkspaceResource for mocking.

Fields

Name Description
ResourceType

Gets the resource type for the operations.

Properties

Name Description
Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.
Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

Name Description
AddTag(String, String, CancellationToken)

Add a tag to the current resource.
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.
CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CreateResourceIdentifier(String, String, String)

Generate the resource identifier for this resource.
Delete(WaitUntil, Nullable<Boolean>, CancellationToken)

Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
  • Operation Id. : Workspaces_Delete.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
DeleteAsync(WaitUntil, Nullable<Boolean>, CancellationToken)

Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
  • Operation Id. : Workspaces_Delete.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
DeleteGateway(Guid, CancellationToken)

Delete a Log Analytics gateway.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/gateways/{gatewayId}.
  • Operation Id. : Workspaces_GatewaysDelete.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
DeleteGatewayAsync(Guid, CancellationToken)

Delete a Log Analytics gateway.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/gateways/{gatewayId}.
  • Operation Id. : Workspaces_GatewaysDelete.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
DisableIntelligencePack(String, CancellationToken)

Disables an intelligence pack for a given workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks/{intelligencePackName}/Disable.
  • Operation Id. : Workspaces_Disable.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
DisableIntelligencePackAsync(String, CancellationToken)

Disables an intelligence pack for a given workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks/{intelligencePackName}/Disable.
  • Operation Id. : Workspaces_Disable.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
EnableIntelligencePack(String, CancellationToken)

Enables an intelligence pack for a given workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks/{intelligencePackName}/Enable.
  • Operation Id. : Workspaces_Enable.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
EnableIntelligencePackAsync(String, CancellationToken)

Enables an intelligence pack for a given workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks/{intelligencePackName}/Enable.
  • Operation Id. : Workspaces_Enable.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
Failback(WaitUntil, CancellationToken)

Deactivates failover for the specified workspace. The failback operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/failback.
  • Operation Id. : Workspaces_Failback.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
FailbackAsync(WaitUntil, CancellationToken)

Deactivates failover for the specified workspace. The failback operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/failback.
  • Operation Id. : Workspaces_Failback.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
Get(CancellationToken)

Gets a workspace instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
  • Operation Id. : Workspaces_Get.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetAllOperationalInsightsLinkedStorageAccounts()

Gets a collection of OperationalInsightsLinkedStorageAccounts in the OperationalInsightsWorkspaceResource.
GetAllOperationalInsightsSummaryLogs()

Gets a collection of OperationalInsightsSummaryLogs in the OperationalInsightsWorkspaceResource.
GetAsync(CancellationToken)

Gets a workspace instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
  • Operation Id. : Workspaces_Get.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableServiceTiers(CancellationToken)

Gets the available service tiers for the workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/availableServiceTiers.
  • Operation Id. : Workspaces_ListByWorkspace.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetAvailableServiceTiersAsync(CancellationToken)

Gets the available service tiers for the workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/availableServiceTiers.
  • Operation Id. : Workspaces_ListByWorkspace.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetIntelligencePacks(CancellationToken)

Lists all the intelligence packs possible and whether they are enabled or disabled for a given workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks.
  • Operation Id. : Workspaces_IntelligencePacksList.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetIntelligencePacksAsync(CancellationToken)

Lists all the intelligence packs possible and whether they are enabled or disabled for a given workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks.
  • Operation Id. : Workspaces_IntelligencePacksList.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetManagementGroups(CancellationToken)

Gets a list of management groups connected to a workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/managementGroups.
  • Operation Id. : Workspaces_ManagementGroupsList.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetManagementGroupsAsync(CancellationToken)

Gets a list of management groups connected to a workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/managementGroups.
  • Operation Id. : Workspaces_ManagementGroupsList.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetNetworkSecurityPerimeterConfiguration(String, CancellationToken)

Gets a network security perimeter configuration.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}.
  • Operation Id. : NetworkSecurityPerimeterConfigurations_GetNSP.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetNetworkSecurityPerimeterConfigurationAsync(String, CancellationToken)

Gets a network security perimeter configuration.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}.
  • Operation Id. : NetworkSecurityPerimeterConfigurations_GetNSP.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetNetworkSecurityPerimeterConfigurations(CancellationToken)

Gets a list of NSP configurations for specified workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations.
  • Operation Id. : NetworkSecurityPerimeterConfigurations_ListNSP.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetNetworkSecurityPerimeterConfigurationsAsync(CancellationToken)

Gets a list of NSP configurations for specified workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations.
  • Operation Id. : NetworkSecurityPerimeterConfigurations_ListNSP.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetOperationalInsightsDataExport(String, CancellationToken)

Gets a data export instance.
GetOperationalInsightsDataExportAsync(String, CancellationToken)

Gets a data export instance.
GetOperationalInsightsDataExports()

Gets a collection of OperationalInsightsDataExports in the OperationalInsightsWorkspaceResource.
GetOperationalInsightsDataSource(String, CancellationToken)

Gets a datasource instance.
GetOperationalInsightsDataSourceAsync(String, CancellationToken)

Gets a datasource instance.
GetOperationalInsightsDataSources()

Gets a collection of OperationalInsightsDataSources in the OperationalInsightsWorkspaceResource.
GetOperationalInsightsLinkedService(String, CancellationToken)

Gets a linked service instance.
GetOperationalInsightsLinkedServiceAsync(String, CancellationToken)

Gets a linked service instance.
GetOperationalInsightsLinkedServices()

Gets a collection of OperationalInsightsLinkedServices in the OperationalInsightsWorkspaceResource.
GetOperationalInsightsLinkedStorageAccounts(OperationalInsightsDataSourceType, CancellationToken)

Gets all linked storage account of a specific data source type associated with the specified workspace.
GetOperationalInsightsLinkedStorageAccountsAsync(OperationalInsightsDataSourceType, CancellationToken)

Gets all linked storage account of a specific data source type associated with the specified workspace.
GetOperationalInsightsSavedSearch(String, CancellationToken)

Gets the specified saved search for a given workspace.
GetOperationalInsightsSavedSearchAsync(String, CancellationToken)

Gets the specified saved search for a given workspace.
GetOperationalInsightsSavedSearches()

Gets a collection of OperationalInsightsSavedSearches in the OperationalInsightsWorkspaceResource.
GetOperationalInsightsSummaryLogs(String, CancellationToken)

Gets Log Analytics workspace Summary rules.
GetOperationalInsightsSummaryLogsAsync(String, CancellationToken)

Gets Log Analytics workspace Summary rules.
GetOperationalInsightsTable(String, CancellationToken)

Gets a Log Analytics workspace table.
GetOperationalInsightsTableAsync(String, CancellationToken)

Gets a Log Analytics workspace table.
GetOperationalInsightsTables()

Gets a collection of OperationalInsightsTables in the OperationalInsightsWorkspaceResource.
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetPurgeStatus(String, CancellationToken)

Gets status of an ongoing purge operation.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/operations/{purgeId}.
  • Operation Id. : Workspaces_GetPurgeStatus.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetPurgeStatusAsync(String, CancellationToken)

Gets status of an ongoing purge operation.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/operations/{purgeId}.
  • Operation Id. : Workspaces_GetPurgeStatus.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetSchemas(CancellationToken)

Gets the schema for a given workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/schema.
  • Operation Id. : Workspaces_SchemaGet.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetSchemasAsync(CancellationToken)

Gets the schema for a given workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/schema.
  • Operation Id. : Workspaces_SchemaGet.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetSharedKeys(CancellationToken)

Gets the shared keys for a workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/sharedKeys.
  • Operation Id. : Workspaces_GetSharedKeys.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetSharedKeysAsync(CancellationToken)

Gets the shared keys for a workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/sharedKeys.
  • Operation Id. : Workspaces_GetSharedKeys.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetStorageInsight(String, CancellationToken)

Gets a storage insight instance.
GetStorageInsightAsync(String, CancellationToken)

Gets a storage insight instance.
GetStorageInsights()

Gets a collection of StorageInsights in the OperationalInsightsWorkspaceResource.
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetUsages(CancellationToken)

Gets a list of usage metrics for a workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/usages.
  • Operation Id. : Workspaces_UsagesList.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
GetUsagesAsync(CancellationToken)

Gets a list of usage metrics for a workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/usages.
  • Operation Id. : Workspaces_UsagesList.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
Purge(OperationalInsightsWorkspacePurgeContent, CancellationToken)

Purges data in an Log Analytics workspace by a set of user-defined filters. In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected. Log Analytics only supports purge operations required for compliance with GDPR. The Log Analytics product team reserves the right to reject requests for purge operations that are not for the purpose of GDPR compliance. In the event of a dispute, please create a support ticket

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/purge.
  • Operation Id. : Workspaces_Purge.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
PurgeAsync(OperationalInsightsWorkspacePurgeContent, CancellationToken)

Purges data in an Log Analytics workspace by a set of user-defined filters. In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected. Log Analytics only supports purge operations required for compliance with GDPR. The Log Analytics product team reserves the right to reject requests for purge operations that are not for the purpose of GDPR compliance. In the event of a dispute, please create a support ticket

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/purge.
  • Operation Id. : Workspaces_Purge.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
ReconcileNetworkSecurityPerimeterConfiguration(WaitUntil, String, CancellationToken)

Reconcile network security perimeter configuration for Workspace resource.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile.
  • Operation Id. : NetworkSecurityPerimeterConfigurations_ReconcileNSP.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
ReconcileNetworkSecurityPerimeterConfigurationAsync(WaitUntil, String, CancellationToken)

Reconcile network security perimeter configuration for Workspace resource.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile.
  • Operation Id. : NetworkSecurityPerimeterConfigurations_ReconcileNSP.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
RegenerateSharedKey(CancellationToken)

Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/regenerateSharedKey.
  • Operation Id. : Workspaces_Regenerate.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
RegenerateSharedKeyAsync(CancellationToken)

Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/regenerateSharedKey.
  • Operation Id. : Workspaces_Regenerate.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(OperationalInsightsWorkspacePatch, CancellationToken)

Updates a workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
  • Operation Id. : Workspaces_Update.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.
UpdateAsync(OperationalInsightsWorkspacePatch, CancellationToken)

Updates a workspace.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
  • Operation Id. : Workspaces_Update.
  • Default Api Version. : 2025-07-01.
  • Resource. : OperationalInsightsWorkspaceResource.

Explicit Interface Implementations

Name Description
IJsonModel<OperationalInsightsWorkspaceData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<OperationalInsightsWorkspaceData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<OperationalInsightsWorkspaceData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<OperationalInsightsWorkspaceData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<OperationalInsightsWorkspaceData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

Name Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
<item>MockingTo mock this method, please mock GetAuthorizationRoleDefinition(ResourceIdentifier, CancellationToken) instead.</item>
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
<item>MockingTo mock this method, please mock GetAuthorizationRoleDefinitionAsync(ResourceIdentifier, CancellationToken) instead.</item>
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. <item>MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.</item>
GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
<item>MockingTo mock this method, please mock GetDenyAssignment(String, CancellationToken) instead.</item>
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
<item>MockingTo mock this method, please mock GetDenyAssignmentAsync(String, CancellationToken) instead.</item>
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetDenyAssignments() instead.</item>
GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>
GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
<item>MockingTo mock this method, please mock GetRoleAssignment(String, String, CancellationToken) instead.</item>
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
<item>MockingTo mock this method, please mock GetRoleAssignmentAsync(String, String, CancellationToken) instead.</item>
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignments() instead.</item>
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
<item>MockingTo mock this method, please mock GetRoleAssignmentSchedule(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleAsync(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstance(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstanceAsync(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.</item>
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequest(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequestAsync(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.</item>
GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.</item>
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
<item>MockingTo mock this method, please mock GetRoleEligibilitySchedule(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleAsync(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstance(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstanceAsync(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.</item>
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequest(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequestAsync(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.</item>
GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.</item>
GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleManagementPolicies() instead.</item>
GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
<item>MockingTo mock this method, please mock GetRoleManagementPolicy(String, CancellationToken) instead.</item>
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignment(String, CancellationToken) instead.</item>
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignmentAsync(String, CancellationToken) instead.</item>
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.</item>
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAsync(String, CancellationToken) instead.</item>
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to