Merge pull request #453 from HeidiSteen/heidist-fresh

[azure search] SFI connection string fixes

Author: prmerger-automator[bot]

articles/search/knowledge-store-create-portal.md

@@ -61,7 +61,7 @@ Because the data is multiple rows in one CSV file, set the *parsing mode* to get
 
    A connection string can be full access, having the following format: `DefaultEndpointsProtocol=https;AccountName=<YOUR-ACCOUNT-NAME>;AccountKey=<YOUR-ACCOUNT-KEY>;EndpointSuffix=core.windows.net`
 
-   Or, a connection string can reference a managed identity, assuming it's [configured and assigned a role](search-howto-managed-identities-data-sources.md) in Azure Storage: `ResourceId=/subscriptions/{YOUR-SUBSCRIPTION-ID}/resourceGroups/{YOUR-RESOURCE-GROUP-NAME}/providers/Microsoft.Storage/storageAccounts/{YOUR-ACCOUNT-NAME};`
+   Or, a connection string can reference a managed identity, assuming it's [configured and assigned a role](search-howto-managed-identities-data-sources.md) in Azure Storage: `ResourceId=/subscriptions/<YOUR-SUBSCRIPTION-ID>/resourceGroups/<YOUR-RESOURCE-GROUP-NAME>/providers/Microsoft.Storage/storageAccounts/<YOUR-ACCOUNT-NAME>;`
 
 1. In **Containers**, enter the name of the blob container holding the data ("hotel-reviews").
 

articles/search/search-indexer-tutorial.md

@@ -8,7 +8,7 @@ author: HeidiSteen
 ms.author: heidist
 ms.service: cognitive-search
 ms.topic: tutorial
-ms.date: 01/18/2024
+ms.date: 09/23/2024
 ms.custom:
   - devx-track-csharp
   - devx-track-dotnet
@@ -87,7 +87,7 @@ If you have an existing Azure SQL Database resource, you can add the hotels tabl
 1. Copy the ADO.NET connection string for the database. Under **Settings** > **Connection Strings**, copy the ADO.NET connection string, similar to the example below.
 
     ```sql
-    Server=tcp:{your_dbname}.database.windows.net,1433;Initial Catalog=hotels-db;Persist Security Info=False;User ID={your_username};Password={your_password};MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;
+    Server=tcp:<YOUR-DATABASE-NAME>.database.windows.net,1433;Initial Catalog=hotels-db;Persist Security Info=False;User ID=<YOUR-USER-NAME>;Password=<YOUR-PASSWORD>;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;
     ```
 
 You'll need this connection string in the next exercise, setting up your environment.
@@ -114,7 +114,7 @@ API calls require the service URL and an access key. A search service is created
 
 1. For `SearchServiceEndPoint`, if the full URL on the service overview page is "https://my-demo-service.search.windows.net", then the value to provide is the entire URL.
 
