Skip to content

Commit 3660ee5

Browse files
author
Chang Lu
committed
Update help md files and reslove anaylze errors.
1 parent 93c43f5 commit 3660ee5

20 files changed

+147
-147
lines changed

src/Search/Search/help/Az.Search.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,59 +12,59 @@ This topic displays help topics for the Azure AI Search Cmdlets.
1212

1313
## Az.Search Cmdlets
1414
### [Get-AzSearchAdminKeyPair](Get-AzSearchAdminKeyPair.md)
15-
Gets admin key pair of the Azure Cognitive Search service.
15+
Gets admin key pair of the Azure AI Search service.
1616

1717
### [Get-AzSearchNetworkSecurityPerimeterConfiguration](Get-AzSearchNetworkSecurityPerimeterConfiguration.md)
1818
Gets an Azure AI Search service network security perimeter configuration.
1919

2020
### [Get-AzSearchPrivateEndpointConnection](Get-AzSearchPrivateEndpointConnection.md)
21-
Gets private endpoint connection(s) to the Azure Cognitive Search service.
21+
Gets private endpoint connection(s) to the Azure AI Search service.
2222

2323
### [Get-AzSearchPrivateLinkResource](Get-AzSearchPrivateLinkResource.md)
24-
Gets private link resource details for the Azure Cognitive Search service.
24+
Gets private link resource details for the Azure AI Search service.
2525

2626
### [Get-AzSearchQueryKey](Get-AzSearchQueryKey.md)
27-
Gets query key(s) of the Azure Cognitive Search service.
27+
Gets query key(s) of the Azure AI Search service.
2828

2929
### [Get-AzSearchService](Get-AzSearchService.md)
30-
Gets an Azure Cognitive Search service.
30+
Gets an Azure AI Search service.
3131

3232
### [Get-AzSearchSharedPrivateLinkResource](Get-AzSearchSharedPrivateLinkResource.md)
33-
Gets shared private link resources(s) of the Azure Cognitive Search service.
33+
Gets shared private link resources(s) of the Azure AI Search service.
3434

3535
### [Invoke-AzSearchNetworkSecurityPerimeterConfigurationReconcile](Invoke-AzSearchNetworkSecurityPerimeterConfigurationReconcile.md)
3636
{{ Fill in the Synopsis }}
3737

3838
### [New-AzSearchAdminKey](New-AzSearchAdminKey.md)
39-
Regenerates an admin key of the Azure Cognitive Search service.
39+
Regenerates an admin key of the Azure AI Search service.
4040

4141
### [New-AzSearchQueryKey](New-AzSearchQueryKey.md)
42-
Create a new query key for the Azure Cognitive Search service.
42+
Create a new query key for the Azure AI Search service.
4343

4444
### [New-AzSearchService](New-AzSearchService.md)
45-
Creates an Azure Cognitive Search service.
45+
Creates an Azure AI Search service.
4646

4747
### [New-AzSearchSharedPrivateLinkResource](New-AzSearchSharedPrivateLinkResource.md)
48-
Creates a shared private link resource for the Azure Cognitive Search service.
48+
Creates a shared private link resource for the Azure AI Search service.
4949

5050
### [Remove-AzSearchPrivateEndpointConnection](Remove-AzSearchPrivateEndpointConnection.md)
51-
Remove the private endpoint connection from the Azure Cognitive Search service.
51+
Remove the private endpoint connection from the Azure AI Search service.
5252

5353
### [Remove-AzSearchQueryKey](Remove-AzSearchQueryKey.md)
54-
Remove the query key from the Azure Cognitive Search service.
54+
Remove the query key from the Azure AI Search service.
5555

5656
### [Remove-AzSearchService](Remove-AzSearchService.md)
57-
Remove an Azure Cognitive Search service.
57+
Remove an Azure AI Search service.
5858

5959
### [Remove-AzSearchSharedPrivateLinkResource](Remove-AzSearchSharedPrivateLinkResource.md)
60-
Remove the shared private link resource from the Azure Cognitive Search service.
60+
Remove the shared private link resource from the Azure AI Search service.
6161

6262
### [Set-AzSearchPrivateEndpointConnection](Set-AzSearchPrivateEndpointConnection.md)
63-
Update the private endpoint connection to the Azure Cognitive Search service.
63+
Update the private endpoint connection to the Azure AI Search service.
6464

