Microsoft.OperationalInsights (stable:2020-10-01)

2025/10/23 • 18 new, 18 deleted methods

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: 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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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: 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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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: 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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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: 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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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: 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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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: 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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
location: 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_ListByWorkspace (new)
Description :  Gets all tables, both current and available tables that may not be enabled, 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 properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The data table data retention in days, between 7 and 730. Setting this property to null will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
isTroubleshootingAllowed:
{
Description: Specifies if IsTroubleshootingEnabled property can be set for this table. ,
Required: False ,
}
boolean ,
isTroubleshootEnabled:
{
Description: Enable or disable troubleshoot for this table. ,
Required: False ,
}
boolean ,
lastTroubleshootDate:
{
Description: Last time when troubleshooting was set for this table. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Updates a Log Analytics workspace table properties.
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 properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The data table data retention in days, between 7 and 730. Setting this property to null will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
isTroubleshootingAllowed:
{
Description: Specifies if IsTroubleshootingEnabled property can be set for this table. ,
Required: False ,
}
boolean ,
isTroubleshootEnabled:
{
Description: Enable or disable troubleshoot for this table. ,
Required: False ,
}
boolean ,
lastTroubleshootDate:
{
Description: Last time when troubleshooting was set for this table. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Table properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The data table data retention in days, between 7 and 730. Setting this property to null will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
isTroubleshootingAllowed:
{
Description: Specifies if IsTroubleshootingEnabled property can be set for this table. ,
Required: False ,
}
boolean ,
isTroubleshootEnabled:
{
Description: Enable or disable troubleshoot for this table. ,
Required: False ,
}
boolean ,
lastTroubleshootDate:
{
Description: Last time when troubleshooting was set for this table. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The data table data retention in days, between 7 and 730. Setting this property to null will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
isTroubleshootingAllowed:
{
Description: Specifies if IsTroubleshootingEnabled property can be set for this table. ,
Required: False ,
}
boolean ,
isTroubleshootEnabled:
{
Description: Enable or disable troubleshoot for this table. ,
Required: False ,
}
boolean ,
lastTroubleshootDate:
{
Description: Last time when troubleshooting was set for this table. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_ListByResourceGroup (removed)
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: 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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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: 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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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: 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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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: 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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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: 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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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: 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 ,
}
,
sku:
{
Description: The sku properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity value ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the SKU. ,
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. ,
Required: False ,
}
string ,
createdDate:
{
Description: The cluster creation time ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Description: The list of Log Analytics workspaces associated with the cluster ,
Required: False ,
}
[
{
workspaceId:
{
Description: The id of the assigned workspace. ,
Required: False ,
}
string ,
workspaceName:
{
Description: The name id the assigned workspace. ,
Required: False ,
}
string ,
resourceId:
{
Description: The ResourceId id the assigned workspace. ,
Required: False ,
}
string ,
associateDate:
{
Description: The time of workspace association. ,
Required: False ,
}
string ,
}
,
]
,
capacityReservationProperties:
{
Description: Additional properties for capacity reservation ,
Required: False ,
}
{
lastSkuUpdate:
{
Description: The last time Sku was updated. ,
Required: False ,
}
string ,
minCapacity:
{
Description: Minimum CapacityReservation value in GB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
location: 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_ListByWorkspace (removed)
Description :  Gets all tables, both current and available tables that may not be enabled, 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 properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The data table data retention in days, between 7 and 730. Setting this property to null will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
isTroubleshootingAllowed:
{
Description: Specifies if IsTroubleshootingEnabled property can be set for this table. ,
Required: False ,
}
boolean ,
isTroubleshootEnabled:
{
Description: Enable or disable troubleshoot for this table. ,
Required: False ,
}
boolean ,
lastTroubleshootDate:
{
Description: Last time when troubleshooting was set for this table. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Updates a Log Analytics workspace table properties.
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 properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The data table data retention in days, between 7 and 730. Setting this property to null will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
isTroubleshootingAllowed:
{
Description: Specifies if IsTroubleshootingEnabled property can be set for this table. ,
Required: False ,
}
boolean ,
isTroubleshootEnabled:
{
Description: Enable or disable troubleshoot for this table. ,
Required: False ,
}
boolean ,
lastTroubleshootDate:
{
Description: Last time when troubleshooting was set for this table. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Table properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The data table data retention in days, between 7 and 730. Setting this property to null will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
isTroubleshootingAllowed:
{
Description: Specifies if IsTroubleshootingEnabled property can be set for this table. ,
Required: False ,
}
boolean ,
isTroubleshootEnabled:
{
Description: Enable or disable troubleshoot for this table. ,
Required: False ,
}
boolean ,
lastTroubleshootDate:
{
Description: Last time when troubleshooting was set for this table. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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 properties. ,
Required: False ,
}
{
retentionInDays:
{
Description: The data table data retention in days, between 7 and 730. Setting this property to null will default to the workspace retention. ,
Format: int32 ,
Required: False ,
}
integer ,
isTroubleshootingAllowed:
{
Description: Specifies if IsTroubleshootingEnabled property can be set for this table. ,
Required: False ,
}
boolean ,
isTroubleshootEnabled:
{
Description: Enable or disable troubleshoot for this table. ,
Required: False ,
}
boolean ,
lastTroubleshootDate:
{
Description: Last time when troubleshooting was set for this table. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_List (removed)
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
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 for this workspace, when CapacityReservation sku is selected. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSkuUpdate:
{
Description: The last time when the sku was updated. ,
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. ,
Required: False ,
}
string ,
modifiedDate:
{
Description: Workspace modification date. ,
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 ,
}
,
}
,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}