Shared Private Link Resources - Create Or Update

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-05-01

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

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 (uuid)

ID cílového předplatného. Hodnota musí být UUID.

api-version
query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

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

Operace aktualizace prostředku SharedPrivateLinkResource byla úspěšná

202 Accepted

Akceptovala se operace prostředku.

Hlavičky

Azure-AsyncOperation: string

Other Status Codes

CloudError

Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2025-05-01

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

Ukázková odpověď

{
  "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"
  }
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-05-01
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-05-01

Definice

Name Description
CloudError

Obsahuje informace o chybě rozhraní API.

CloudErrorBody

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

createdByType

Typ identity, která prostředek vytvořila.

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é.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

CloudError

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

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ě).

createdByType

Typ identity, která prostředek vytvořila.

Hodnota Description
User
Application
ManagedIdentity
Key

SharedPrivateLinkResource

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

Name Typ Description
id

string (arm-id)

Plně kvalifikované ID prostředku pro prostředek. Napří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.

systemData

systemData

Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SharedPrivateLinkResourceProperties

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

Volitelný. 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

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

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.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string (date-time)

Časové razítko vytvoření prostředku (UTC).

createdBy

string

Identita, která prostředek vytvořila.

createdByType

createdByType

Typ identity, která prostředek vytvořila.

lastModifiedAt

string (date-time)

Časové razítko poslední změny zdroje (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.