6565
### [Set-AzSearchService](Set-AzSearchService.md)
66-
Update an Azure Cognitive Search service.
66+
Update an Azure AI Search service.
6767

6868
### [Set-AzSearchSharedPrivateLinkResource](Set-AzSearchSharedPrivateLinkResource.md)
69-
Update the shared private link resource for the Azure Cognitive Search service.
69+
Update the shared private link resource for the Azure AI Search service.
7070

src/Search/Search/help/Get-AzSearchAdminKeyPair.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-AzSearchAdminKeyPair
99

1010
## SYNOPSIS
11-
Gets admin key pair of the Azure Cognitive Search service.
11+
Gets admin key pair of the Azure AI Search service.
1212

1313
## SYNTAX
1414

@@ -31,7 +31,7 @@ Get-AzSearchAdminKeyPair [-ParentResourceId] <String> [-DefaultProfile <IAzureCo
3131
```
3232

3333
## DESCRIPTION
34-
The **Get-AzSearchAdminKeyPair** cmdlet gets the admin key pair of the Azure Cognitive Search service.
34+
The **Get-AzSearchAdminKeyPair** cmdlet gets the admin key pair of the Azure AI Search service.
3535

3636
## EXAMPLES
3737

@@ -46,7 +46,7 @@ Primary Secondary
4646
3B06A25BDADFF72EC132736BAA2547A1 E643B75A52E04DF13EB690807C451C55
4747
```
4848

49-
The example gets admin key pair of the Azure Cognitive Search service.
49+
The example gets admin key pair of the Azure AI Search service.
5050

5151
## PARAMETERS
5252

@@ -66,7 +66,7 @@ Accept wildcard characters: False
6666
```
6767
6868
### -ParentObject
69-
Azure Cognitive Search Service Input Object.
69+
Azure AI Search Service Input Object.
7070
7171
```yaml
7272
Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService
@@ -81,7 +81,7 @@ Accept wildcard characters: False
8181
```
8282
8383
### -ParentResourceId
84-
Azure Cognitive Search Service Resource Id.
84+
Azure AI Search Service Resource Id.
8585
8686
```yaml
8787
Type: System.String
@@ -126,7 +126,7 @@ Accept wildcard characters: False
126126
```
127127
128128
### -ServiceName
129-
Azure Cognitive Search Service name.
129+
Azure AI Search Service name.
130130
131131
```yaml
132132
Type: System.String

src/Search/Search/help/Get-AzSearchPrivateEndpointConnection.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-AzSearchPrivateEndpointConnection
99

1010
## SYNOPSIS
11-
Gets private endpoint connection(s) to the Azure Cognitive Search service.
11+
Gets private endpoint connection(s) to the Azure AI Search service.
1212

1313
## SYNTAX
1414

@@ -33,7 +33,7 @@ Get-AzSearchPrivateEndpointConnection [-ResourceId] <String> [-DefaultProfile <I
3333
```
3434

3535
## DESCRIPTION
36-
The **Get-AzSearchPrivateEndpointConnection** cmdlet gets the private endpoint connection(s) to the Azure Cognitive Search service.
36+
The **Get-AzSearchPrivateEndpointConnection** cmdlet gets the private endpoint connection(s) to the Azure AI Search service.
3737

3838
## EXAMPLES
3939

@@ -48,7 +48,7 @@ Name Id
4848
arjagann-test-cuseuap-pe.4c74dd7c-7016-42ac-827a-8d5d1378f266 /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann/providers/Microsoft.Search/searchServices/arjagann-test-cuseuap/privateEndpointConnections/arjagann-test-cuseuap-pe.4c74dd7c-7016-42ac-827a-8d5d1378f266
4949
```
5050

51-
The example gets all the private endpoint connections to the Azure Cognitive Search service.
51+
The example gets all the private endpoint connections to the Azure AI Search service.
5252

5353
### Example 2
5454
```powershell
@@ -70,7 +70,7 @@ Get-AzSearchPrivateEndpointConnection -ResourceGroupName arjagann -ServiceName a
7070
}
7171
```
7272

73-
The example gets a specific private endpoint connection by name (converted to JSON for ease of reading) to the Azure Cognitive Search service.
73+
The example gets a specific private endpoint connection by name (converted to JSON for ease of reading) to the Azure AI Search service.
7474

7575
## PARAMETERS
7676

@@ -90,7 +90,7 @@ Accept wildcard characters: False
9090
```
9191
9292
### -Name
93-
Azure Cognitive Search Service private endpoint connection name
93+
Azure AI Search Service private endpoint connection name
9494
9595
```yaml
9696
Type: System.String
@@ -105,7 +105,7 @@ Accept wildcard characters: False
105105
```
106106
107107
### -ParentObject
108-
Azure Cognitive Search Service Input Object.
108+
Azure AI Search Service Input Object.
109109
110110
```yaml
111111
Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService
@@ -165,7 +165,7 @@ Accept wildcard characters: False
165165
```
166166
167167
### -ServiceName
168-
Azure Cognitive Search Service name.
168+
Azure AI Search Service name.
169169
170170
```yaml
171171
Type: System.String

src/Search/Search/help/Get-AzSearchPrivateLinkResource.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-AzSearchPrivateLinkResource
99

1010
## SYNOPSIS
11-
Gets private link resource details for the Azure Cognitive Search service.
11+
Gets private link resource details for the Azure AI Search service.
1212

1313
## SYNTAX
1414

@@ -32,7 +32,7 @@ Get-AzSearchPrivateLinkResource [-InputObject] <PSSearchService> [-DefaultProfil
3232
```
3333

3434
## DESCRIPTION
35-
The **Get-AzSearchPrivateLinkResource** cmdlet gets private link resource details for the Azure Cognitive Search service.
35+
The **Get-AzSearchPrivateLinkResource** cmdlet gets private link resource details for the Azure AI Search service.
3636

3737
## EXAMPLES
3838

@@ -54,39 +54,39 @@ Get-AzSearchPrivateLinkResource -ResourceGroupName arjagann -Name arjagann-test-
5454
"ShareablePrivateLinkResourceTypes": [
5555
{
5656
"Name": "blob",
57-
"Description": "Azure Cognitive Search indexers can connect to blobs in Azure Storage for reading data (data source), for writing intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)",
57+
"Description": "Azure AI Search indexers can connect to blobs in Azure Storage for reading data (data source), for writing intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)",
5858
"Type": "Microsoft.Storage/storageAccounts",
5959
"GroupId": "blob"
6060
},
6161
{
6262
"Name": "table",
63-
"Description": "Azure Cognitive Search indexers can connect to tables in Azure Storage for reading data (data source), for writing book-keeping information about intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)",
63+
"Description": "Azure AI Search indexers can connect to tables in Azure Storage for reading data (data source), for writing book-keeping information about intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)",
6464
"Type": "Microsoft.Storage/storageAccounts",
6565
"GroupId": "table"
6666
},
6767
{
6868
"Name": "Sql",
69-
"Description": "Azure Cognitive Search indexers can connect to CosmosDB using the SQL head for reading data (data source).",
69+
"Description": "Azure AI Search indexers can connect to CosmosDB using the SQL head for reading data (data source).",
7070
"Type": "Microsoft.DocumentDB/databaseAccounts",
7171
"GroupId": "Sql"
7272
},
7373
{
7474
"Name": "plr",
75-
"Description": "Azure Cognitive Search indexers can connect to AzureSQL databases in a SQL server for reading data (data source).",
75+
"Description": "Azure AI Search indexers can connect to AzureSQL databases in a SQL server for reading data (data source).",
7676
"Type": "Microsoft.Sql/servers",
7777
"GroupId": "sqlServer"
7878
},
7979
{
8080
"Name": "vault",
81-
"Description": "Azure Cognitive Search can access keys in Azure Key Vault to encrypt search index and synonym map data",
81+
"Description": "Azure AI Search can access keys in Azure Key Vault to encrypt search index and synonym map data",
8282
"Type": "Microsoft.KeyVault/vaults",
8383
"GroupId": "vault"
8484
}
8585
]
8686
}
8787
```
8888

89-
The example shows how to get the private link resource details (in JSON form for convenience) for the Azure Cognitive Search service.
89+
The example shows how to get the private link resource details (in JSON form for convenience) for the Azure AI Search service.
9090

9191
## PARAMETERS
9292

@@ -106,7 +106,7 @@ Accept wildcard characters: False
106106
```
107107
108108
### -InputObject
109-
Azure Cognitive Search Service Input Object.
109+
Azure AI Search Service Input Object.
110110
111111
```yaml
112112
Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService
@@ -121,7 +121,7 @@ Accept wildcard characters: False
121121
```
122122
123123
### -Name
124-
Azure Cognitive Search Service name.
124+
Azure AI Search Service name.
125125
126126
```yaml
127127
Type: System.String
@@ -166,7 +166,7 @@ Accept wildcard characters: False
166166
```
167167
168168
### -ResourceId
169-
Azure Cognitive Search Service Resource Id.
169+
Azure AI Search Service Resource Id.
170170
171171
```yaml
172172
Type: System.String

src/Search/Search/help/Get-AzSearchQueryKey.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-AzSearchQueryKey
99

1010
## SYNOPSIS
11-
Gets query key(s) of the Azure Cognitive Search service.
11+
Gets query key(s) of the Azure AI Search service.
1212

1313
## SYNTAX
1414

@@ -31,7 +31,7 @@ Get-AzSearchQueryKey [-ParentResourceId] <String> [-DefaultProfile <IAzureContex
3131
```
3232

3333
## DESCRIPTION
34-
The **Get-AzSearchQueryKey** cmdlet gets query key(s) of the Azure Cognitive Search service.
34+
The **Get-AzSearchQueryKey** cmdlet gets query key(s) of the Azure AI Search service.
3535

3636
## EXAMPLES
3737

@@ -46,7 +46,7 @@ Name Key
4646
896AA09C167541072D404E1BE0442CE9
4747
```
4848

49-
The example gets all query key(s) of the Azure Cognitive Search service.
49+
The example gets all query key(s) of the Azure AI Search service.
5050

5151
## PARAMETERS
5252

@@ -66,7 +66,7 @@ Accept wildcard characters: False
6666
```
6767
6868
### -ParentObject
69-
Azure Cognitive Search Service Input Object.
69+
Azure AI Search Service Input Object.
7070
7171
```yaml
7272
Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService
@@ -81,7 +81,7 @@ Accept wildcard characters: False
8181
```
8282
8383
### -ParentResourceId
84-
Azure Cognitive Search Service Resource Id.
84+
Azure AI Search Service Resource Id.
8585
8686
```yaml
8787
Type: System.String
@@ -126,7 +126,7 @@ Accept wildcard characters: False
126126
```
127127
128128
### -ServiceName
129-
Azure Cognitive Search Service name.
129+
Azure AI Search Service name.
130130
131131
```yaml
132132
Type: System.String

src/Search/Search/help/Get-AzSearchService.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-AzSearchService
99

1010
## SYNOPSIS
11-
Gets an Azure Cognitive Search service.
11+
Gets an Azure AI Search service.
1212

1313
## SYNTAX
1414

@@ -25,7 +25,7 @@ Get-AzSearchService [-ResourceId] <String> [-DefaultProfile <IAzureContextContai
2525
```
2626

2727
## DESCRIPTION
28-
The **Get-AzSearchService** cmdlet gets the specified Azure Cognitive Search service.
28+
The **Get-AzSearchService** cmdlet gets the specified Azure AI Search service.
2929

3030
## EXAMPLES
3131

@@ -45,7 +45,7 @@ HostingMode : Default
4545
Id : /subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/felixwa-01/providers/Microsoft.Search/searchServices/felixwa-basic-search
4646
```
4747

48-
Get an Azure Cognitive Search service with specified parameters.
48+
Get an Azure AI Search service with specified parameters.
4949

5050
## PARAMETERS
5151

@@ -65,7 +65,7 @@ Accept wildcard characters: False
6565
```
6666
6767
### -Name
68-
Azure Cognitive Search Service name.
68+
Azure AI Search Service name.
6969
7070
```yaml
7171
Type: System.String
@@ -110,7 +110,7 @@ Accept wildcard characters: False
110110
```
111111
112112
### -ResourceId
113-
Azure Cognitive Search Service Resource Id.
113+
Azure AI Search Service Resource Id.
114114
115115
```yaml
116116
Type: System.String

0 commit comments

Comments
 (0)