Shared Private Link Resources - List By Service

Tjänst:: Search Management

API-version:: 2026-11-01

Hämtar en lista över alla delade privata länkresurser som hanteras av den angivna tjänsten.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources?api-version=2026-11-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Namnet på den Azure AI-sökning-tjänst som är associerad med den angivna resursgruppen.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	Ett klientgenererat GUID-värde som identifierar den här begäran. Om det anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran.

Svar

Name	Typ	Description
200 OK	SharedPrivateLinkResourceListResult	Begäran har slutförts.
Other Status Codes	CloudError	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ListSharedPrivateLinkResourcesByService

Exempelbegäran

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources?api-version=2026-11-01

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "name": "testResource",
      "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource",
      "properties": {
        "groupId": "blob",
        "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
        "requestMessage": "please approve",
        "resourceRegion": null,
        "status": "Pending"
      }
    }
  ]
}

Definitioner

Name	Description
CloudError	Innehåller information om ett API-fel.
CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
createdByType	Den typ av identitet som skapade resursen.
SharedPrivateLinkResource	Beskriver en delad privat länkresurs som hanteras av Azure AI-sökning-tjänsten.
SharedPrivateLinkResourceListResult	Svar som innehåller en lista över resurser för delad privat länk.
SharedPrivateLinkResourceProperties	Beskriver egenskaperna hos en befintlig delad privat länkresurs som hanteras av Azure AI-sökning-tjänsten.
SharedPrivateLinkResourceProvisioningState	Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.
SharedPrivateLinkResourceStatus	Status för resursen för delad privat länk. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.
systemData	Metadata som rör skapande och senaste ändring av resursen.

CloudError

Objekt

Innehåller information om ett API-fel.

Name	Typ	Description
error	CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
message	string	En kort beskrivning av felet som antyder vad som gick fel (mer information/felsökningsinformation finns i egenskapen "error.message").

CloudErrorBody

Objekt

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.
details	CloudErrorBody[]	Innehåller kapslade fel som är relaterade till det här felet.
message	string	Ett meddelande som beskriver felet i detalj och ger felsökningsinformation.
target	string	Målet för det specifika felet (till exempel namnet på den felaktiga egenskapen).

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

SharedPrivateLinkResource

Objekt

Beskriver en delad privat länkresurs som hanteras av Azure AI-sökning-tjänsten.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties	SharedPrivateLinkResourceProperties	Beskriver egenskaperna för en resurs för delad privat länk som hanteras av Azure AI-sökning-tjänsten.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceListResult

Objekt

Svar som innehåller en lista över resurser för delad privat länk.

Name	Typ	Description
nextLink	string	URL:en för att hämta nästa uppsättning delade privata länkresurser, om det finns några.
value	SharedPrivateLinkResource[]	Listan över resurser för delad privat länk.

SharedPrivateLinkResourceProperties

Objekt

Beskriver egenskaperna hos en befintlig delad privat länkresurs som hanteras av Azure AI-sökning-tjänsten.

Name	Typ	Description
groupId	string	Grupp-ID:t från resursprovidern som resursen delad privat länk är till för.
privateLinkResourceId	string	Resurs-ID:t för resursen som resursen för den delade privata länken är till för.
provisioningState	SharedPrivateLinkResourceProvisioningState	Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.
requestMessage	string	Meddelandet för att begära godkännande av resursen för delad privat länk.
resourceRegion	string	Optional. Kan användas för att ange Azure Resource Manager-platsen för resursen som en delad privat länk skapas för. Detta krävs endast för de resurser vars DNS-konfiguration är regional (till exempel Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Status för resursen för delad privat länk. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

SharedPrivateLinkResourceProvisioningState

Uppräkning

Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.

Värde	Description
Updating	Resursen för delad privat länk håller på att skapas tillsammans med andra resurser för att den ska fungera fullt ut.
Deleting	Resursen för delad privat länk håller på att tas bort.
Failed	Resursen för den delade privata länken kunde inte etableras eller tas bort.
Succeeded	Resursen för delad privat länk har slutfört etableringen och är redo för godkännande.
Incomplete	Etableringsbegäran för resursen för delad privat länk har godkänts, men processen för att skapa har inte påbörjats ännu.

SharedPrivateLinkResourceStatus

Uppräkning

Status för resursen för delad privat länk. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

Värde	Description
Pending	Resursen för delad privat länk har skapats och väntar på godkännande.
Approved	Resursen för delad privat länk är godkänd och är redo att användas.
Rejected	Resursen för delad privat länk har avvisats och kan inte användas.
Disconnected	Resursen för delad privat länk har tagits bort från tjänsten.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.