Skip to content

Commit 6f4ef87

Browse files
BernieWhiteBernieWhite
authored
Update documentation naming for AI Search (Azure#2761)
* Update documentation naming for AI Search * Fix typo
1 parent a97dc62 commit 6f4ef87

6 files changed

+59
-56
lines changed

‎docs/en/rules/Azure.Search.IndexSLA.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
reviewed: 2023-07-02
2+
reviewed: 2024-03-16
33
severity: Important
44
pillar: Reliability
5-
category: Application design
6-
resource: Cognitive Search
5+
category: RE:06 Data partitioning
6+
resource: AI Search
77
online version: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Search.IndexSLA/
88
---
99

@@ -15,11 +15,11 @@ Use a minimum of 3 replicas to receive an SLA for query and index updates.
1515

1616
## DESCRIPTION
1717

18-
Cognitive Search services support _indexing_ and _querying_.
18+
AI Search (Previously known as Cognitive Search) services support _indexing_ and _querying_.
1919
Indexing is the process of loading content into the service to make it searchable.
2020
Querying is the process where a client searches for content by sending queries to the index.
2121

22-
Cognitive Search supports a configurable number of replicas.
22+
AI Search supports a configurable number of replicas.
2323
Having multiple replicas allows queries and index updates to load balance across multiple replicas.
2424

2525
To receive a Service Level Agreement (SLA) for Search index updates a minimum of 3 replicas is required.
@@ -32,9 +32,9 @@ Consider increasing the number of replicas to a minimum of 3 to receive an SLA o
3232

3333
### Configure with Azure template
3434

35-
To deploy Cognitive Search services that pass this rule:
35+
To deploy AI Search services that pass this rule:
3636

37-
- Set the `replicaCount` to a minimum of 3.
37+
- Set the `properties.replicaCount` property to a minimum of `3`.
3838

3939
For example:
4040

@@ -60,9 +60,9 @@ For example:
6060

6161
### Configure with Bicep
6262

63-
To deploy Cognitive Search services that pass this rule:
63+
To deploy AI Search services that pass this rule:
6464

65-
- Set the `replicaCount` to a minimum of 3.
65+
- Set the `properties.replicaCount` property to a minimum of `3`.
6666

6767
For example:
6868

@@ -86,6 +86,7 @@ resource search 'Microsoft.Search/searchServices@2022-09-01' = {
8686

8787
## LINKS
8888

89-
- [Resiliency checklist for specific Azure services](https://learn.microsoft.com/azure/architecture/checklist/resiliency-per-service#search)
90-
- [SLA for Azure Cognitive Search](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services)
89+
- [RE:06 Data partitioning](https://learn.microsoft.com/azure/well-architected/reliability/partition-data)
90+
- [Resiliency checklist for specific Azure services](https://learn.microsoft.com/azure/architecture/checklist/resiliency-per-service#cognitive-search)
91+
- [SLA for Azure AI Search](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services)
9192
- [Azure deployment reference](https://learn.microsoft.com/azure/templates/microsoft.search/searchservices)

‎docs/en/rules/Azure.Search.ManagedIdentity.md

+14-13
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
reviewed: 2023-07-02
2+
reviewed: 2024-03-16
33
severity: Important
44
pillar: Security
5-
category: Authentication
6-
resource: Cognitive Search
5+
category: SE:05 Identity and access management
6+
resource: AI Search
77
online version: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Search.ManagedIdentity/
88
---
99

@@ -15,28 +15,29 @@ Configure managed identities to access Azure resources.
1515

1616
## DESCRIPTION
1717

18-
Connections to Azure resources is required to use some features including indexing and customer managed-keys.
19-
Cognitive Search can use managed identities to authenticate to Azure resource without storing credentials.
18+
AI Search (Previously known as Cognitive Search) may require connection to other Azure resources.
19+
Connections to Azure resources are required to use some features including indexing and customer managed-keys.
20+
AI Search can use managed identities to authenticate to Azure resources without storing credentials.
2021

2122
Using Azure managed identities have the following benefits:
2223

2324
- You don't need to store or manage credentials.
2425
Azure automatically generates tokens and performs rotation.
25-
- You can use managed identities to authenticate to any Azure service that supports Azure AD authentication.
26+
- You can use managed identities to authenticate to any Azure service that supports Entra ID authentication.
2627
- Managed identities can be used without any additional cost.
2728

2829
## RECOMMENDATION
2930

30-
Consider configuring a managed identity for each Cognitive Search service.
31+
Consider configuring a managed identity for each AI Search service.
3132
Also consider using managed identities to authenticate to related Azure services.
3233

3334
## EXAMPLES
3435

3536
### Configure with Azure template
3637

37-
To deploy Cognitive Search services that pass this rule:
38+
To deploy AI Search services that pass this rule:
3839

39-
- Set the `identity.type` to `SystemAssigned`.
40+
- Set the `identity.type` property to `SystemAssigned`.
4041

4142
For example:
4243

@@ -62,9 +63,9 @@ For example:
6263

6364
### Configure with Bicep
6465

65-
To deploy Cognitive Search services that pass this rule:
66+
To deploy AI Search Search services that pass this rule:
6667

67-
- Set the `identity.type` to `SystemAssigned`.
68+
- Set the `identity.type` property to `SystemAssigned`.
6869

6970
For example:
7071

@@ -88,8 +89,8 @@ resource search 'Microsoft.Search/searchServices@2022-09-01' = {
8889

8990
## LINKS
9091

91-
- [Use identity-based authentication](https://learn.microsoft.com/azure/well-architected/security/design-identity-authentication#use-identity-based-authentication)
92-
- [What are managed identities for Azure resources?](https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview)
92+
- [SE:05 Identity and access management](https://learn.microsoft.com/azure/well-architected/security/identity-access)
93+
- [What are managed identities for Azure resources?](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview)
9394
- [Connect a search service to other Azure resources using a managed identity](https://learn.microsoft.com/azure/search/search-howto-managed-identities-data-sources)
9495
- [Make indexer connections to Azure Storage as a trusted service](https://learn.microsoft.com/azure/search/search-indexer-howto-access-trusted-service-exception)
9596
- [Azure deployment reference](https://learn.microsoft.com/azure/templates/microsoft.search/searchservices)

‎docs/en/rules/Azure.Search.Name.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,40 @@
22
reviewed: 2023-07-02
33
severity: Awareness
44
pillar: Operational Excellence
5-
category: Repeatable infrastructure
6-
resource: Cognitive Search
5+
category: OE:04 Continuous integration
6+
resource: AI Search
77
online version: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Search.Name/
88
---
99

1010
# Use valid Cognitive Search service names
1111

1212
## SYNOPSIS
1313

14-
Azure Cognitive Search service names should meet naming requirements.
14+
AI Search service names should meet naming requirements.
1515

1616
## DESCRIPTION
1717

1818
When naming Azure resources, resource names must meet service requirements.
19-
The requirements for Cognitive Search service names are:
19+
The requirements for AI Search (Previously known as Cognitive Search) service names are:
2020

2121
- Between 2 and 60 characters long.
2222
- Lowercase letters, numbers, and hyphens.
2323
- The first two and last one character must be a letter or a number.
24-
- Cognitive Search service names must be globally unique.
24+
- AI Search service names must be globally unique.
2525

2626
## RECOMMENDATION
2727

28-
Consider using names that meet Azure Cognitive Search service naming requirements.
28+
Consider using names that meet Azure AI Search service naming requirements.
2929
Additionally consider naming resources with a standard naming convention.
3030

3131
## NOTES
3232

33-
This rule does not check if Azure Cognitive Search service names are unique.
33+
This rule does not check if Azure AI Search service names are unique.
3434

3535
## LINKS
3636

37-
- [Repeatable infrastructure](https://learn.microsoft.com/azure/architecture/framework/devops/automation-infrastructure)
38-
- [REST API reference](https://learn.microsoft.com/rest/api/searchmanagement/2022-09-01/services/create-or-update)
37+
- [OE:04 Continuous integration](https://learn.microsoft.com/azure/well-architected/operational-excellence/release-engineering-continuous-integration)
38+
- [REST API reference](https://learn.microsoft.com/rest/api/searchmanagement/services/create-or-update)
3939
- [Define your naming convention](https://learn.microsoft.com/azure/cloud-adoption-framework/ready/azure-best-practices/resource-naming)
4040
- [Recommended abbreviations for Azure resource types](https://learn.microsoft.com/azure/cloud-adoption-framework/ready/azure-best-practices/resource-abbreviations)
4141
- [Azure deployment reference](https://learn.microsoft.com/azure/templates/microsoft.search/searchservices)

‎docs/en/rules/Azure.Search.QuerySLA.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
reviewed: 2023-07-02
2+
reviewed: 2024-03-16
33
severity: Important
44
pillar: Reliability
5-
category: Application design
6-
resource: Cognitive Search
5+
category: RE:06 Data partitioning
6+
resource: AI Search
77
online version: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Search.QuerySLA/
88
---
99

@@ -15,11 +15,11 @@ Use a minimum of 2 replicas to receive an SLA for index queries.
1515

1616
## DESCRIPTION
1717

18-
Cognitive Search services support _indexing_ and _querying_.
18+
AI Search (Previously known as Cognitive Search) services support _indexing_ and _querying_.
1919
Indexing is the process of loading content into the service to make it searchable.
2020
Querying is the process where a client searches for content by sending queries to the index.
2121

22-
Cognitive Search supports a configurable number of replicas.
22+
AI Search supports a configurable number of replicas.
2323
Having multiple replicas allows queries and index updates to load balance across multiple replicas.
2424

2525
To receive a Service Level Agreement (SLA) for Search index queries a minimum of 2 replicas is required.
@@ -32,9 +32,9 @@ Consider increasing the number of replicas to a minimum of 2 to receive an SLA o
3232

3333
### Configure with Azure template
3434

35-
To deploy Cognitive Search services that pass this rule:
35+
To deploy AI Search services that pass this rule:
3636

37-
- Set the `replicaCount` to a minimum of 2.
37+
- Set the `properties.replicaCount` property to a minimum of `2`.
3838

3939
For example:
4040

@@ -60,9 +60,9 @@ For example:
6060

6161
### Configure with Bicep
6262

63-
To deploy Cognitive Search services that pass this rule:
63+
To deploy AI Search services that pass this rule:
6464

65-
- Set the `replicaCount` to a minimum of 2.
65+
- Set the `properties.replicaCount` property to a minimum of `2`.
6666

6767
For example:
6868

@@ -86,6 +86,7 @@ resource search 'Microsoft.Search/searchServices@2022-09-01' = {
8686

8787
## LINKS
8888

89-
- [Resiliency checklist for specific Azure services](https://learn.microsoft.com/azure/architecture/checklist/resiliency-per-service#search)
90-
- [SLA for Azure Cognitive Search](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services)
89+
- [RE:06 Data partitioning](https://learn.microsoft.com/azure/well-architected/reliability/partition-data)
90+
- [Resiliency checklist for specific Azure services](https://learn.microsoft.com/azure/architecture/checklist/resiliency-per-service#cognitive-search)
91+
- [SLA for Azure AI Search](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services)
9192
- [Azure deployment reference](https://learn.microsoft.com/azure/templates/microsoft.search/searchservices)

‎docs/en/rules/Azure.Search.SKU.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
2-
reviewed: 2023-07-02
2+
reviewed: 2024-03-16
33
severity: Critical
44
pillar: Performance Efficiency
5-
category: Application capacity
6-
resource: Cognitive Search
5+
category: PE:02 Capacity planning
6+
resource: AI Search
77
online version: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Search.SKU/
88
---
99

10-
# Cognitive Search minimum SKU
10+
# AI Search minimum SKU
1111

1212
## SYNOPSIS
1313

1414
Use the basic and standard tiers for entry level workloads.
1515

1616
## DESCRIPTION
1717

18-
Cognitive Search services using the Free tier run on resources shared across multiple subscribers.
18+
AI Search (Previously known as Cognitive Search) services using the Free tier run on resources shared across multiple subscribers.
1919
The Free tier is only suggested for limited small scale tests such as running code samples or tutorials.
2020

2121
Running more demanding workloads on the Free tier may experience unpredictable performance or issues.
@@ -24,13 +24,13 @@ To select a tier for your workload, estimate and test your required capacity.
2424

2525
## RECOMMENDATION
2626

27-
Consider deploying Cognitive Search services using basic or higher tier.
27+
Consider deploying AI Search services using basic or higher tier.
2828

2929
## EXAMPLES
3030

3131
### Configure with Azure template
3232

33-
To deploy Cognitive Search services that pass this rule:
33+
To deploy AI Search services that pass this rule:
3434

3535
- Set the `sku.name` to a minimum of `basic`.
3636

@@ -58,7 +58,7 @@ For example:
5858

5959
### Configure with Bicep
6060

61-
To deploy Cognitive Search services that pass this rule:
61+
To deploy AI Search services that pass this rule:
6262

6363
- Set the `sku.name` to a minimum of `basic`.
6464

@@ -84,7 +84,7 @@ resource search 'Microsoft.Search/searchServices@2022-09-01' = {
8484

8585
## LINKS
8686

87-
- [Choose the right resources](https://learn.microsoft.com/azure/architecture/framework/scalability/design-capacity#choose-the-right-resources)
88-
- [SLA for Azure Cognitive Search](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services)
89-
- [Estimate and manage capacity of an Azure Cognitive Search service](https://learn.microsoft.com/azure/search/search-capacity-planning)
87+
- [PE:02 Capacity planning](https://learn.microsoft.com/azure/well-architected/performance-efficiency/capacity-planning)
88+
- [SLA for Azure AI Search](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services)
89+
- [Estimate and manage capacity of a search service](https://learn.microsoft.com/azure/search/search-capacity-planning)
9090
- [Azure deployment reference](https://learn.microsoft.com/azure/templates/microsoft.search/searchservices)

‎src/PSRule.Rules.Azure/rules/Azure.Search.Rule.ps1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Rule 'Azure.Search.ManagedIdentity' -Ref 'AZR-000175' -Type 'Microsoft.Search/se
2727
$Assert.HasFieldValue($TargetObject, 'Identity.Type', 'SystemAssigned');
2828
}
2929

30-
# Synopsis: Use Cognitive Search naming requirements.
30+
# Synopsis: Azure Cognitive Search service names should meet naming requirements.
3131
Rule 'Azure.Search.Name' -Ref 'AZR-000176' -Type 'Microsoft.Search/searchServices' -Tag @{ release = 'GA'; ruleSet = '2021_06'; 'Azure.WAF/pillar' = 'Operational Excellence'; } {
3232
# https://docs.microsoft.com/rest/api/searchmanagement/services/createorupdate
3333

0 commit comments

Comments
 (0)