Microsoft.OperationalInsights (stable:2025-02-01)

2025/03/17 • 72 new methods

AvailableServiceTiers_ListByWorkspace (new)
Description :  Gets the available service tiers for the workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/availableServiceTiers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceTier:
{
Description: The name of the Service Tier. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: True if the Service Tier is enabled for the workspace. ,
Required: False ,
}
boolean ,
minimumRetention:
{
Description: The minimum retention for the Service Tier, in days. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumRetention:
{
Description: The maximum retention for the Service Tier, in days. ,
Format: int64 ,
Required: False ,
}
integer ,
defaultRetention:
{
Description: The default retention for the Service Tier, in days. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB per day. Returned for the Capacity Reservation Service Tier. ,
Format: int64 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: Time when the sku was last updated for the workspace. Returned for the Capacity Reservation Service Tier. ,
Required: False ,
}
string ,
}
Clusters_ListByResourceGroup (new)
Description :  Gets Log Analytics clusters in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Description: A list of Log Analytics clusters. ,
Required: False ,
}
[
{
identity:
{
Description: Resource's identity. ,
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 properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity reservation level in Gigabytes for this cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The SKU (tier) of a cluster. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
isDoubleEncryptionEnabled:
{
Description: Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true' ,
Required: False ,
}
boolean ,
isAvailabilityZonesEnabled:
{
Description: Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones. ,
Required: False ,
}
boolean ,
billingType:
{
Description: The cluster's billing type. ,
Enum:
{
Cluster: No description available. ,
Workspaces: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyRsaSize:
{
Description: Selected key minimum required size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
lastModifiedDate:
{
Description: The last time the cluster was updated. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Format: date-time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: Associated workspace immutable id. ,
Format: uuid ,
Required: False ,
}
string ,
workspaceName:
{
Description: Associated workspace resource name. ,
Required: False ,
}
string ,
resourceId:
{
Description: Associated workspace arm resource id, in the form of: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}. ,
Format: arm-id ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in Gigabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
replication:
{
Description: Cluster's replication properties. ,
Required: False ,
}
{
location:
{
Description: The secondary location of the replication. If replication is being enabled, enabled must be provided. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true the cluster is replicate to the specified location. ,
Required: False ,
}
boolean ,
isAvailabilityZonesEnabled:
{
Description: Should enable AvailabilityZones for the given replicated cluster ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the cluster replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The cluster's replication creation time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time the cluster's replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Clusters_List (new)
Description :  Gets the Log Analytics clusters in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/clusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Description: A list of Log Analytics clusters. ,
Required: False ,
}
[
{
identity:
{
Description: Resource's identity. ,
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 properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity reservation level in Gigabytes for this cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The SKU (tier) of a cluster. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
isDoubleEncryptionEnabled:
{
Description: Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true' ,
Required: False ,
}
boolean ,
isAvailabilityZonesEnabled:
{
Description: Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones. ,
Required: False ,
}
boolean ,
billingType:
{
Description: The cluster's billing type. ,
Enum:
{
Cluster: No description available. ,
Workspaces: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyRsaSize:
{
Description: Selected key minimum required size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
lastModifiedDate:
{
Description: The last time the cluster was updated. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Format: date-time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: Associated workspace immutable id. ,
Format: uuid ,
Required: False ,
}
string ,
workspaceName:
{
Description: Associated workspace resource name. ,
Required: False ,
}
string ,
resourceId:
{
Description: Associated workspace arm resource id, in the form of: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}. ,
Format: arm-id ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in Gigabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
replication:
{
Description: Cluster's replication properties. ,
Required: False ,
}
{
location:
{
Description: The secondary location of the replication. If replication is being enabled, enabled must be provided. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true the cluster is replicate to the specified location. ,
Required: False ,
}
boolean ,
isAvailabilityZonesEnabled:
{
Description: Should enable AvailabilityZones for the given replicated cluster ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the cluster replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The cluster's replication creation time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time the cluster's replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Clusters_CreateOrUpdate (new)
Description :  Create or update a Log Analytics cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the Log Analytics cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a Log Analytics cluster. ,
Required: True ,
}
{
identity:
{
Description: Resource's identity. ,
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 properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity reservation level in Gigabytes for this cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The SKU (tier) of a cluster. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
isDoubleEncryptionEnabled:
{
Description: Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true' ,
Required: False ,
}
boolean ,
isAvailabilityZonesEnabled:
{
Description: Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones. ,
Required: False ,
}
boolean ,
billingType:
{
Description: The cluster's billing type. ,
Enum:
{
Cluster: No description available. ,
Workspaces: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyRsaSize:
{
Description: Selected key minimum required size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
lastModifiedDate:
{
Description: The last time the cluster was updated. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Format: date-time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: Associated workspace immutable id. ,
Format: uuid ,
Required: False ,
}
string ,
workspaceName:
{
Description: Associated workspace resource name. ,
Required: False ,
}
string ,
resourceId:
{
Description: Associated workspace arm resource id, in the form of: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}. ,
Format: arm-id ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in Gigabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
replication:
{
Description: Cluster's replication properties. ,
Required: False ,
}
{
location:
{
Description: The secondary location of the replication. If replication is being enabled, enabled must be provided. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true the cluster is replicate to the specified location. ,
Required: False ,
}
boolean ,
isAvailabilityZonesEnabled:
{
Description: Should enable AvailabilityZones for the given replicated cluster ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the cluster replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The cluster's replication creation time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time the cluster's replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (200)

{
identity:
{
Description: Resource's identity. ,
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 properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity reservation level in Gigabytes for this cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The SKU (tier) of a cluster. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
isDoubleEncryptionEnabled:
{
Description: Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true' ,
Required: False ,
}
boolean ,
isAvailabilityZonesEnabled:
{
Description: Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones. ,
Required: False ,
}
boolean ,
billingType:
{
Description: The cluster's billing type. ,
Enum:
{
Cluster: No description available. ,
Workspaces: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyRsaSize:
{
Description: Selected key minimum required size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
lastModifiedDate:
{
Description: The last time the cluster was updated. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Format: date-time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: Associated workspace immutable id. ,
Format: uuid ,
Required: False ,
}
string ,
workspaceName:
{
Description: Associated workspace resource name. ,
Required: False ,
}
string ,
resourceId:
{
Description: Associated workspace arm resource id, in the form of: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}. ,
Format: arm-id ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in Gigabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
replication:
{
Description: Cluster's replication properties. ,
Required: False ,
}
{
location:
{
Description: The secondary location of the replication. If replication is being enabled, enabled must be provided. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true the cluster is replicate to the specified location. ,
Required: False ,
}
boolean ,
isAvailabilityZonesEnabled:
{
Description: Should enable AvailabilityZones for the given replicated cluster ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the cluster replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The cluster's replication creation time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time the cluster's replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Clusters_Delete (new)
Description :  Deletes a cluster instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the Log Analytics Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Clusters_Get (new)
Description :  Gets a Log Analytics cluster instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the Log Analytics Cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Resource's identity. ,
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 properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity reservation level in Gigabytes for this cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The SKU (tier) of a cluster. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
isDoubleEncryptionEnabled:
{
Description: Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true' ,
Required: False ,
}
boolean ,
isAvailabilityZonesEnabled:
{
Description: Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones. ,
Required: False ,
}
boolean ,
billingType:
{
Description: The cluster's billing type. ,
Enum:
{
Cluster: No description available. ,
Workspaces: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyRsaSize:
{
Description: Selected key minimum required size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
lastModifiedDate:
{
Description: The last time the cluster was updated. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Format: date-time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: Associated workspace immutable id. ,
Format: uuid ,
Required: False ,
}
string ,
workspaceName:
{
Description: Associated workspace resource name. ,
Required: False ,
}
string ,
resourceId:
{
Description: Associated workspace arm resource id, in the form of: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}. ,
Format: arm-id ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in Gigabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
replication:
{
Description: Cluster's replication properties. ,
Required: False ,
}
{
location:
{
Description: The secondary location of the replication. If replication is being enabled, enabled must be provided. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true the cluster is replicate to the specified location. ,
Required: False ,
}
boolean ,
isAvailabilityZonesEnabled:
{
Description: Should enable AvailabilityZones for the given replicated cluster ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the cluster replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The cluster's replication creation time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time the cluster's replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Clusters_Update (new)
Description :  Updates a Log Analytics cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the Log Analytics Cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to patch a Log Analytics cluster. ,
Required: True ,
}
{
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyRsaSize:
{
Description: Selected key minimum required size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
billingType:
{
Description: The cluster's billing type. ,
Enum:
{
Cluster: No description available. ,
Workspaces: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Resource's identity. ,
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 properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity reservation level in Gigabytes for this cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The SKU (tier) of a cluster. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Resource's identity. ,
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 properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity reservation level in Gigabytes for this cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The SKU (tier) of a cluster. ,
Enum:
{
CapacityReservation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Log Analytics cluster properties. ,
Required: False ,
}
{
clusterId:
{
Description: The ID associated with the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
isDoubleEncryptionEnabled:
{
Description: Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true' ,
Required: False ,
}
boolean ,
isAvailabilityZonesEnabled:
{
Description: Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones. ,
Required: False ,
}
boolean ,
billingType:
{
Description: The cluster's billing type. ,
Enum:
{
Cluster: No description available. ,
Workspaces: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The associated key properties. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Key Vault uri which holds they key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key associated with the Log Analytics cluster. ,
Required: False ,
}
string ,
keyRsaSize:
{
Description: Selected key minimum required size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
lastModifiedDate:
{
Description: The last time the cluster was updated. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Format: date-time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: Associated workspace immutable id. ,
Format: uuid ,
Required: False ,
}
string ,
workspaceName:
{
Description: Associated workspace resource name. ,
Required: False ,
}
string ,
resourceId:
{
Description: Associated workspace arm resource id, in the form of: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}. ,
Format: arm-id ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in Gigabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
replication:
{
Description: Cluster's replication properties. ,
Required: False ,
}
{
location:
{
Description: The secondary location of the replication. If replication is being enabled, enabled must be provided. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true the cluster is replicate to the specified location. ,
Required: False ,
}
boolean ,
isAvailabilityZonesEnabled:
{
Description: Should enable AvailabilityZones for the given replicated cluster ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the cluster replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The cluster's replication creation time ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time the cluster's replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
DataExports_ListByWorkspace (new)
Description :  Lists the data export instances within a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of data export instances within a workspace.. ,
Required: False ,
}
[
{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DataExports_CreateOrUpdate (new)
Description :  Create or update a data export.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports/{dataExportName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
dataExportName:
{
Description: The data export rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a data export. ,
Required: True ,
}
{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DataExports_Get (new)
Description :  Gets a data export instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports/{dataExportName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
dataExportName:
{
Description: The data export rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: data export properties. ,
Required: False ,
}
{
dataExportId:
{
Description: The data export rule ID. ,
Required: False ,
}
string ,
tableNames:
{
Description: An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. ,
Required: True ,
}
[
string ,
]
,
destination:
{
Description: destination properties. ,
Required: False ,
}
{
resourceId:
{
Description: The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. ,
Required: True ,
}
string ,
type:
{
Description: The type of the destination resource ,
Enum:
{
StorageAccount: No description available. ,
EventHub: No description available. ,
}
,
Required: False ,
}
enum ,
metaData:
{
Description: destination meta data. ,
Required: False ,
}
{
eventHubName:
{
Description: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. ,
Required: False ,
}
string ,
}
,
}
,
enable:
{
Description: Active when enabled. ,
Required: False ,
}
boolean ,
createdDate:
{
Description: The latest data export rule modification time. ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: Date and time when the export was last modified. ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DataExports_Delete (new)
Description :  Deletes the specified data export in a given workspace..
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataExports/{dataExportName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
dataExportName:
{
Description: The data export rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
DataSources_CreateOrUpdate (new)
Description :  Create or update a data source.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources/{dataSourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
dataSourceName:
{
Description: The name of the datasource resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a datasource. ,
Required: True ,
}
{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
etag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
IISLogs: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
AzureAuditLog: No description available. ,
AzureActivityLog: No description available. ,
GenericDataSource: No description available. ,
ChangeTrackingCustomPath: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingServices: No description available. ,
ChangeTrackingDataTypeConfiguration: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingRegistry: No description available. ,
ChangeTrackingLinuxPath: No description available. ,
LinuxChangeTrackingPath: No description available. ,
ChangeTrackingContentLocation: No description available. ,
WindowsTelemetry: No description available. ,
Office365: No description available. ,
SecurityWindowsBaselineConfiguration: No description available. ,
SecurityCenterSecurityWindowsBaselineConfiguration: No description available. ,
SecurityEventCollectionConfiguration: No description available. ,
SecurityInsightsSecurityEventCollectionConfiguration: No description available. ,
ImportComputerGroup: No description available. ,
NetworkMonitoring: No description available. ,
Itsm: No description available. ,
DnsAnalytics: No description available. ,
ApplicationInsights: No description available. ,
SqlDataClassification: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
etag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
IISLogs: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
AzureAuditLog: No description available. ,
AzureActivityLog: No description available. ,
GenericDataSource: No description available. ,
ChangeTrackingCustomPath: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingServices: No description available. ,
ChangeTrackingDataTypeConfiguration: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingRegistry: No description available. ,
ChangeTrackingLinuxPath: No description available. ,
LinuxChangeTrackingPath: No description available. ,
ChangeTrackingContentLocation: No description available. ,
WindowsTelemetry: No description available. ,
Office365: No description available. ,
SecurityWindowsBaselineConfiguration: No description available. ,
SecurityCenterSecurityWindowsBaselineConfiguration: No description available. ,
SecurityEventCollectionConfiguration: No description available. ,
SecurityInsightsSecurityEventCollectionConfiguration: No description available. ,
ImportComputerGroup: No description available. ,
NetworkMonitoring: No description available. ,
Itsm: No description available. ,
DnsAnalytics: No description available. ,
ApplicationInsights: No description available. ,
SqlDataClassification: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
etag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
IISLogs: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
AzureAuditLog: No description available. ,
AzureActivityLog: No description available. ,
GenericDataSource: No description available. ,
ChangeTrackingCustomPath: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingServices: No description available. ,
ChangeTrackingDataTypeConfiguration: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingRegistry: No description available. ,
ChangeTrackingLinuxPath: No description available. ,
LinuxChangeTrackingPath: No description available. ,
ChangeTrackingContentLocation: No description available. ,
WindowsTelemetry: No description available. ,
Office365: No description available. ,
SecurityWindowsBaselineConfiguration: No description available. ,
SecurityCenterSecurityWindowsBaselineConfiguration: No description available. ,
SecurityEventCollectionConfiguration: No description available. ,
SecurityInsightsSecurityEventCollectionConfiguration: No description available. ,
ImportComputerGroup: No description available. ,
NetworkMonitoring: No description available. ,
Itsm: No description available. ,
DnsAnalytics: No description available. ,
ApplicationInsights: No description available. ,
SqlDataClassification: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
DataSources_Delete (new)
Description :  Deletes a data source instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources/{dataSourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
dataSourceName:
{
Description: Name of the datasource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
DataSources_Get (new)
Description :  Gets a datasource instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources/{dataSourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
dataSourceName:
{
Description: Name of the datasource ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
etag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
IISLogs: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
AzureAuditLog: No description available. ,
AzureActivityLog: No description available. ,
GenericDataSource: No description available. ,
ChangeTrackingCustomPath: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingServices: No description available. ,
ChangeTrackingDataTypeConfiguration: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingRegistry: No description available. ,
ChangeTrackingLinuxPath: No description available. ,
LinuxChangeTrackingPath: No description available. ,
ChangeTrackingContentLocation: No description available. ,
WindowsTelemetry: No description available. ,
Office365: No description available. ,
SecurityWindowsBaselineConfiguration: No description available. ,
SecurityCenterSecurityWindowsBaselineConfiguration: No description available. ,
SecurityEventCollectionConfiguration: No description available. ,
SecurityInsightsSecurityEventCollectionConfiguration: No description available. ,
ImportComputerGroup: No description available. ,
NetworkMonitoring: No description available. ,
Itsm: No description available. ,
DnsAnalytics: No description available. ,
ApplicationInsights: No description available. ,
SqlDataClassification: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
DataSources_ListByWorkspace (new)
Description :  Gets the first page of data source instances in a workspace with the link to the next page.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/dataSources
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: True ,
}
string ,
$skiptoken:
{
Description: Starting point of the collection of data source instances. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of datasources. ,
Required: False ,
}
[
{
properties:
{
Description: The data source properties in raw json format, each kind of data source have it's own schema. ,
Required: True ,
}
object ,
etag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the DataSource. ,
Enum:
{
WindowsEvent: No description available. ,
WindowsPerformanceCounter: No description available. ,
IISLogs: No description available. ,
LinuxSyslog: No description available. ,
LinuxSyslogCollection: No description available. ,
LinuxPerformanceObject: No description available. ,
LinuxPerformanceCollection: No description available. ,
CustomLog: No description available. ,
CustomLogCollection: No description available. ,
AzureAuditLog: No description available. ,
AzureActivityLog: No description available. ,
GenericDataSource: No description available. ,
ChangeTrackingCustomPath: No description available. ,
ChangeTrackingPath: No description available. ,
ChangeTrackingServices: No description available. ,
ChangeTrackingDataTypeConfiguration: No description available. ,
ChangeTrackingDefaultRegistry: No description available. ,
ChangeTrackingRegistry: No description available. ,
ChangeTrackingLinuxPath: No description available. ,
LinuxChangeTrackingPath: No description available. ,
ChangeTrackingContentLocation: No description available. ,
WindowsTelemetry: No description available. ,
Office365: No description available. ,
SecurityWindowsBaselineConfiguration: No description available. ,
SecurityCenterSecurityWindowsBaselineConfiguration: No description available. ,
SecurityEventCollectionConfiguration: No description available. ,
SecurityInsightsSecurityEventCollectionConfiguration: No description available. ,
ImportComputerGroup: No description available. ,
NetworkMonitoring: No description available. ,
Itsm: No description available. ,
DnsAnalytics: No description available. ,
ApplicationInsights: No description available. ,
SqlDataClassification: No description available. ,
}
,
Required: True ,
}
enum ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of datasources. ,
Required: False ,
}
string ,
}
Gateways_Delete (new)
Description :  Delete a Log Analytics gateway.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/gateways/{gatewayId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
gatewayId:
{
Description: The Log Analytics gateway Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
IntelligencePacks_Disable (new)
Description :  Disables an intelligence pack for a given workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks/{intelligencePackName}/Disable
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
intelligencePackName:
{
Description: The name of the intelligence pack to be disabled. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
IntelligencePacks_Enable (new)
Description :  Enables an intelligence pack for a given workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks/{intelligencePackName}/Enable
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
intelligencePackName:
{
Description: The name of the intelligence pack to be enabled. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
IntelligencePacks_List (new)
Description :  Lists all the intelligence packs possible and whether they are enabled or disabled for a given workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/intelligencePacks
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the intelligence pack. ,
Required: False ,
}
string ,
enabled:
{
Description: The enabled boolean for the intelligence pack. ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the intelligence pack. ,
Required: False ,
}
string ,
}
LinkedServices_CreateOrUpdate (new)
Description :  Create or update a linked service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices/{linkedServiceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: Name of the linkedServices resource ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a linked service. ,
Required: True ,
}
{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linked service. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linked service. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linked service. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
LinkedServices_Delete (new)
Description :  Deletes a linked service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices/{linkedServiceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: Name of the linked service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linked service. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
LinkedServices_Get (new)
Description :  Gets a linked service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices/{linkedServiceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
linkedServiceName:
{
Description: Name of the linked service. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linked service. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
LinkedServices_ListByWorkspace (new)
Description :  Gets the linked services instances in a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of linked service instances ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the linked service. ,
Required: True ,
}
{
resourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access ,
Required: False ,
}
string ,
writeAccessResourceId:
{
Description: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the linked service. ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
]
,
}
LinkedStorageAccounts_CreateOrUpdate (new)
Description :  Create or Update a link relation between current workspace and a group of storage accounts of a specific data source type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts/{dataSourceType}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
dataSourceType:
{
Description: Linked storage accounts type. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update linked storage accounts. ,
Required: True ,
}
{
properties:
{
Description: Linked storage accounts properties. ,
Required: True ,
}
{
dataSourceType:
{
Description: Linked storage accounts type. ,
Enum:
{
CustomLogs: No description available. ,
AzureWatson: No description available. ,
Query: No description available. ,
Ingestion: No description available. ,
Alerts: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountIds:
{
Description: Linked storage accounts resources ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Linked storage accounts properties. ,
Required: True ,
}
{
dataSourceType:
{
Description: Linked storage accounts type. ,
Enum:
{
CustomLogs: No description available. ,
AzureWatson: No description available. ,
Query: No description available. ,
Ingestion: No description available. ,
Alerts: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountIds:
{
Description: Linked storage accounts resources ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LinkedStorageAccounts_Delete (new)
Description :  Deletes all linked storage accounts of a specific data source type associated with the specified workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts/{dataSourceType}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
dataSourceType:
{
Description: Linked storage accounts type. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
LinkedStorageAccounts_Get (new)
Description :  Gets all linked storage account of a specific data source type associated with the specified workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts/{dataSourceType}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
dataSourceType:
{
Description: Linked storage accounts type. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Linked storage accounts properties. ,
Required: True ,
}
{
dataSourceType:
{
Description: Linked storage accounts type. ,
Enum:
{
CustomLogs: No description available. ,
AzureWatson: No description available. ,
Query: No description available. ,
Ingestion: No description available. ,
Alerts: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountIds:
{
Description: Linked storage accounts resources ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LinkedStorageAccounts_ListByWorkspace (new)
Description :  Gets all linked storage accounts associated with the specified workspace, storage accounts will be sorted by their data source type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedStorageAccounts
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of linked storage accounts instances. ,
Required: False ,
}
[
{
properties:
{
Description: Linked storage accounts properties. ,
Required: True ,
}
{
dataSourceType:
{
Description: Linked storage accounts type. ,
Enum:
{
CustomLogs: No description available. ,
AzureWatson: No description available. ,
Query: No description available. ,
Ingestion: No description available. ,
Alerts: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountIds:
{
Description: Linked storage accounts resources ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
ManagementGroups_List (new)
Description :  Gets a list of management groups connected to a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/managementGroups
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of management groups attached to the workspace. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the management group. ,
Required: False ,
}
{
serverCount:
{
Description: The number of servers connected to the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
isGateway:
{
Description: Gets or sets a value indicating whether the management group is a gateway. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the management group. ,
Required: False ,
}
string ,
id:
{
Description: The unique ID of the management group. ,
Required: False ,
}
string ,
created:
{
Description: The datetime that the management group was created. ,
Format: date-time ,
Required: False ,
}
string ,
dataReceived:
{
Description: The last datetime that the management group received data. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: The version of System Center that is managing the management group. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of System Center that is managing the management group. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
OperationStatuses_Get (new)
Description :  Get the status of a long running azure asynchronous operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/locations/{location}/operationStatuses/{asyncOperationId}
{
location:
{
Description: The region name of operation. ,
Required: True ,
}
string ,
asyncOperationId:
{
Description: The operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The operation Id. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
}
,
}
Operations_List (new)
Description :  Lists all of the available OperationalInsights Rest API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.OperationalInsights/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of solution operations supported by the OperationsManagement resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft OperationsManagement. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed etc. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Queries_List (new)
Description :  Gets a list of Queries defined within a Log Analytics QueryPack.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
queryPackName:
{
Description: The name of the Log Analytics QueryPack resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$top:
{
Description: Maximum items returned in page. ,
Format: int64 ,
Required: False ,
}
integer ,
includeBody:
{
Description: Flag indicating whether or not to return the body of each applicable query. If false, only return the query information. ,
Required: False ,
}
boolean ,
$skipToken:
{
Description: Base64 encoded token used to fetch the next page of items. Default is null. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Log Analytics QueryPack Query definitions. ,
Required: True ,
}
[
{
properties:
{
Description: Properties that define an Log Analytics QueryPack-Query resource. ,
Required: False ,
}
{
id:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
displayName:
{
Description: Unique display name for your query within the Query Pack. ,
Required: True ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics Query, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics Query, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
author:
{
Description: Object Id of user creating the query. ,
Required: False ,
}
string ,
description:
{
Description: Description of the query. ,
Required: False ,
}
string ,
body:
{
Description: Body of the query. ,
Required: True ,
}
string ,
related:
{
Description: The related metadata items for the function. ,
Required: False ,
}
{
categories:
{
Description: The related categories for the function. ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the function. ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the function. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Tags associated with the query. ,
Required: False ,
}
object ,
properties:
{
Description: Additional properties that can be set for the query. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to get the next set of Log Analytics QueryPack definitions if too many QueryPack-Queries where returned in the result set. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Queries_Get (new)
Description :  Gets a specific Log Analytics Query defined within a Log Analytics QueryPack.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/{id}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
queryPackName:
{
Description: The name of the Log Analytics QueryPack resource. ,
Required: True ,
}
string ,
id:
{
Description: The id of a specific query defined in the Log Analytics QueryPack ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define an Log Analytics QueryPack-Query resource. ,
Required: False ,
}
{
id:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
displayName:
{
Description: Unique display name for your query within the Query Pack. ,
Required: True ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics Query, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics Query, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
author:
{
Description: Object Id of user creating the query. ,
Required: False ,
}
string ,
description:
{
Description: Description of the query. ,
Required: False ,
}
string ,
body:
{
Description: Body of the query. ,
Required: True ,
}
string ,
related:
{
Description: The related metadata items for the function. ,
Required: False ,
}
{
categories:
{
Description: The related categories for the function. ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the function. ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the function. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Tags associated with the query. ,
Required: False ,
}
object ,
properties:
{
Description: Additional properties that can be set for the query. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Queries_Put (new)
Description :  Adds or Updates a specific Query within a Log Analytics QueryPack.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/{id}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
queryPackName:
{
Description: The name of the Log Analytics QueryPack resource. ,
Required: True ,
}
string ,
id:
{
Description: The id of a specific query defined in the Log Analytics QueryPack ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
QueryPayload:
{
Description: Properties that need to be specified to create a new query and add it to a Log Analytics QueryPack. ,
Required: True ,
}
{
properties:
{
Description: Properties that define an Log Analytics QueryPack-Query resource. ,
Required: False ,
}
{
id:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
displayName:
{
Description: Unique display name for your query within the Query Pack. ,
Required: True ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics Query, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics Query, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
author:
{
Description: Object Id of user creating the query. ,
Required: False ,
}
string ,
description:
{
Description: Description of the query. ,
Required: False ,
}
string ,
body:
{
Description: Body of the query. ,
Required: True ,
}
string ,
related:
{
Description: The related metadata items for the function. ,
Required: False ,
}
{
categories:
{
Description: The related categories for the function. ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the function. ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the function. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Tags associated with the query. ,
Required: False ,
}
object ,
properties:
{
Description: Additional properties that can be set for the query. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define an Log Analytics QueryPack-Query resource. ,
Required: False ,
}
{
id:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
displayName:
{
Description: Unique display name for your query within the Query Pack. ,
Required: True ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics Query, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics Query, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
author:
{
Description: Object Id of user creating the query. ,
Required: False ,
}
string ,
description:
{
Description: Description of the query. ,
Required: False ,
}
string ,
body:
{
Description: Body of the query. ,
Required: True ,
}
string ,
related:
{
Description: The related metadata items for the function. ,
Required: False ,
}
{
categories:
{
Description: The related categories for the function. ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the function. ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the function. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Tags associated with the query. ,
Required: False ,
}
object ,
properties:
{
Description: Additional properties that can be set for the query. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Queries_Update (new)
Description :  Adds or Updates a specific Query within a Log Analytics QueryPack.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/{id}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
queryPackName:
{
Description: The name of the Log Analytics QueryPack resource. ,
Required: True ,
}
string ,
id:
{
Description: The id of a specific query defined in the Log Analytics QueryPack ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
QueryPayload:
{
Description: Properties that need to be specified to create a new query and add it to a Log Analytics QueryPack. ,
Required: True ,
}
{
properties:
{
Description: Properties that define an Log Analytics QueryPack-Query resource. ,
Required: False ,
}
{
id:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
displayName:
{
Description: Unique display name for your query within the Query Pack. ,
Required: True ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics Query, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics Query, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
author:
{
Description: Object Id of user creating the query. ,
Required: False ,
}
string ,
description:
{
Description: Description of the query. ,
Required: False ,
}
string ,
body:
{
Description: Body of the query. ,
Required: True ,
}
string ,
related:
{
Description: The related metadata items for the function. ,
Required: False ,
}
{
categories:
{
Description: The related categories for the function. ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the function. ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the function. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Tags associated with the query. ,
Required: False ,
}
object ,
properties:
{
Description: Additional properties that can be set for the query. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define an Log Analytics QueryPack-Query resource. ,
Required: False ,
}
{
id:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
displayName:
{
Description: Unique display name for your query within the Query Pack. ,
Required: True ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics Query, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics Query, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
author:
{
Description: Object Id of user creating the query. ,
Required: False ,
}
string ,
description:
{
Description: Description of the query. ,
Required: False ,
}
string ,
body:
{
Description: Body of the query. ,
Required: True ,
}
string ,
related:
{
Description: The related metadata items for the function. ,
Required: False ,
}
{
categories:
{
Description: The related categories for the function. ,
Required: False ,
}
[
string ,
]
,
resourceTypes:
{
Description: The related resource types for the function. ,
Required: False ,
}
[
string ,
]
,
solutions:
{
Description: The related Log Analytics solutions for the function. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Tags associated with the query. ,
Required: False ,
}
object ,
properties:
{
Description: Additional properties that can be set for the query. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Queries_Delete (new)
Description :  Deletes a specific Query defined within an Log Analytics QueryPack.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/{id}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
queryPackName:
{
Description: The name of the Log Analytics QueryPack resource. ,
Required: True ,
}
string ,
id:
{
Description: The id of a specific query defined in the Log Analytics QueryPack ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
QueryPacks_List (new)
Description :  Gets a list of all Log Analytics QueryPacks within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/queryPacks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of Log Analytics QueryPack definitions. ,
Required: True ,
}
[
{
properties:
{
Description: Properties that define a Log Analytics QueryPack resource. ,
Required: True ,
}
{
queryPackId:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to get the next set of Log Analytics QueryPack definitions if too many QueryPacks where returned in the result set. ,
Required: False ,
}
string ,
}
QueryPacks_ListByResourceGroup (new)
Description :  Gets a list of Log Analytics QueryPacks within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of Log Analytics QueryPack definitions. ,
Required: True ,
}
[
{
properties:
{
Description: Properties that define a Log Analytics QueryPack resource. ,
Required: True ,
}
{
queryPackId:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to get the next set of Log Analytics QueryPack definitions if too many QueryPacks where returned in the result set. ,
Required: False ,
}
string ,
}
QueryPacks_CreateOrUpdateWithoutName (new)
Description :  Creates a Log Analytics QueryPack. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
LogAnalyticsQueryPackPayload:
{
Description: Properties that need to be specified to create or update a Log Analytics QueryPack. ,
Required: True ,
}
{
properties:
{
Description: Properties that define a Log Analytics QueryPack resource. ,
Required: True ,
}
{
queryPackId:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties that define a Log Analytics QueryPack resource. ,
Required: True ,
}
{
queryPackId:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed. ,
Required: False ,
}
string ,
}
,
}
QueryPacks_Delete (new)
Description :  Deletes a Log Analytics QueryPack.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
queryPackName:
{
Description: The name of the Log Analytics QueryPack resource. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
QueryPacks_Get (new)
Description :  Returns a Log Analytics QueryPack.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
queryPackName:
{
Description: The name of the Log Analytics QueryPack resource. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define a Log Analytics QueryPack resource. ,
Required: True ,
}
{
queryPackId:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed. ,
Required: False ,
}
string ,
}
,
}
QueryPacks_CreateOrUpdate (new)
Description :  Creates (or updates) a Log Analytics QueryPack. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
queryPackName:
{
Description: The name of the Log Analytics QueryPack resource. ,
Required: True ,
}
string ,
LogAnalyticsQueryPackPayload:
{
Description: Properties that need to be specified to create or update a Log Analytics QueryPack. ,
Required: True ,
}
{
properties:
{
Description: Properties that define a Log Analytics QueryPack resource. ,
Required: True ,
}
{
queryPackId:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define a Log Analytics QueryPack resource. ,
Required: True ,
}
{
queryPackId:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed. ,
Required: False ,
}
string ,
}
,
}
QueryPacks_UpdateTags (new)
Description :  Updates an existing QueryPack's tags. To update other fields use the CreateOrUpdate method.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
queryPackName:
{
Description: The name of the Log Analytics QueryPack resource. ,
Required: True ,
}
string ,
QueryPackTags:
{
Description: Updated tag information to set into the QueryPack instance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define a Log Analytics QueryPack resource. ,
Required: True ,
}
{
queryPackId:
{
Description: The unique ID of your application. This field cannot be changed. ,
Required: False ,
}
string ,
timeCreated:
{
Description: Creation Date for the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
timeModified:
{
Description: Last modified date of the Log Analytics QueryPack, in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed. ,
Required: False ,
}
string ,
}
,
}
SavedSearches_Delete (new)
Description :  Deletes the specified saved search in a given workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
savedSearchId:
{
Description: The id of the saved search. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
SavedSearches_CreateOrUpdate (new)
Description :  Creates or updates a saved search for a given workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
savedSearchId:
{
Description: The id of the saved search. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to save a search. ,
Required: True ,
}
{
etag:
{
Description: The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the saved search. ,
Required: True ,
}
{
category:
{
Description: The category of the saved search. This helps the user to find a saved search faster. ,
Required: True ,
}
string ,
displayName:
{
Description: Saved search display name. ,
Required: True ,
}
string ,
query:
{
Description: The query expression for the saved search. ,
Required: True ,
}
string ,
functionAlias:
{
Description: The function alias if query serves as a function. ,
Required: False ,
}
string ,
functionParameters:
{
Description: The optional function parameters if query serves as a function. Value should be in the following format: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. For more examples and proper syntax please refer to https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions. ,
Required: False ,
}
string ,
version:
{
Description: The version number of the query language. The current version is 2 and is the default. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags attached to the saved search. ,
Required: False ,
}
[
{
name:
{
Description: The tag name. ,
Required: True ,
}
string ,
value:
{
Description: The tag value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the saved search. ,
Required: True ,
}
{
category:
{
Description: The category of the saved search. This helps the user to find a saved search faster. ,
Required: True ,
}
string ,
displayName:
{
Description: Saved search display name. ,
Required: True ,
}
string ,
query:
{
Description: The query expression for the saved search. ,
Required: True ,
}
string ,
functionAlias:
{
Description: The function alias if query serves as a function. ,
Required: False ,
}
string ,
functionParameters:
{
Description: The optional function parameters if query serves as a function. Value should be in the following format: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. For more examples and proper syntax please refer to https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions. ,
Required: False ,
}
string ,
version:
{
Description: The version number of the query language. The current version is 2 and is the default. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags attached to the saved search. ,
Required: False ,
}
[
{
name:
{
Description: The tag name. ,
Required: True ,
}
string ,
value:
{
Description: The tag value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SavedSearches_Get (new)
Description :  Gets the specified saved search for a given workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
savedSearchId:
{
Description: The id of the saved search. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the saved search. ,
Required: True ,
}
{
category:
{
Description: The category of the saved search. This helps the user to find a saved search faster. ,
Required: True ,
}
string ,
displayName:
{
Description: Saved search display name. ,
Required: True ,
}
string ,
query:
{
Description: The query expression for the saved search. ,
Required: True ,
}
string ,
functionAlias:
{
Description: The function alias if query serves as a function. ,
Required: False ,
}
string ,
functionParameters:
{
Description: The optional function parameters if query serves as a function. Value should be in the following format: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. For more examples and proper syntax please refer to https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions. ,
Required: False ,
}
string ,
version:
{
Description: The version number of the query language. The current version is 2 and is the default. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags attached to the saved search. ,
Required: False ,
}
[
{
name:
{
Description: The tag name. ,
Required: True ,
}
string ,
value:
{
Description: The tag value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SavedSearches_ListByWorkspace (new)
Description :  Gets the saved searches for a given Log Analytics Workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of result values. ,
Required: False ,
}
[
{
etag:
{
Description: The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the saved search. ,
Required: True ,
}
{
category:
{
Description: The category of the saved search. This helps the user to find a saved search faster. ,
Required: True ,
}
string ,
displayName:
{
Description: Saved search display name. ,
Required: True ,
}
string ,
query:
{
Description: The query expression for the saved search. ,
Required: True ,
}
string ,
functionAlias:
{
Description: The function alias if query serves as a function. ,
Required: False ,
}
string ,
functionParameters:
{
Description: The optional function parameters if query serves as a function. Value should be in the following format: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. For more examples and proper syntax please refer to https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions. ,
Required: False ,
}
string ,
version:
{
Description: The version number of the query language. The current version is 2 and is the default. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags attached to the saved search. ,
Required: False ,
}
[
{
name:
{
Description: The tag name. ,
Required: True ,
}
string ,
value:
{
Description: The tag value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
Schema_Get (new)
Description :  Gets the schema for a given workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/schema
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
metadata:
{
Description: The metadata from search results. ,
Required: False ,
}
{
requestId:
{
Description: The request id of the search. ,
Required: False ,
}
string ,
resultType:
{
Description: The search result type. ,
Required: False ,
}
string ,
total:
{
Description: The total number of search results. ,
Format: int64 ,
Required: False ,
}
integer ,
top:
{
Description: The number of top search results. ,
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: The id of the search results request. ,
Required: False ,
}
string ,
coreSummaries:
{
Description: The core summaries. ,
Required: False ,
}
[
{
status:
{
Description: The status of a core summary. ,
Required: False ,
}
string ,
numberOfDocuments:
{
Description: The number of documents of a core summary. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
status:
{
Description: The status of the search results. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time for the search. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the search results. ,
Required: False ,
}
string ,
sort:
{
Description: How the results are sorted. ,
Required: False ,
}
[
{
name:
{
Description: The name of the field the search query is sorted on. ,
Required: False ,
}
string ,
order:
{
Description: The sort order of the search. ,
Enum:
{
asc: No description available. ,
desc: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
requestTime:
{
Description: The request time. ,
Format: int64 ,
Required: False ,
}
integer ,
aggregatedValueField:
{
Description: The aggregated value field. ,
Required: False ,
}
string ,
aggregatedGroupingFields:
{
Description: The aggregated grouping fields. ,
Required: False ,
}
string ,
sum:
{
Description: The sum of all aggregates returned in the result set. ,
Format: int64 ,
Required: False ,
}
integer ,
max:
{
Description: The max of all aggregates returned in the result set. ,
Format: int64 ,
Required: False ,
}
integer ,
schema:
{
Description: The schema. ,
Required: False ,
}
{
name:
{
Description: The name of the metadata schema. ,
Required: False ,
}
string ,
version:
{
Description: The version of the metadata schema. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
value:
{
Description: The array of result values. ,
Required: False ,
}
[
{
name:
{
Description: The name of the schema. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the schema. ,
Required: False ,
}
string ,
type:
{
Description: The type. ,
Required: False ,
}
string ,
indexed:
{
Description: The boolean that indicates the field is searchable as free text. ,
Required: True ,
}
boolean ,
stored:
{
Description: The boolean that indicates whether or not the field is stored. ,
Required: True ,
}
boolean ,
facet:
{
Description: The boolean that indicates whether or not the field is a facet. ,
Required: True ,
}
boolean ,
ownerType:
{
Description: The array of workflows containing the field. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
SharedKeys_GetSharedKeys (new)
Description :  Gets the shared keys for a workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/sharedKeys
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primarySharedKey:
{
Description: The primary shared key of a workspace. ,
Required: False ,
}
string ,
secondarySharedKey:
{
Description: The secondary shared key of a workspace. ,
Required: False ,
}
string ,
}
SharedKeys_Regenerate (new)
Description :  Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/regenerateSharedKey
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primarySharedKey:
{
Description: The primary shared key of a workspace. ,
Required: False ,
}
string ,
secondarySharedKey:
{
Description: The secondary shared key of a workspace. ,
Required: False ,
}
string ,
}
StorageInsightConfigs_CreateOrUpdate (new)
Description :  Create or update a storage insight.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs/{storageInsightName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
storageInsightName:
{
Description: Name of the storageInsightsConfigs resource ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a storage insight. ,
Required: True ,
}
{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
StorageInsightConfigs_Get (new)
Description :  Gets a storage insight instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs/{storageInsightName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
storageInsightName:
{
Description: Name of the storageInsightsConfigs resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
StorageInsightConfigs_Delete (new)
Description :  Deletes a storageInsightsConfigs resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs/{storageInsightName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
storageInsightName:
{
Description: Name of the storageInsightsConfigs resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
StorageInsightConfigs_ListByWorkspace (new)
Description :  Lists the storage insight instances within a workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/storageInsightConfigs
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of storage insight items. ,
Required: False ,
}
[
{
properties:
{
Description: Storage insight properties. ,
Required: False ,
}
{
containers:
{
Description: The names of the blob containers that the workspace should read ,
Required: False ,
}
[
string ,
]
,
tables:
{
Description: The names of the Azure tables that the workspace should read ,
Required: False ,
}
[
string ,
]
,
storageAccount:
{
Description: The storage account connection details ,
Required: True ,
}
{
id:
{
Description: The Azure Resource Manager ID of the storage account resource. ,
Required: True ,
}
string ,
key:
{
Description: The storage account key. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the storage insight ,
Required: False ,
}
{
state:
{
Description: The state of the storage insight connection to the workspace ,
Enum:
{
OK: No description available. ,
ERROR: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the state of the storage insight. ,
Required: False ,
}
string ,
}
,
}
,
eTag:
{
Description: The ETag of the storage insight. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
]
,
@odata.nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}
Tables_ListByWorkspace (new)
Description :  Gets all the tables for the specified Log Analytics workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of data tables. ,
Required: False ,
}
[
{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
azureAsyncOperationId:
{
Description: Search results table async operation id. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
azureAsyncOperationId:
{
Description: Search results table async operation id. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
scannedGb:
{
Description: Search job: Amount of scanned data. ,
Required: False ,
}
number ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
Deleting: Table state is deleting. ,
}
,
Required: False ,
}
enum ,
retentionInDaysAsDefault:
{
Description: True - Value originates from workspace retention in days, False - Customer specific. ,
Required: False ,
}
boolean ,
totalRetentionInDaysAsDefault:
{
Description: True - Value originates from retention in days, False - Customer specific. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Tables_CreateOrUpdate (new)
Description :  Update or Create a Log Analytics workspace table.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to update table properties. ,
Required: True ,
}
{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
azureAsyncOperationId:
{
Description: Search results table async operation id. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
azureAsyncOperationId:
{
Description: Search results table async operation id. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
scannedGb:
{
Description: Search job: Amount of scanned data. ,
Required: False ,
}
number ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
Deleting: Table state is deleting. ,
}
,
Required: False ,
}
enum ,
retentionInDaysAsDefault:
{
Description: True - Value originates from workspace retention in days, False - Customer specific. ,
Required: False ,
}
boolean ,
totalRetentionInDaysAsDefault:
{
Description: True - Value originates from retention in days, False - Customer specific. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
azureAsyncOperationId:
{
Description: Search results table async operation id. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
azureAsyncOperationId:
{
Description: Search results table async operation id. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
scannedGb:
{
Description: Search job: Amount of scanned data. ,
Required: False ,
}
number ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
Deleting: Table state is deleting. ,
}
,
Required: False ,
}
enum ,
retentionInDaysAsDefault:
{
Description: True - Value originates from workspace retention in days, False - Customer specific. ,
Required: False ,
}
boolean ,
totalRetentionInDaysAsDefault:
{
Description: True - Value originates from retention in days, False - Customer specific. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Tables_Update (new)
Description :  Update a Log Analytics workspace table.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to update table properties. ,
Required: True ,
}
{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
azureAsyncOperationId:
{
Description: Search results table async operation id. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
azureAsyncOperationId:
{
Description: Search results table async operation id. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
scannedGb:
{
Description: Search job: Amount of scanned data. ,
Required: False ,
}
number ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
Deleting: Table state is deleting. ,
}
,
Required: False ,
}
enum ,
retentionInDaysAsDefault:
{
Description: True - Value originates from workspace retention in days, False - Customer specific. ,
Required: False ,
}
boolean ,
totalRetentionInDaysAsDefault:
{
Description: True - Value originates from retention in days, False - Customer specific. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
azureAsyncOperationId:
{
Description: Search results table async operation id. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
azureAsyncOperationId:
{
Description: Search results table async operation id. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
scannedGb:
{
Description: Search job: Amount of scanned data. ,
Required: False ,
}
number ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
Deleting: Table state is deleting. ,
}
,
Required: False ,
}
enum ,
retentionInDaysAsDefault:
{
Description: True - Value originates from workspace retention in days, False - Customer specific. ,
Required: False ,
}
boolean ,
totalRetentionInDaysAsDefault:
{
Description: True - Value originates from retention in days, False - Customer specific. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Tables_Get (new)
Description :  Gets a Log Analytics workspace table.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Table's properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRetentionInDays:
{
Description: The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention. ,
Format: int32 ,
Required: False ,
}
integer ,
archiveRetentionInDays:
{
Description: The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) ,
Format: int32 ,
Required: False ,
}
integer ,
searchResults:
{
Description: Parameters of the search job that initiated this table. ,
Required: False ,
}
{
query:
{
Description: Search job query. ,
Required: False ,
}
string ,
description:
{
Description: Search job Description. ,
Required: False ,
}
string ,
limit:
{
Description: Limit the search job to return up to specified number of rows. ,
Format: int32 ,
Required: False ,
}
integer ,
startSearchTime:
{
Description: The timestamp to start the search from (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endSearchTime:
{
Description: The timestamp to end the search by (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table used in the search job. ,
Required: False ,
}
string ,
azureAsyncOperationId:
{
Description: Search results table async operation id. ,
Required: False ,
}
string ,
}
,
restoredLogs:
{
Description: Parameters of the restore operation that initiated this table. ,
Required: False ,
}
{
startRestoreTime:
{
Description: The timestamp to start the restore from (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endRestoreTime:
{
Description: The timestamp to end the restore by (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
sourceTable:
{
Description: The table to restore data from. ,
Required: False ,
}
string ,
azureAsyncOperationId:
{
Description: Search results table async operation id. ,
Required: False ,
}
string ,
}
,
resultStatistics:
{
Description: Search job execution statistics. ,
Required: False ,
}
{
progress:
{
Description: Search job completion percentage. ,
Required: False ,
}
number ,
ingestedRecords:
{
Description: The number of rows that were returned by the search job. ,
Format: int32 ,
Required: False ,
}
integer ,
scannedGb:
{
Description: Search job: Amount of scanned data. ,
Required: False ,
}
number ,
}
,
plan:
{
Description: Instruct the system how to handle and charge the logs ingested to this table. ,
Enum:
{
Basic: Logs that are adjusted to support high volume low value verbose logs. ,
Analytics: Logs that allow monitoring and analytics. ,
}
,
Required: False ,
}
enum ,
lastPlanModifiedDate:
{
Description: The timestamp that table plan was last modified (UTC). ,
Required: False ,
}
string ,
schema:
{
Description: Table schema. ,
Required: False ,
}
{
name:
{
Description: Table name. ,
Required: False ,
}
string ,
displayName:
{
Description: Table display name. ,
Required: False ,
}
string ,
description:
{
Description: Table description. ,
Required: False ,
}
string ,
columns:
{
Description: A list of table custom columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
standardColumns:
{
Description: A list of table standard columns. ,
Required: False ,
}
[
{
name:
{
Description: Column name. ,
Required: False ,
}
string ,
type:
{
Description: Column data type. ,
Enum:
{
string: No description available. ,
int: No description available. ,
long: No description available. ,
real: No description available. ,
boolean: No description available. ,
dateTime: No description available. ,
guid: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dataTypeHint:
{
Description: Column data type logical hint. ,
Enum:
{
uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment ,
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ,
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}... ,
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Column display name. ,
Required: False ,
}
string ,
description:
{
Description: Column description. ,
Required: False ,
}
string ,
isDefaultDisplay:
{
Description: Is displayed by default. ,
Required: False ,
}
boolean ,
isHidden:
{
Description: Is column hidden. ,
Required: False ,
}
boolean ,
}
,
]
,
categories:
{
Description: Table category. ,
Required: False ,
}
[
string ,
]
,
labels:
{
Description: Table labels. ,
Required: False ,
}
[
string ,
]
,
source:
{
Description: Table's creator. ,
Enum:
{
microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means. ,
customer: Tables created by the owner of the Workspace, and only found in this Workspace. ,
}
,
Required: False ,
}
enum ,
tableType:
{
Description: Table's creator. ,
Enum:
{
Microsoft: Standard data collected by Azure Monitor. ,
CustomLog: Custom log table. ,
RestoredLogs: Restored data. ,
SearchResults: Data collected by a search job. ,
}
,
Required: False ,
}
enum ,
tableSubType:
{
Description: The subtype describes what APIs can be used to interact with the table, and what features are available against it. ,
Enum:
{
Any: The default subtype with which built-in tables are created. ,
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created. ,
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules ,
}
,
Required: False ,
}
enum ,
solutions:
{
Description: List of solutions the table is affiliated with ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. ,
Enum:
{
Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done. ,
InProgress: Table schema is stable and without changes, table data is being updated. ,
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates. ,
Deleting: Table state is deleting. ,
}
,
Required: False ,
}
enum ,
retentionInDaysAsDefault:
{
Description: True - Value originates from workspace retention in days, False - Customer specific. ,
Required: False ,
}
boolean ,
totalRetentionInDaysAsDefault:
{
Description: True - Value originates from retention in days, False - Customer specific. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Tables_Delete (new)
Description :  Delete a Log Analytics workspace table.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Tables_Migrate (new)
Description :  Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}/migrate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Tables_CancelSearch (new)
Description :  Cancel a log analytics workspace search results table query run.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}/cancelSearch
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Usages_List (new)
Description :  Gets a list of usage metrics for a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/usages
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of usage metrics for a workspace. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric. ,
Required: False ,
}
{
value:
{
Description: The system name of the metric. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the metric. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: The units used for the metric. ,
Required: False ,
}
string ,
currentValue:
{
Description: The current value of the metric. ,
Format: double ,
Required: False ,
}
number ,
limit:
{
Description: The quota limit for the metric. ,
Format: double ,
Required: False ,
}
number ,
nextResetTime:
{
Description: The time that the metric's value will reset. ,
Format: date-time ,
Required: False ,
}
string ,
quotaPeriod:
{
Description: The quota period that determines the length of time between value resets. ,
Required: False ,
}
string ,
}
,
]
,
}
WorkspacePurge_Purge (new)
Description :  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
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/purge
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
body:
{
Description: Describes the body of a request to purge data in a single table of an Log Analytics Workspace ,
Required: True ,
}
{
table:
{
Description: Table from which to purge data. ,
Required: True ,
}
string ,
filters:
{
Description: The set of columns and filters (queries) to run over them to purge the resulting data. ,
Required: True ,
}
[
{
column:
{
Description: The column of the table over which the given query should run ,
Required: False ,
}
string ,
operator:
{
Description: A query operator to evaluate over the provided column and value(s). Supported operators are ==, =~, in, in~, >, >=, <, <=, between, and have the same behavior as they would in a KQL query. ,
Required: False ,
}
string ,
value:
{
Description: the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= '2017-09-01') or array of values. ,
Required: False ,
}
string ,
key:
{
Description: When filtering over custom dimensions, this key will be used as the name of the custom dimension. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
x-ms-status-location:
{
Description: The location from which to request the operation status. ,
}
string ,
}
,
$schema:
{
Description: Response containing operationId for a specific purge action. ,
}
{
operationId:
{
Description: Id to use when querying for status for a particular purge operation. ,
Required: True ,
}
string ,
}
,
}
WorkspacePurge_GetPurgeStatus (new)
Description :  Gets status of an ongoing purge operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/operations/{purgeId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
purgeId:
{
Description: In a purge status request, this is the Id of the operation the status of which is returned. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the operation represented by the requested Id. ,
Enum:
{
pending: No description available. ,
completed: No description available. ,
}
,
Required: True ,
}
enum ,
}
Workspaces_List (new)
Description :  Gets the workspaces in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Format: date-time ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
unifiedSentinelBillingOnly:
{
Description: An indication if the specify workspace is limited to sentinel's unified billing model only. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
replication:
{
Description: workspace replication properties. ,
Required: False ,
}
{
location:
{
Description: The location of the replication. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true, workspace configuration and data is replicated to the specified location. If replication is been enabled, location must be provided. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The last time when the replication was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time when the replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failover:
{
Description: workspace failover properties. ,
Required: False ,
}
{
state:
{
Description: The failover state of the replication. ,
Enum:
{
Inactive: No description available. ,
Activating: No description available. ,
Active: No description available. ,
Deactivating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedDate:
{
Description: The last time when the failover state was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Workspaces_ListByResourceGroup (new)
Description :  Gets workspaces in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Format: date-time ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
unifiedSentinelBillingOnly:
{
Description: An indication if the specify workspace is limited to sentinel's unified billing model only. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
replication:
{
Description: workspace replication properties. ,
Required: False ,
}
{
location:
{
Description: The location of the replication. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true, workspace configuration and data is replicated to the specified location. If replication is been enabled, location must be provided. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The last time when the replication was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time when the replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failover:
{
Description: workspace failover properties. ,
Required: False ,
}
{
state:
{
Description: The failover state of the replication. ,
Enum:
{
Inactive: No description available. ,
Activating: No description available. ,
Active: No description available. ,
Deactivating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedDate:
{
Description: The last time when the failover state was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Workspaces_CreateOrUpdate (new)
Description :  Create or update a workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to create or update a workspace. ,
Required: True ,
}
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Format: date-time ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
unifiedSentinelBillingOnly:
{
Description: An indication if the specify workspace is limited to sentinel's unified billing model only. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
replication:
{
Description: workspace replication properties. ,
Required: False ,
}
{
location:
{
Description: The location of the replication. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true, workspace configuration and data is replicated to the specified location. If replication is been enabled, location must be provided. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The last time when the replication was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time when the replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failover:
{
Description: workspace failover properties. ,
Required: False ,
}
{
state:
{
Description: The failover state of the replication. ,
Enum:
{
Inactive: No description available. ,
Activating: No description available. ,
Active: No description available. ,
Deactivating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedDate:
{
Description: The last time when the failover state was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the workspace. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Format: date-time ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
unifiedSentinelBillingOnly:
{
Description: An indication if the specify workspace is limited to sentinel's unified billing model only. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
replication:
{
Description: workspace replication properties. ,
Required: False ,
}
{
location:
{
Description: The location of the replication. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true, workspace configuration and data is replicated to the specified location. If replication is been enabled, location must be provided. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The last time when the replication was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time when the replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failover:
{
Description: workspace failover properties. ,
Required: False ,
}
{
state:
{
Description: The failover state of the replication. ,
Enum:
{
Inactive: No description available. ,
Activating: No description available. ,
Active: No description available. ,
Deactivating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedDate:
{
Description: The last time when the failover state was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the workspace. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Format: date-time ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
unifiedSentinelBillingOnly:
{
Description: An indication if the specify workspace is limited to sentinel's unified billing model only. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
replication:
{
Description: workspace replication properties. ,
Required: False ,
}
{
location:
{
Description: The location of the replication. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true, workspace configuration and data is replicated to the specified location. If replication is been enabled, location must be provided. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The last time when the replication was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time when the replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failover:
{
Description: workspace failover properties. ,
Required: False ,
}
{
state:
{
Description: The failover state of the replication. ,
Enum:
{
Inactive: No description available. ,
Activating: No description available. ,
Active: No description available. ,
Deactivating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedDate:
{
Description: The last time when the failover state was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the workspace. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Workspaces_Delete (new)
Description :  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.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
force:
{
Description: Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Workspaces_Get (new)
Description :  Gets a workspace instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Format: date-time ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
unifiedSentinelBillingOnly:
{
Description: An indication if the specify workspace is limited to sentinel's unified billing model only. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
replication:
{
Description: workspace replication properties. ,
Required: False ,
}
{
location:
{
Description: The location of the replication. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true, workspace configuration and data is replicated to the specified location. If replication is been enabled, location must be provided. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The last time when the replication was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time when the replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failover:
{
Description: workspace failover properties. ,
Required: False ,
}
{
state:
{
Description: The failover state of the replication. ,
Enum:
{
Inactive: No description available. ,
Activating: No description available. ,
Active: No description available. ,
Deactivating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedDate:
{
Description: The last time when the failover state was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the workspace. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Workspaces_Update (new)
Description :  Updates a workspace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters required to patch a workspace. ,
Required: True ,
}
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Format: date-time ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
unifiedSentinelBillingOnly:
{
Description: An indication if the specify workspace is limited to sentinel's unified billing model only. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
replication:
{
Description: workspace replication properties. ,
Required: False ,
}
{
location:
{
Description: The location of the replication. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true, workspace configuration and data is replicated to the specified location. If replication is been enabled, location must be provided. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The last time when the replication was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time when the replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failover:
{
Description: workspace failover properties. ,
Required: False ,
}
{
state:
{
Description: The failover state of the replication. ,
Enum:
{
Inactive: No description available. ,
Activating: No description available. ,
Active: No description available. ,
Deactivating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedDate:
{
Description: The last time when the failover state was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. Optional. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Format: date-time ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
unifiedSentinelBillingOnly:
{
Description: An indication if the specify workspace is limited to sentinel's unified billing model only. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
replication:
{
Description: workspace replication properties. ,
Required: False ,
}
{
location:
{
Description: The location of the replication. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true, workspace configuration and data is replicated to the specified location. If replication is been enabled, location must be provided. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The last time when the replication was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time when the replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failover:
{
Description: workspace failover properties. ,
Required: False ,
}
{
state:
{
Description: The failover state of the replication. ,
Enum:
{
Inactive: No description available. ,
Activating: No description available. ,
Active: No description available. ,
Deactivating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedDate:
{
Description: The last time when the failover state was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the workspace. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
DeletedWorkspaces_List (new)
Description :  Gets recently deleted workspaces in a subscription, available for recovery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/deletedWorkspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Format: date-time ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
unifiedSentinelBillingOnly:
{
Description: An indication if the specify workspace is limited to sentinel's unified billing model only. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
replication:
{
Description: workspace replication properties. ,
Required: False ,
}
{
location:
{
Description: The location of the replication. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true, workspace configuration and data is replicated to the specified location. If replication is been enabled, location must be provided. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The last time when the replication was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time when the replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failover:
{
Description: workspace failover properties. ,
Required: False ,
}
{
state:
{
Description: The failover state of the replication. ,
Enum:
{
Inactive: No description available. ,
Activating: No description available. ,
Active: No description available. ,
Deactivating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedDate:
{
Description: The last time when the failover state was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DeletedWorkspaces_ListByResourceGroup (new)
Description :  Gets recently deleted workspaces in a resource group, available for recovery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/deletedWorkspaces
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Workspace properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the workspace. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
ProvisioningAccount: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
customerId:
{
Description: This is a read-only property. Represents the ID associated with the workspace. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
Free: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
PerNode: No description available. ,
PerGB2018: No description available. ,
Standalone: No description available. ,
CapacityReservation: No description available. ,
LACluster: No description available. ,
}
,
Required: True ,
}
enum ,
capacityReservationLevel:
{
Description: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
retentionInDays:
{
Description: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. ,
Format: int32 ,
Required: False ,
}
integer ,
workspaceCapping:
{
Description: The daily volume cap for ingestion. ,
Required: False ,
}
{
dailyQuotaGb:
{
Description: The workspace daily quota for ingestion. ,
Format: double ,
Required: False ,
}
number ,
quotaNextResetTime:
{
Description: The time when the quota will be rest. ,
Required: False ,
}
string ,
dataIngestionStatus:
{
Description: The status of data ingestion for this workspace. ,
Enum:
{
RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement. ,
ForceOn: Ingestion started following service setting change. ,
ForceOff: Ingestion stopped following service setting change. ,
OverQuota: Reached daily cap quota, ingestion stopped. ,
SubscriptionSuspended: Ingestion stopped following suspended subscription. ,
ApproachingQuota: 80% of daily cap quota reached. ,
}
,
Required: False ,
}
enum ,
}
,
createdDate:
{
Description: Workspace creation date. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
Format: date-time ,
Required: False ,
}
string ,
publicNetworkAccessForIngestion:
{
Description: The network access type for accessing Log Analytics ingestion. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccessForQuery:
{
Description: The network access type for accessing Log Analytics query. ,
Enum:
{
Enabled: Enables connectivity to Log Analytics through public DNS. ,
Disabled: Disables public connectivity to Log Analytics through public DNS. ,
}
,
Required: False ,
}
enum ,
forceCmkForQuery:
{
Description: Indicates whether customer managed storage is mandatory for query management. ,
Required: False ,
}
boolean ,
privateLinkScopedResources:
{
Description: List of linked private link scope resources. ,
Required: False ,
}
[
{
resourceId:
{
Description: The full resource Id of the private link scope resource. ,
Required: False ,
}
string ,
scopeId:
{
Description: The private link scope unique Identifier. ,
Required: False ,
}
string ,
}
,
]
,
features:
{
Description: Workspace features. ,
Required: False ,
}
{
enableDataExport:
{
Description: Flag that indicate if data should be exported. ,
Required: False ,
}
boolean ,
immediatePurgeDataOn30Days:
{
Description: Flag that describes if we want to remove the data after 30 days. ,
Required: False ,
}
boolean ,
enableLogAccessUsingOnlyResourcePermissions:
{
Description: Flag that indicate which permission to use - resource or workspace or both. ,
Required: False ,
}
boolean ,
clusterResourceId:
{
Description: Dedicated LA cluster resourceId that is linked to the workspaces. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Disable Non-AAD based Auth. ,
Required: False ,
}
boolean ,
unifiedSentinelBillingOnly:
{
Description: An indication if the specify workspace is limited to sentinel's unified billing model only. ,
Required: False ,
}
boolean ,
}
,
defaultDataCollectionRuleResourceId:
{
Description: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. ,
Required: False ,
}
string ,
replication:
{
Description: workspace replication properties. ,
Required: False ,
}
{
location:
{
Description: The location of the replication. ,
Required: False ,
}
string ,
enabled:
{
Description: Specifies whether the replication is enabled or not. When true, workspace configuration and data is replicated to the specified location. If replication is been enabled, location must be provided. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the replication. ,
Enum:
{
Succeeded: No description available. ,
EnableRequested: No description available. ,
Enabling: No description available. ,
DisableRequested: No description available. ,
Disabling: No description available. ,
RollbackRequested: No description available. ,
RollingBack: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The last time when the replication was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDate:
{
Description: The last time when the replication was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
failover:
{
Description: workspace failover properties. ,
Required: False ,
}
{
state:
{
Description: The failover state of the replication. ,
Enum:
{
Inactive: No description available. ,
Activating: No description available. ,
Active: No description available. ,
Deactivating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedDate:
{
Description: The last time when the failover state was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
etag:
{
Description: The etag of the workspace. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}