Skip to content

Repo sync for protected branch #2503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
learn-build-service-prod merged 25 commits into from
Jan 9, 2025
Merged

Repo sync for protected branch #2503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
6e083e4
related content 2
mjosephym Dec 18, 2024
0b6ce0b
edit
mjosephym Dec 18, 2024
4fe9590
edit
mjosephym Dec 19, 2024
97af9c5
edits
mjosephym Dec 19, 2024
2a6d474
edits
mjosephym Dec 19, 2024
e9288fb
edits
mjosephym Dec 22, 2024
d8e5d83
edits
mjosephym Dec 22, 2024
8bb52f9
edits
mjosephym Dec 22, 2024
e5b484e
edits
mjosephym Dec 22, 2024
3eb3118
Merge branch 'main' of https://github.com/MicrosoftDocs/dataexplorer-…
mjosephym Dec 23, 2024
fea4e99
ai
mjosephym Dec 23, 2024
554da3b
related content 3 workgroup, edits
mjosephym Jan 1, 2025
6bb333a
edits
mjosephym Jan 1, 2025
d644805
edits
mjosephym Jan 2, 2025
c0a7007
added note (line 34)
ktalmor Jan 8, 2025
10600f6
Added 2 output headers
ktalmor Jan 9, 2025
0c0d19c
Enhanced the topic
ktalmor Jan 9, 2025
bd2ba27
spell check
ktalmor Jan 9, 2025
da96372
removed note after testing
ktalmor Jan 9, 2025
f020ccd
Update data-explorer/kusto/management/alter-database-streaming-ingest…
mjosephym Jan 9, 2025
fcf2655
Merge pull request #6494 from mjosephym/358232-kql-related-content3
Jan 9, 2025
fbabe4d
Merge pull request #6518 from ktalmor/wi-354388-add-note
Jan 9, 2025
4ba24a7
Merge pull request #6480 from mjosephym/336217-kql-related2
Jan 9, 2025
6900a81
Merge pull request #6522 from MicrosoftDocs/main
Taojunshen Jan 9, 2025
6cf4b1f
Merging changes synced from https://github.com/MicrosoftDocs/dataexpl…
Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 21 additions & 14 deletions data-explorer/kusto/management/alter-callout-policy-command.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: .alter cluster policy callout command
description: Learn how to use the `.alter cluster policy callout` command to change the cluster's callout policy.
ms.reviewer: yonil
ms.topic: reference
ms.date: 08/11/2024
ms.date: 12/18/2024
monikerRange: "azure-data-explorer"
---
# .alter cluster policy callout command
Expand All @@ -24,19 +24,19 @@ You must have [Cluster AllDatabasesAdmin](../access-control/role-based-access-co

## Parameters

| Name | Type | Required | Description |
|----------------------------------|--------|----------|----------------------------------------------------------------------------------------------------------|
| *SerializedArrayOfPolicyObjects* | `string` | :heavy_check_mark: | A serialized array of JSON policy objects. See [callout policy](callout-policy.md) for policy properties. |
| Name | Type | Required | Description |
|--|--|--|--|
| *SerializedArrayOfPolicyObjects* | `string` | :heavy_check_mark: | A serialized array of JSON policy objects. See [callout policy](callout-policy.md) for policy properties. |

## Returns

| Name | Type | Description |
|---------------|--------|-----------------------------------------------------------------------------------------------------------|
| PolicyName | `string` | Name of the policy. For cluster callout policy, this value is **CalloutPolicy**. |
| EntityName | `string` | Name of the entity for which the policy is set. For cluster callout policy, this value is an empty string. |
| Policy | `string` | JSON representation of the policy object. |
| ChildEntities | `string` | Child entities for which this policy is set. For cluster callout policy, this value is an empty string. |
| EntityType | `string` | Type of entity for which this policy is set. For cluster callout policy, this value is an empty string. |
| Name | Type | Description |
|--|--|--|
| PolicyName | `string` | Name of the policy. For cluster callout policy, this value is **CalloutPolicy**. |
| EntityName | `string` | Name of the entity for which the policy is set. For cluster callout policy, this value is an empty string. |
| Policy | `string` | JSON representation of the policy object. |
| ChildEntities | `string` | Child entities for which this policy is set. For cluster callout policy, this value is an empty string. |
| EntityType | `string` | Type of entity for which this policy is set. For cluster callout policy, this value is an empty string. |

## Examples

Expand All @@ -59,6 +59,13 @@ Define permitted callouts for the cluster callout policy.

**Output**

| PolicyName | EntityName | Policy | ChildEntities | EntityType |
|---------------|------------|-------------------------------------------------------------------------------------------------------|---------------|------------|
| CalloutPolicy | | [{"CalloutType":"sql","CalloutUriRegex":"sqlname\\\\.database\\\\.azure\\\\.com/?$","CanCall": true}] | | |
| PolicyName | EntityName | Policy | ChildEntities | EntityType |
|--|--|--|--|--|
| CalloutPolicy | | [{"CalloutType":"sql","CalloutUriRegex":"sqlname\\\\.database\\\\.azure\\\\.com/?$","CanCall": true}] | | |

## Related content

* [Callout policy](callout-policy.md)
* [.show cluster policy callout command](show-cluster-callout-policy-command.md)
* [.alter-merge cluster policy callout command](alter-merge-callout-policy-command.md)
* [.delete cluster policy callout command](delete-callout-policy-command.md)
62 changes: 35 additions & 27 deletions ...xplorer/kusto/management/alter-cluster-policy-request-classification-command.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: .alter cluster policy request_classification command
description: Learn how to use the `.alter cluster policy request_classification` command to alter the request classification policy.
ms.reviewer: yonil
ms.topic: reference
ms.date: 08/11/2024
ms.date: 01/01/2025
---
# .alter cluster policy request_classification command

Expand All @@ -13,7 +13,7 @@ ms.date: 08/11/2024
Alters the cluster's request classification policy.
::: moniker-end
:::moniker range="microsoft-fabric"
Alters the eventhouse's request classification policy.
Alters the Eventhouse's request classification policy.
::: moniker-end

## Permissions
Expand All @@ -33,39 +33,39 @@ You must have [Cluster AllDatabasesAdmin](../access-control/role-based-access-co

## Parameters

| Name | Type | Required | Description |
|------------------------------|--------|----------|--------------------------------------------------------------------------------------------------------------------------------|
| *SerializedPartialPolicy* | `string` | :heavy_check_mark: | Define a serialized JSON policy. For policy properties, see [request classification policy](request-classification-policy.md). |
| *ClassificationFunctionBody* | `string` | :heavy_check_mark: | The body of the function to use for classifying requests. |
| Name | Type | Required | Description |
|--|--|--|--|
| *SerializedPartialPolicy* | `string` | :heavy_check_mark: | Define a serialized JSON policy. For policy properties, see [request classification policy](request-classification-policy.md). |
| *ClassificationFunctionBody* | `string` | :heavy_check_mark: | The body of the function to use for classifying requests. |

## Returns

:::moniker range="azure-data-explorer"
The command returns one row showing the details of the cluster request classification policy.
::: moniker-end
:::moniker range="microsoft-fabric"
The command returns one row showing the details of the eventhouse request classification policy.
The command returns one row showing the details of the Eventhouse request classification policy.
::: moniker-end

Following is the schema of the output returned:

:::moniker range="azure-data-explorer"
| Name | Type | Description |
|---------------|--------|--------------------------------------------------------------------------------------------------------------------------|
| PolicyName | `string` | Name of the policy. For cluster request classification policy this value is **ClusterRequestClassificationPolicy**. |
| EntityName | `string` | Name of the entity for which the policy is set. For cluster request classification policy this value is an empty string. |
| Policy | `string` | JSON representation of the policy object. |
| ChildEntities | `string` | Child entities for which this policy is set. For cluster request classification policy this value is an empty string. |
| EntityType | `string` | Type of entity for which this policy is set. For cluster request classification policy this value is an empty string. |
| Name | Type | Description |
|--|--|--|
| PolicyName | `string` | Name of the policy. For cluster request classification policy, this value is **ClusterRequestClassificationPolicy**. |
| EntityName | `string` | Name of the entity for which the policy is set. For cluster request classification policy, this value is an empty string. |
| Policy | `string` | JSON representation of the policy object. |
| ChildEntities | `string` | Child entities for which this policy is set. For cluster request classification policy, this value is an empty string. |
| EntityType | `string` | Type of entity for which this policy is set. For cluster request classification policy, this value is an empty string. |
::: moniker-end
:::moniker range="microsoft-fabric"
| Name | Type | Description |
|---------------|--------|--------------------------------------------------------------------------------------------------------------------------|
| PolicyName | `string` | Name of the policy. For eventhouse request classification policy this value is **ClusterRequestClassificationPolicy**. |
| EntityName | `string` | Name of the entity for which the policy is set. For eventhouse request classification policy this value is an empty string. |
| Policy | `string` | JSON representation of the policy object. |
| ChildEntities | `string` | Child entities for which this policy is set. For eventhouse request classification policy this value is an empty string. |
| EntityType | `string` | Type of entity for which this policy is set. For eventhouse request classification policy this value is an empty string. |
| Name | Type | Description |
|--|--|--|
| PolicyName | `string` | Name of the policy. For Eventhouse request classification policy, this value is **ClusterRequestClassificationPolicy**. |
| EntityName | `string` | Name of the entity for which the policy is set. For Eventhouse request classification policy, this value is an empty string. |
| Policy | `string` | JSON representation of the policy object. |
| ChildEntities | `string` | Child entities for which this policy is set. For Eventhouse request classification policy, this value is an empty string. |
| EntityType | `string` | Type of entity for which this policy is set. For Eventhouse request classification policy, this value is an empty string. |
::: moniker-end

## Examples
Expand All @@ -87,9 +87,9 @@ Set a policy which, based on the evaluation of multiple conditions, assigns the

**Output**

| PolicyName | EntityName | Policy | ChildEntities | EntityType |
|------------------------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|------------|
| ClusterRequestClassificationPolicy | | {"ClassificationProperties": ["current_database", "request_description", "current_application", "current_principal", "request_type"], "IsEnabled": true, "ClassificationFunction": "case(current_principal_is_member_of('aadgroup=somesecuritygroup@contoso.com'), \"First workload group\", request_properties.current_database == \"MyDatabase\" and request_properties.current_principal has 'aadapp=', \"Second workload group\", request_properties.current_application == \"Kusto.Explorer\" and request_properties.request_type == \"Query\", \"Third workload group\", request_properties.current_application == \"KustoQueryRunner\", \"Fourth workload group\", request_properties.request_description == \"this is a test\", \"Fifth workload group\", hourofday(now()) between (17 .. 23), \"Sixth workload group\", \"default\")"} | | |
| PolicyName | EntityName | Policy | ChildEntities | EntityType |
|--|--|--|--|--|
| ClusterRequestClassificationPolicy | | {"ClassificationProperties": ["current_database", "request_description", "current_application", "current_principal", "request_type"], "IsEnabled": true, "ClassificationFunction": "case(current_principal_is_member_of('aadgroup=somesecuritygroup@contoso.com'), \"First workload group\", request_properties.current_database == \"MyDatabase\" and request_properties.current_principal has 'aadapp=', \"Second workload group\", request_properties.current_application == \"Kusto.Explorer\" and request_properties.request_type == \"Query\", \"Third workload group\", request_properties.current_application == \"KustoQueryRunner\", \"Fourth workload group\", request_properties.request_description == \"this is a test\", \"Fifth workload group\", hourofday(now()) between (17 .. 23), \"Sixth workload group\", \"default\")"} | | |

### Set a policy with a single workload group

Expand All @@ -104,6 +104,14 @@ Set a policy which, based on the evaluation of a composed condition, assigns the

**Output**

| PolicyName | EntityName | Policy | ChildEntities | EntityType |
|------------------------------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|------------|
| ClusterRequestClassificationPolicy | | {"ClassificationProperties": ["current_application", "request_type" ],"IsEnabled": true, "ClassificationFunction": "iff(request_properties.current_application == \"Kusto.Explorer\" and request_properties.request_type == \"Query\",\"Ad-hoc queries\",\"default\")"} | | |
| PolicyName | EntityName | Policy | ChildEntities | EntityType |
|--|--|--|--|--|
| ClusterRequestClassificationPolicy | | {"ClassificationProperties": ["current_application", "request_type" ],"IsEnabled": true, "ClassificationFunction": "iff(request_properties.current_application == \"Kusto.Explorer\" and request_properties.request_type == \"Query\",\"Ad-hoc queries\",\"default\")"} | | |

## Related content

* [Workload groups](workload-groups.md)
* [Request classification policy](request-classification-policy.md)
* [`.alter-merge cluster request classification policy`](alter-merge-cluster-policy-request-classification-command.md)
* [`.delete cluster request classification policy`](delete-cluster-policy-request-classification-command.md)
* [`.show cluster request classification policy`](show-cluster-policy-request-classification-command.md)
11 changes: 10 additions & 1 deletion data-explorer/kusto/management/alter-database-sharding-policy-command.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: .alter database policy sharding command
description: Learn how to use the `.alter database policy sharding` command to change the database's sharding policy.
ms.reviewer: yonil
ms.topic: reference
ms.date: 08/11/2024
ms.date: 12/22/2024
monikerRange: "azure-data-explorer"
---
# .alter database policy sharding command
Expand Down Expand Up @@ -49,3 +49,12 @@ The following command returns the updated extents sharding policy for the databa
}
```
````

## Related content

* [Data sharding policy](sharding-policy.md)
* [.alter table policy sharding command](alter-table-sharding-policy-command.md)
* [.show database policy sharding command](show-database-sharding-policy-command.md)
* [.alter-merge database policy sharding command](alter-merge-database-sharding-policy-command.md)
* [.delete database policy sharding command](delete-database-sharding-policy-command.md)
* [Extents (data shards)](extents-overview.md)
13 changes: 11 additions & 2 deletions ...-explorer/kusto/management/alter-database-streaming-ingestion-policy-command.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: .alter database policy streamingingestion command
description: Learn how to use the `.alter database policy streamingingestion` command to change the database streaming ingestion policy.
ms.reviewer: yonil
ms.topic: reference
ms.date: 08/11/2024
ms.date: 12/22/2024
monikerRange: "azure-data-explorer"
---
# .alter database policy streamingingestion command
Expand All @@ -14,7 +14,7 @@ Changes the database streaming ingestion policy. The [streaming policy](../manag

Streaming ingestion is best suited for low latency scenarios where the ingestion time is under 10 seconds for varying data volume. It can optimize processing for multiple tables across one or more databases, especially when the tables receive only a few records per second but the ingestion volume is thousands of records per second.

However, when the amount of data grows beyond 4 Gb per hour per table, it's recommended to switch to classic bulk ingestion instead of streaming ingestion.
However, when the amount of data grows beyond 4 GB per hour per table, we recommend switching to classic bulk ingestion instead of streaming ingestion.

To learn how to implement streaming ingestion, see [streaming ingestion](/azure/data-explorer/ingest-data-streaming).
Streaming ingestion must be enabled at the cluster level before it can be used at the database level.
Expand Down Expand Up @@ -48,3 +48,12 @@ The following command enables streaming ingestion and determines the suggestion
.alter database MyDatabase policy streamingingestion
'{"IsEnabled": true, "HintAllocatedRate": 2.1}'
```

## Related content

* [Streaming ingestion policy](streaming-ingestion-policy.md)
* [.alter table policy streamingingestion command](alter-table-streaming-ingestion-policy-command.md)
* [.show database policy streamingingestion command](show-database-streaming-ingestion-policy-command.md)
* [.alter-merge database policy streamingingestion command](alter-merge-database-streaming-ingestion-policy-command.md)
* [.delete database policy streamingingestion command](delete-database-streaming-ingestion-policy-command.md)
* [Streaming ingestion and schema changes](data-ingestion/streaming-ingestion-schema-changes.md)
Loading
Loading