-1. For `AzureSqlConnectionString`, the string format is similar to this: `"Server=tcp:{your_dbname}.database.windows.net,1433;Initial Catalog=hotels-db;Persist Security Info=False;User ID={your_username};Password={your_password};MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;"`
+1. For `AzureSqlConnectionString`, the string format is similar to this: `"Server=tcp:<your-database-name>.database.windows.net,1433;Initial Catalog=hotels-db;Persist Security Info=False;User ID=<your-user-name>;Password=<your-password>;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;"`
 
     ```json
     {

articles/search/search-security-manage-encryption-keys.md

@@ -8,7 +8,7 @@ author: HeidiSteen
 ms.author: heidist
 ms.service: cognitive-search
 ms.topic: how-to
-ms.date: 08/05/2024
+ms.date: 09/23/2024
 ms.custom:
   - references_regions
   - ignite-2023
@@ -207,19 +207,19 @@ Conditions that prevent you from adopting this approach include:
     Content-Type: application/json
 
     {
-      "location": "[region]",
+      "location": "<your-region>",
       "sku": {
-        "name": "[sku]"
+        "name": "<your-sku>"
       },
       "properties": {
-        "replicaCount": [replica count],
-        "partitionCount": [partition count],
+        "replicaCount": <your-replica-count>,
+        "partitionCount": <your-partition count>,
         "hostingMode": "default"
       },
       "identity": {
         "type": "UserAssigned",
         "userAssignedIdentities": {
-          "/subscriptions/[subscription ID]/resourcegroups/[resource group name]/providers/Microsoft.ManagedIdentity/userAssignedIdentities/[managed identity name]": {}
+          "/subscriptions/<your-subscription-ID>/resourcegroups/<your-resource-group-name>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<your-managed-identity-name>": {}
         }
       }
     } 
@@ -230,12 +230,12 @@ Conditions that prevent you from adopting this approach include:
     ```json
     {
       "encryptionKey": {
-        "keyVaultUri": "https://[key vault name].vault.azure.net",
-        "keyVaultKeyName": "[key vault key name]",
-        "keyVaultKeyVersion": "[key vault key version]",
+        "keyVaultUri": "<YOUR-KEY-VAULT-URI>",
+        "keyVaultKeyName": "<YOUR-ENCRYPTION-KEY-NAME>",
+        "keyVaultKeyVersion": "<YOUR-ENCRYPTION-KEY-VERSION>",
         "identity" : { 
             "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
-            "userAssignedIdentity" : "/subscriptions/[subscription ID]/resourceGroups/[resource group name]/providers/Microsoft.ManagedIdentity/userAssignedIdentities/[managed identity name]"
+            "userAssignedIdentity" : "/subscriptions/<your-subscription-ID>/resourceGroups/<your-resource-group-name>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<your-managed-identity-name>"
         }
       }
     }
@@ -312,9 +312,9 @@ Encryption keys are added when you create an object. To add a customer-managed k
     ```json
     {
       "encryptionKey": {
-        "keyVaultUri": "https://demokeyvault.vault.azure.net",
-        "keyVaultKeyName": "myEncryptionKey",
-        "keyVaultKeyVersion": "eaab6a663d59439ebb95ce2fe7d5f660"
+        "keyVaultUri": "<YOUR-KEY-VAULT-URI>",
+        "keyVaultKeyName": "<YOUR-ENCRYPTION-KEY-NAME>",
+        "keyVaultKeyVersion": "<YOUR-ENCRYPTION-KEY-VERSION>"
       }
     }
     ```
@@ -324,12 +324,12 @@ Encryption keys are added when you create an object. To add a customer-managed k
     ```json
     {
       "encryptionKey": {
-        "keyVaultUri": "https://demokeyvault.vault.azure.net",
-        "keyVaultKeyName": "myEncryptionKey",
-        "keyVaultKeyVersion": "eaab6a663d59439ebb95ce2fe7d5f660",
+        "keyVaultUri": "<YOUR-KEY-VAULT-URI>",
+        "keyVaultKeyName": "<YOUR-ENCRYPTION-KEY-NAME>",
+        "keyVaultKeyVersion": "<YOUR-ENCRYPTION-KEY-VERSION>",
         "accessCredentials": {
-          "applicationId": "00000000-0000-0000-0000-000000000000",
-          "applicationSecret": "myApplicationSecret"
+          "applicationId": "<YOUR-APPLICATION-ID>",
+          "applicationSecret": "<YOUR-APPLICATION-SECRET>"
         }
       }
     }
@@ -363,7 +363,7 @@ In this section, you set the policy that defines a CMK standard for your search
 1. Call the [Services - Update API](/rest/api/searchmanagement/services/update) to enable CMK policy enforcement at the service level.
 
 ```http
