Update documentation naming for AI Search (#2761)

* Update documentation naming for AI Search

* Fix typo
This commit is contained in:
Bernie White 2024-03-16 04:03:16 +10:00 коммит произвёл GitHub
Родитель a97dc62c5f
Коммит 6f4ef87a59
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
6 изменённых файлов: 59 добавлений и 56 удалений

Просмотреть файл

@ -1,9 +1,9 @@
---
reviewed: 2023-07-02
reviewed: 2024-03-16
severity: Important
pillar: Reliability
category: Application design
resource: Cognitive Search
category: RE:06 Data partitioning
resource: AI Search
online version: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Search.IndexSLA/
---
@ -15,11 +15,11 @@ Use a minimum of 3 replicas to receive an SLA for query and index updates.
## DESCRIPTION
Cognitive Search services support _indexing_ and _querying_.
AI Search (Previously known as Cognitive Search) services support _indexing_ and _querying_.
Indexing is the process of loading content into the service to make it searchable.
Querying is the process where a client searches for content by sending queries to the index.
Cognitive Search supports a configurable number of replicas.
AI Search supports a configurable number of replicas.
Having multiple replicas allows queries and index updates to load balance across multiple replicas.
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
### Configure with Azure template
To deploy Cognitive Search services that pass this rule:
To deploy AI Search services that pass this rule:
- Set the `replicaCount` to a minimum of 3.
- Set the `properties.replicaCount` property to a minimum of `3`.
For example:
@ -60,9 +60,9 @@ For example:
### Configure with Bicep
To deploy Cognitive Search services that pass this rule:
To deploy AI Search services that pass this rule:
- Set the `replicaCount` to a minimum of 3.
- Set the `properties.replicaCount` property to a minimum of `3`.
For example:
@ -86,6 +86,7 @@ resource search 'Microsoft.Search/searchServices@2022-09-01' = {
## LINKS
- [Resiliency checklist for specific Azure services](https://learn.microsoft.com/azure/architecture/checklist/resiliency-per-service#search)
- [SLA for Azure Cognitive Search](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services)
- [RE:06 Data partitioning](https://learn.microsoft.com/azure/well-architected/reliability/partition-data)
- [Resiliency checklist for specific Azure services](https://learn.microsoft.com/azure/architecture/checklist/resiliency-per-service#cognitive-search)
- [SLA for Azure AI Search](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services)
- [Azure deployment reference](https://learn.microsoft.com/azure/templates/microsoft.search/searchservices)

Просмотреть файл

@ -1,9 +1,9 @@
---
reviewed: 2023-07-02
reviewed: 2024-03-16
severity: Important
pillar: Security
category: Authentication
resource: Cognitive Search
category: SE:05 Identity and access management
resource: AI Search
online version: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Search.ManagedIdentity/
---
@ -15,28 +15,29 @@ Configure managed identities to access Azure resources.
## DESCRIPTION
Connections to Azure resources is required to use some features including indexing and customer managed-keys.
Cognitive Search can use managed identities to authenticate to Azure resource without storing credentials.
AI Search (Previously known as Cognitive Search) may require connection to other Azure resources.
Connections to Azure resources are required to use some features including indexing and customer managed-keys.
AI Search can use managed identities to authenticate to Azure resources without storing credentials.
Using Azure managed identities have the following benefits:
- You don't need to store or manage credentials.
Azure automatically generates tokens and performs rotation.
- You can use managed identities to authenticate to any Azure service that supports Azure AD authentication.
- You can use managed identities to authenticate to any Azure service that supports Entra ID authentication.
- Managed identities can be used without any additional cost.
## RECOMMENDATION
Consider configuring a managed identity for each Cognitive Search service.
Consider configuring a managed identity for each AI Search service.
Also consider using managed identities to authenticate to related Azure services.
## EXAMPLES
### Configure with Azure template
To deploy Cognitive Search services that pass this rule:
To deploy AI Search services that pass this rule:
- Set the `identity.type` to `SystemAssigned`.
- Set the `identity.type` property to `SystemAssigned`.
For example:
@ -62,9 +63,9 @@ For example:
### Configure with Bicep
To deploy Cognitive Search services that pass this rule:
To deploy AI Search Search services that pass this rule:
- Set the `identity.type` to `SystemAssigned`.
- Set the `identity.type` property to `SystemAssigned`.
For example:
@ -88,8 +89,8 @@ resource search 'Microsoft.Search/searchServices@2022-09-01' = {
## LINKS
- [Use identity-based authentication](https://learn.microsoft.com/azure/well-architected/security/design-identity-authentication#use-identity-based-authentication)
- [What are managed identities for Azure resources?](https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview)
- [SE:05 Identity and access management](https://learn.microsoft.com/azure/well-architected/security/identity-access)
- [What are managed identities for Azure resources?](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview)
- [Connect a search service to other Azure resources using a managed identity](https://learn.microsoft.com/azure/search/search-howto-managed-identities-data-sources)
- [Make indexer connections to Azure Storage as a trusted service](https://learn.microsoft.com/azure/search/search-indexer-howto-access-trusted-service-exception)
- [Azure deployment reference](https://learn.microsoft.com/azure/templates/microsoft.search/searchservices)

Просмотреть файл

@ -2,8 +2,8 @@
reviewed: 2023-07-02
severity: Awareness
pillar: Operational Excellence
category: Repeatable infrastructure
resource: Cognitive Search
category: OE:04 Continuous integration
resource: AI Search
online version: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Search.Name/
---
@ -11,31 +11,31 @@ online version: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Search
## SYNOPSIS
Azure Cognitive Search service names should meet naming requirements.
AI Search service names should meet naming requirements.
## DESCRIPTION
When naming Azure resources, resource names must meet service requirements.
The requirements for Cognitive Search service names are:
The requirements for AI Search (Previously known as Cognitive Search) service names are:
- Between 2 and 60 characters long.
- Lowercase letters, numbers, and hyphens.
- The first two and last one character must be a letter or a number.
- Cognitive Search service names must be globally unique.
- AI Search service names must be globally unique.
## RECOMMENDATION
Consider using names that meet Azure Cognitive Search service naming requirements.
Consider using names that meet Azure AI Search service naming requirements.
Additionally consider naming resources with a standard naming convention.
## NOTES
This rule does not check if Azure Cognitive Search service names are unique.
This rule does not check if Azure AI Search service names are unique.
## LINKS
- [Repeatable infrastructure](https://learn.microsoft.com/azure/architecture/framework/devops/automation-infrastructure)
- [REST API reference](https://learn.microsoft.com/rest/api/searchmanagement/2022-09-01/services/create-or-update)
- [OE:04 Continuous integration](https://learn.microsoft.com/azure/well-architected/operational-excellence/release-engineering-continuous-integration)
- [REST API reference](https://learn.microsoft.com/rest/api/searchmanagement/services/create-or-update)
- [Define your naming convention](https://learn.microsoft.com/azure/cloud-adoption-framework/ready/azure-best-practices/resource-naming)
- [Recommended abbreviations for Azure resource types](https://learn.microsoft.com/azure/cloud-adoption-framework/ready/azure-best-practices/resource-abbreviations)
- [Azure deployment reference](https://learn.microsoft.com/azure/templates/microsoft.search/searchservices)

Просмотреть файл

@ -1,9 +1,9 @@
---
reviewed: 2023-07-02
reviewed: 2024-03-16
severity: Important
pillar: Reliability
category: Application design
resource: Cognitive Search
category: RE:06 Data partitioning
resource: AI Search
online version: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Search.QuerySLA/
---
@ -15,11 +15,11 @@ Use a minimum of 2 replicas to receive an SLA for index queries.
## DESCRIPTION
Cognitive Search services support _indexing_ and _querying_.
AI Search (Previously known as Cognitive Search) services support _indexing_ and _querying_.
Indexing is the process of loading content into the service to make it searchable.
Querying is the process where a client searches for content by sending queries to the index.
Cognitive Search supports a configurable number of replicas.
AI Search supports a configurable number of replicas.
Having multiple replicas allows queries and index updates to load balance across multiple replicas.
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
### Configure with Azure template
To deploy Cognitive Search services that pass this rule:
To deploy AI Search services that pass this rule:
- Set the `replicaCount` to a minimum of 2.
- Set the `properties.replicaCount` property to a minimum of `2`.
For example:
@ -60,9 +60,9 @@ For example:
### Configure with Bicep
To deploy Cognitive Search services that pass this rule:
To deploy AI Search services that pass this rule:
- Set the `replicaCount` to a minimum of 2.
- Set the `properties.replicaCount` property to a minimum of `2`.
For example:
@ -86,6 +86,7 @@ resource search 'Microsoft.Search/searchServices@2022-09-01' = {
## LINKS
- [Resiliency checklist for specific Azure services](https://learn.microsoft.com/azure/architecture/checklist/resiliency-per-service#search)
- [SLA for Azure Cognitive Search](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services)
- [RE:06 Data partitioning](https://learn.microsoft.com/azure/well-architected/reliability/partition-data)
- [Resiliency checklist for specific Azure services](https://learn.microsoft.com/azure/architecture/checklist/resiliency-per-service#cognitive-search)
- [SLA for Azure AI Search](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services)
- [Azure deployment reference](https://learn.microsoft.com/azure/templates/microsoft.search/searchservices)

Просмотреть файл

@ -1,13 +1,13 @@
---
reviewed: 2023-07-02
reviewed: 2024-03-16
severity: Critical
pillar: Performance Efficiency
category: Application capacity
resource: Cognitive Search
category: PE:02 Capacity planning
resource: AI Search
online version: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Search.SKU/
---
# Cognitive Search minimum SKU
# AI Search minimum SKU
## SYNOPSIS
@ -15,7 +15,7 @@ Use the basic and standard tiers for entry level workloads.
## DESCRIPTION
Cognitive Search services using the Free tier run on resources shared across multiple subscribers.
AI Search (Previously known as Cognitive Search) services using the Free tier run on resources shared across multiple subscribers.
The Free tier is only suggested for limited small scale tests such as running code samples or tutorials.
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.
## RECOMMENDATION
Consider deploying Cognitive Search services using basic or higher tier.
Consider deploying AI Search services using basic or higher tier.
## EXAMPLES
### Configure with Azure template
To deploy Cognitive Search services that pass this rule:
To deploy AI Search services that pass this rule:
- Set the `sku.name` to a minimum of `basic`.
@ -58,7 +58,7 @@ For example:
### Configure with Bicep
To deploy Cognitive Search services that pass this rule:
To deploy AI Search services that pass this rule:
- Set the `sku.name` to a minimum of `basic`.
@ -84,7 +84,7 @@ resource search 'Microsoft.Search/searchServices@2022-09-01' = {
## LINKS
- [Choose the right resources](https://learn.microsoft.com/azure/architecture/framework/scalability/design-capacity#choose-the-right-resources)
- [SLA for Azure Cognitive Search](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services)
- [Estimate and manage capacity of an Azure Cognitive Search service](https://learn.microsoft.com/azure/search/search-capacity-planning)
- [PE:02 Capacity planning](https://learn.microsoft.com/azure/well-architected/performance-efficiency/capacity-planning)
- [SLA for Azure AI Search](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services)
- [Estimate and manage capacity of a search service](https://learn.microsoft.com/azure/search/search-capacity-planning)
- [Azure deployment reference](https://learn.microsoft.com/azure/templates/microsoft.search/searchservices)

Просмотреть файл

@ -27,7 +27,7 @@ Rule 'Azure.Search.ManagedIdentity' -Ref 'AZR-000175' -Type 'Microsoft.Search/se
$Assert.HasFieldValue($TargetObject, 'Identity.Type', 'SystemAssigned');
}
# Synopsis: Use Cognitive Search naming requirements.
# Synopsis: Azure Cognitive Search service names should meet naming requirements.
Rule 'Azure.Search.Name' -Ref 'AZR-000176' -Type 'Microsoft.Search/searchServices' -Tag @{ release = 'GA'; ruleSet = '2021_06'; 'Azure.WAF/pillar' = 'Operational Excellence'; } {
# https://docs.microsoft.com/rest/api/searchmanagement/services/createorupdate