Get-AzSearchPrivateLinkResource
Gets private link resource details for the Azure Cognitive Search service.
Syntax
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>]
Description
The Get-AzSearchPrivateLinkResource cmdlet gets private link resource details for the Azure Cognitive Search service.
Examples
Example 1
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 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)",
"Type": "Microsoft.Storage/storageAccounts",
"GroupId": "blob"
},
{
"Name": "table",
"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)",
"Type": "Microsoft.Storage/storageAccounts",
"GroupId": "table"
},
{
"Name": "Sql",
"Description": "Azure Cognitive 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 Cognitive 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 Cognitive 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 Cognitive Search service.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Azure Cognitive Search Service Input Object.
Type: | PSSearchService |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Azure Cognitive Search Service name.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Resource Group name.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceId
Azure Cognitive Search Service Resource Id.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None
Outputs
Related Links
Azure PowerShell