-PATCH https://management.azure.com/subscriptions/[subscriptionId]/resourceGroups/[resourceGroupName]/providers/Microsoft.Search/searchServices/[serviceName]?api-version=2023-11-01
+PATCH https://management.azure.com/subscriptions/<your-subscription-Id>/resourceGroups/<your-resource-group-name>/providers/Microsoft.Search/searchServices/<your-search-service-name>?api-version=2023-11-01
 
 {
     "properties": {
@@ -399,12 +399,12 @@ The details of creating a new index via the REST API could be found at [Create I
   {"name": "Location", "type": "Edm.GeographyPoint", "filterable": true, "sortable": true}
  ],
   "encryptionKey": {
-    "keyVaultUri": "https://demokeyvault.vault.azure.net",
-    "keyVaultKeyName": "myEncryptionKey",
-    "keyVaultKeyVersion": "eaab6a663d59439ebb95ce2fe7d5f660",
+    "keyVaultUri": "<YOUR-KEY-VAULT-URI>",
+    "keyVaultKeyName": "<YOUR-ENCRYPTION-KEY-NAME>",
+    "keyVaultKeyVersion": "<YOUR-ENCRYPTION-KEY-VERSION>",
     "accessCredentials": {
-      "applicationId": "00000000-0000-0000-0000-000000000000",
-      "applicationSecret": "myApplicationSecret"
+      "applicationId": "<YOUR-APPLICATION-ID>",
+      "applicationSecret": "<YOUR-APPLICATION-SECRET>"
     }
   }
 }
@@ -423,12 +423,12 @@ Create an encrypted synonym map using the [Create Synonym Map Azure AI Search RE
   "synonyms" : "United States, United States of America, USA\n
   Washington, Wash. => WA",
   "encryptionKey": {
-    "keyVaultUri": "https://demokeyvault.vault.azure.net",
-    "keyVaultKeyName": "myEncryptionKey",
-    "keyVaultKeyVersion": "eaab6a663d59439ebb95ce2fe7d5f660",
+    "keyVaultUri": "<YOUR-KEY-VAULT-URI>",
+    "keyVaultKeyName": "<YOUR-ENCRYPTION-KEY-NAME>",
+    "keyVaultKeyVersion": "<YOUR-ENCRYPTION-KEY-VERSION>",
     "accessCredentials": {
-      "applicationId": "00000000-0000-0000-0000-000000000000",
-      "applicationSecret": "myApplicationSecret"
+      "applicationId": "<YOUR-APPLICATION-ID>",
+      "applicationSecret": "<YOUR-APPLICATION-SECRET>"
     }
   }
 }
@@ -449,12 +449,12 @@ Create an encrypted data source using the [Create Data Source (REST API)](/rest/
   },
   "container" : { "name" : "containername" },
   "encryptionKey": {
-    "keyVaultUri": "https://demokeyvault.vault.azure.net",
-    "keyVaultKeyName": "myEncryptionKey",
-    "keyVaultKeyVersion": "eaab6a663d59439ebb95ce2fe7d5f660",
+    "keyVaultUri": "<YOUR-KEY-VAULT-URI>",
+    "keyVaultKeyName": "<YOUR-ENCRYPTION-KEY-NAME>",
+    "keyVaultKeyVersion": "<YOUR-ENCRYPTION-KEY-VERSION>",
     "accessCredentials": {
-      "applicationId": "00000000-0000-0000-0000-000000000000",
-      "applicationSecret": "myApplicationSecret"
+      "applicationId": "<YOUR-APPLICATION-ID>",
+      "applicationSecret": "<YOUR-APPLICATION-SECRET>"
     }
   }
 }
