Shared Private Link Resources - Create Or Update

Služba:: Search Management

Verze rozhraní API:: 2025-02-01-preview

Zahájí vytvoření nebo aktualizaci prostředku sdíleného privátního propojení spravovaného vyhledávací službou v dané skupině prostředků.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2025-02-01-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Název služby Azure AI Search přidružené k zadané skupině prostředků.
sharedPrivateLinkResourceName	path	True	string	Název prostředku sdíleného privátního propojení spravovaného službou Azure AI Search v zadané skupině prostředků.
subscriptionId	path	True	string	Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
api-version	query	True	string	Verze rozhraní API, která se má použít pro každý požadavek.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	Hodnota GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je zadáno, budou tyto informace zahrnuty do informací o odpovědích jako způsob, jak sledovat požadavek.

Text požadavku

Name	Typ	Description
properties	SharedPrivateLinkResourceProperties	Popisuje vlastnosti prostředku sdíleného privátního propojení spravovaného službou Azure AI Search.

Odpovědi

Name	Typ	Description
200 OK	SharedPrivateLinkResource	Podrobnosti o prostředku sdíleného privátního propojení, který byl vytvořen nebo aktualizován.
202 Accepted		Sdílená operace vytvoření nebo aktualizace prostředku privátního propojení byla přijata asynchronně.
Other Status Codes	CloudError	HTTP 400 (Chybný požadavek): Zadaný název prostředku sdíleného privátního propojení nebo definice prostředku sdíleného privátního propojení je neplatná; Podrobnosti najdete v kódu chyby a zprávě v odpovědi. HTTP 404 (Nenalezena): Nepodařilo se najít prostředek předplatného, skupiny prostředků, vyhledávací služby nebo sdíleného privátního propojení. HTTP 409 (konflikt): Zadané předplatné je zakázané.

Zabezpečení

azure_auth

Určuje implicitní tok udělení, který se podporuje na platformě Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

SharedPrivateLinkResourceCreateOrUpdate

Ukázkový požadavek

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2025-02-01-preview

{
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "resourceRegion": null
  }
}

Ukázková odpověď

Stavový kód:: 202

Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-02-01-preview
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-02-01-preview

Stavový kód:: 200

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

Definice

Name	Description
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
SharedPrivateLinkResource	Popisuje sdílený prostředek privátního propojení spravovaný službou Azure AI Search.
SharedPrivateLinkResourceProperties	Popisuje vlastnosti existujícího sdíleného prostředku privátního propojení spravovaného službou Azure AI Search.
SharedPrivateLinkResourceProvisioningState	Stav zřizování sdíleného prostředku privátního propojení. Platné hodnoty jsou Aktualizace, Odstranění, Neúspěšné, Úspěšné nebo Neúplné.
SharedPrivateLinkResourceStatus	Stav sdíleného prostředku privátního propojení Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

CloudError

Objekt

Obsahuje informace o chybě rozhraní API.

Name	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
message	string	Stručný popis chyby, která naznačuje, co se nepovedlo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message).

CloudErrorBody

Objekt

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Name	Typ	Description
code	string	Kód chyby, který popisuje chybový stav přesněji než stavový kód HTTP. Dá se použít k programovému zpracování konkrétních případů chyb.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které souvisejí s touto chybou.
message	string	Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě).

SharedPrivateLinkResource

Objekt

Popisuje sdílený prostředek privátního propojení spravovaný službou Azure AI Search.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties	SharedPrivateLinkResourceProperties	Popisuje vlastnosti prostředku sdíleného privátního propojení spravovaného službou Azure AI Search.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SharedPrivateLinkResourceProperties

Objekt

Popisuje vlastnosti existujícího sdíleného prostředku privátního propojení spravovaného službou Azure AI Search.

Name	Typ	Description
groupId	string	ID skupiny od poskytovatele prostředku, pro který je sdílený prostředek privátního propojení určený.
privateLinkResourceId	string	ID prostředku prostředku, pro který je sdílený prostředek privátního propojení.
provisioningState	SharedPrivateLinkResourceProvisioningState	Stav zřizování sdíleného prostředku privátního propojení. Platné hodnoty jsou Aktualizace, Odstranění, Neúspěšné, Úspěšné nebo Neúplné.
requestMessage	string	Zpráva pro žádost o schválení sdíleného prostředku privátního propojení.
resourceRegion	string	Optional. Dá se použít k určení umístění prostředku Azure Resource Manageru, pro který se vytváří sdílené privátní propojení. To se vyžaduje jenom pro prostředky, jejichž konfigurace DNS je regionální (například Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Stav sdíleného prostředku privátního propojení Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

SharedPrivateLinkResourceProvisioningState

Výčet

Stav zřizování sdíleného prostředku privátního propojení. Platné hodnoty jsou Aktualizace, Odstranění, Neúspěšné, Úspěšné nebo Neúplné.

Hodnota	Description
Updating	Sdílený prostředek privátního propojení probíhá při vytváření společně s dalšími prostředky, aby byl plně funkční.
Deleting	Sdílený prostředek privátního propojení probíhá v procesu odstranění.
Failed	Prostředek sdíleného privátního propojení se nepodařilo zřídit nebo odstranit.
Succeeded	Prostředek sdíleného privátního propojení dokončil zřizování a je připravený ke schválení.
Incomplete	Žádost o zřízení pro sdílený prostředek privátního propojení byla přijata, ale proces vytvoření ještě nebyl zahájen.

SharedPrivateLinkResourceStatus

Výčet

Stav sdíleného prostředku privátního propojení Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

Hodnota	Description
Pending	Byl vytvořen sdílený prostředek privátního propojení a čeká na schválení.
Approved	Sdílený prostředek privátního propojení je schválený a je připravený k použití.
Rejected	Sdílený prostředek privátního propojení byl odmítnut a nelze jej použít.
Disconnected	Sdílený prostředek privátního propojení byl ze služby odebrán.