Get-AzSearchPrivateLinkResource

• Preview

Module:

Az.Search Module

This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.

Gets private link resource details for the Azure AI Search service.

Get-AzSearchPrivateLinkResource
 [-ResourceGroupName] <String>
 [-Name] <String>
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Get-AzSearchPrivateLinkResource
 [-ResourceId] <String>
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Get-AzSearchPrivateLinkResource
 [-InputObject] <PSSearchService>
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

The Get-AzSearchPrivateLinkResource cmdlet gets private link resource details for the Azure AI Search service.

Get-AzSearchPrivateLinkResource -ResourceGroupName arjagann -Name arjagann-test-cuseuap | ConvertTo-Json

"Id": "/subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann/providers/Microsoft.Search/searchServices/arjagann-test-cuseuap/privateLinkResources/searchService",
 "Type": "Microsoft.Search/searchServices/privateLinkResources",
 "GroupId": "searchService",
 "RequiredMembers": [
 "searchService"
 ],
 "RequiredZoneNames": [
 "privatelink.search-dogfood.windows-int.net"
 ],
 "ShareablePrivateLinkResourceTypes": [
 {
 "Name": "blob",
 "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)",
 "Type": "Microsoft.Storage/storageAccounts",
 "GroupId": "blob"
 },
 {
 "Name": "table",
 "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)",
 "Type": "Microsoft.Storage/storageAccounts",
 "GroupId": "table"
 },
 {
 "Name": "Sql",
 "Description": "Azure AI Search indexers can connect to CosmosDB using the SQL head for reading data (data source).",
 "Type": "Microsoft.DocumentDB/databaseAccounts",
 "GroupId": "Sql"
 },
 {
 "Name": "plr",
 "Description": "Azure AI Search indexers can connect to AzureSQL databases in a SQL server for reading data (data source).",
 "Type": "Microsoft.Sql/servers",
 "GroupId": "sqlServer"
 },
 {
 "Name": "vault",
 "Description": "Azure AI Search can access keys in Azure Key Vault to encrypt search index and synonym map data",
 "Type": "Microsoft.KeyVault/vaults",
 "GroupId": "vault"
 }
 ]
}

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

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.