@@ -473,12 +473,12 @@ Create an encrypted skillset using the [Create Skillset REST API](/rest/api/sear
     "cognitiveServices": { omitted for brevity },
       "knowledgeStore":  { omitted for brevity  },
     "encryptionKey": (optional) { 
-        "keyVaultKeyName": "myEncryptionKey",
-        "keyVaultKeyVersion": "eaab6a663d59439ebb95ce2fe7d5f660",
-        "keyVaultUri": "https://demokeyvault.vault.azure.net",
+        "keyVaultKeyName": "<YOUR-ENCRYPTION-KEY-NAME>",
+        "keyVaultKeyVersion": "<YOUR-ENCRYPTION-KEY-VERSION>",
+        "keyVaultUri": "<YOUR-KEY-VAULT-URI>",
         "accessCredentials": {
-            "applicationId": "00000000-0000-0000-0000-000000000000",
-            "applicationSecret": "myApplicationSecret"}
+          "applicationId": "<YOUR-APPLICATION-ID>",
+          "applicationSecret": "<YOUR-APPLICATION-SECRET>"
     }
 }
 ```
@@ -500,12 +500,12 @@ Create an encrypted indexer using the [Create Indexer REST API](/rest/api/search
       }
   },
   "encryptionKey": {
-    "keyVaultUri": "https://demokeyvault.vault.azure.net",
-    "keyVaultKeyName": "myEncryptionKey",
-    "keyVaultKeyVersion": "eaab6a663d59439ebb95ce2fe7d5f660",
+    "keyVaultUri": "<YOUR-KEY-VAULT-URI>",
+    "keyVaultKeyName": "<YOUR-ENCRYPTION-KEY-NAME>",
+    "keyVaultKeyVersion": "<YOUR-ENCRYPTION-KEY-VERSION>",
     "accessCredentials": {
-      "applicationId": "00000000-0000-0000-0000-000000000000",
-      "applicationSecret": "myApplicationSecret"
+      "applicationId": "<YOUR-APPLICATION-ID>",
+      "applicationSecret": "<YOUR-APPLICATION-SECRET>"
     }
   }
 }

articles/search/search-semi-structured-data.md

@@ -165,7 +165,7 @@ HTTP/1.1 201 Created
 Transfer-Encoding: chunked
 Content-Type: application/json; odata.metadata=minimal; odata.streaming=true; charset=utf-8
 ETag: "0x8DC43A5FDB8448F"
-Location: https://free-demo-search-svc.search.windows.net:443/datasources('ny-philharmonic-ds')?api-version=2024-07-01
+Location: https://<YOUR-SEARCH-SERVICE-NAME>.search.windows.net:443/datasources('ny-philharmonic-ds')?api-version=2024-07-01
 Server: Microsoft-IIS/10.0
 Strict-Transport-Security: max-age=2592000, max-age=15724800; includeSubDomains
 Preference-Applied: odata.include-annotations="*"
@@ -176,7 +176,7 @@ Date: Wed, 13 Mar 2024 21:38:58 GMT
 Connection: close
 
 {
-  "@odata.context": "https://free-demo-search-svc.search.windows.net/$metadata#datasources/$entity",
+  "@odata.context": "https://<YOUR-SEARCH-SERVICE-NAME>.search.windows.net/$metadata#datasources/$entity",
   "@odata.etag": "\"0x8DC43A5FDB8448F\"",
   "name": "ny-philharmonic-ds",
   "description": null,
@@ -308,7 +308,7 @@ Date: Wed, 13 Mar 2024 22:09:59 GMT
 Connection: close
 
 {
-  "@odata.context": "https://free-demo-search-svc.search.windows.net/indexes('ny-philharmonic-index')/$metadata#docs(*)",
+  "@odata.context": "https://<YOUR-SEARCH-SERVICE-NAME>.search.windows.net/indexes('ny-philharmonic-index')/$metadata#docs(*)",
   "@odata.count": 1521,
   "@search.nextPageParameters": {
     "search": "*",
@@ -317,7 +317,7 @@ Connection: close
   },
   "value": [
   ],
-  "@odata.nextLink": "https://free-demo-search-svc.search.windows.net/indexes/ny-philharmonic-index/docs/search?api-version=2024-07-01"
+  "@odata.nextLink": "https://<YOUR-SEARCH-SERVICE-NAME>.search.windows.net/indexes/ny-philharmonic-index/docs/search?api-version=2024-07-01"
 }
 ```
 

articles/search/vector-search-integrated-vectorization-ai-studio.md

@@ -71,8 +71,8 @@ The URI and key are generated when you deploy the model from the catalog. For mo
 {
   "@odata.type": "#Microsoft.Skills.Custom.AmlSkill",
   "context": "/document/pages/*",
-  "uri": "{YOUR_MODEL_URL_HERE}",
-  "key": "{YOUR_MODEL_KEY_HERE}",
+  "uri": "<YOUR_MODEL_URL_HERE>",
+  "key": "<YOUR_MODEL_KEY_HERE>",
   "inputs": [
     {
       "name": "input_data",
@@ -118,8 +118,8 @@ The URI and key are generated when you deploy the model from the catalog. For mo
 {
   "@odata.type": "#Microsoft.Skills.Custom.AmlSkill",
   "context": "/document/normalized_images/*",
-  "uri": "{YOUR_MODEL_URL_HERE}",
-  "key": "{YOUR_MODEL_HERE}",
+  "uri": "<YOUR_MODEL_URL_HERE>",
+  "key": "<YOUR_MODEL_HERE>",
   "inputs": [
     {
       "name": "input_data",
@@ -165,8 +165,8 @@ The URI and key are generated when you deploy the model from the catalog. For mo
 {
   "@odata.type": "#Microsoft.Skills.Custom.AmlSkill",
   "context": "/document/pages/*",
-  "uri": "{YOUR_MODEL_URL_HERE}/v1/embed",
-  "key": "{YOUR_MODEL_KEY_HERE}",
+  "uri": "<YOUR_MODEL_URL_HERE>/v1/embed",
+  "key": "<YOUR_MODEL_KEY_HERE>",
   "inputs": [
     {
       "name": "texts",
@@ -202,7 +202,7 @@ If you selected a different `embedding_types` in your skill definition that you
 "indexProjections": {
   "selectors": [
     {
-      "targetIndexName": "{YOUR_TARGET_INDEX_NAME_HERE}",
+      "targetIndexName": "<YOUR_TARGET_INDEX_NAME_HERE>",
       "parentKeyFieldName": "ParentKey", // Change this to the name of the field in your index definition where the parent key will be stored
       "sourceContext": "/document/pages/*",
       "mappings": [
@@ -230,12 +230,12 @@ For Cohere models, you should NOT add the `/v1/embed` path to the end of your UR
 ```json
 "vectorizers": [
     {
-        "name": "{YOUR_VECTORIZER_NAME_HERE}",
+        "name": "<YOUR_VECTORIZER_NAME_HERE>",
         "kind": "aml",
         "amlParameters": {
-            "uri": "{YOUR_URL_HERE}",
-            "key": "{YOUR_PRIMARY_KEY_HERE}",
-            "modelName": "{YOUR_MODEL_ID_HERE}"
+            "uri": "<YOUR_URL_HERE>",
+            "key": "<YOUR_PRIMARY_KEY_HERE>",
+            "modelName": "<YOUR_MODEL_ID_HERE>"
         },
     }
 ]
@@ -246,8 +246,8 @@ For Cohere models, you should NOT add the `/v1/embed` path to the end of your UR
 If you can't use key-based authentication, you can instead configure the AML skill and AI Studio vectorizer connection for [token authentication](../machine-learning/how-to-authenticate-online-endpoint.md) via role-based access control on Azure. The search service must have a [system or user-assigned managed identity](search-howto-managed-identities-data-sources.md), and the identity must have Owner or Contributor permissions for your AML project workspace. You can then remove the key field from your skill and vectorizer definition, replacing it with the resourceId field. If your AML project and search service are in different regions, also provide the region field.
 
 ```json
-"uri": "{YOUR_URL_HERE}",
-"resourceId": "subscriptions/{YOUR_SUBSCRIPTION_ID_HERE/resourceGroups/{YOUR_RESOURCE_GROUP_NAME_HERE}/providers/Microsoft.MachineLearningServices/workspaces/{YOUR_AML_WORKSPACE_NAME_HERE}/onlineendpoints/{YOUR_AML_ENDPOINT_NAME_HERE}",
+"uri": "<YOUR_URL_HERE>",
+"resourceId": "subscriptions/<YOUR_SUBSCRIPTION_ID_HERE>/resourceGroups/<YOUR_RESOURCE_GROUP_NAME_HERE>/providers/Microsoft.MachineLearningServices/workspaces/<YOUR_AML_WORKSPACE_NAME_HERE>/onlineendpoints/<YOUR_AML_ENDPOINT_NAME_HERE>",
 "region": "westus", // Only need if AML project lives in different region from search service
 ```