Shared Private Link Resources - Get
Hiermee haalt u de details op van de gedeelde private link-resource die wordt beheerd door de zoekservice in de opgegeven resourcegroep.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2025-05-01
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
De naam van de resourcegroep. De naam is hoofdletterongevoelig. |
|
search
|
path | True |
string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ |
De naam van de Azure AI Search-service die is gekoppeld aan de opgegeven resourcegroep. |
|
shared
|
path | True |
string |
De naam van de gedeelde private link-resource die wordt beheerd door de Azure AI Search-service binnen de opgegeven resourcegroep. |
|
subscription
|
path | True |
string (uuid) |
De id van het doelabonnement. De waarde moet een UUID zijn. |
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagkoptekst
| Name | Vereist | Type | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Een door de client gegenereerde GUID-waarde die deze aanvraag identificeert. Indien opgegeven, wordt dit opgenomen in antwoordinformatie als een manier om de aanvraag bij te houden. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
Azure-bewerking is voltooid. |
|
| Other Status Codes |
Een onverwachte foutreactie. |
Beveiliging
azure_auth
OAuth2-stroom voor Azure Active Directory.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
| Name | Description |
|---|---|
| user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
SharedPrivateLinkResourceGet
Voorbeeldaanvraag
Voorbeeldrespons
{
"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"
}
}
Definities
| Name | Description |
|---|---|
|
Cloud |
Bevat informatie over een API-fout. |
|
Cloud |
Beschrijft een bepaalde API-fout met een foutcode en een bericht. |
|
created |
Het type identiteit waarmee de resource is gemaakt. |
|
Shared |
Beschrijft een gedeelde private link-resource die wordt beheerd door de Azure AI Search-service. |
|
Shared |
Beschrijft de eigenschappen van een bestaande gedeelde private link-resource die wordt beheerd door de Azure AI Search-service. |
|
Shared |
De inrichtingsstatus van de gedeelde private link-resource. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig. |
|
Shared |
Status van de gedeelde private link-resource. Geldige waarden zijn in behandeling, goedgekeurd, geweigerd of verbroken. |
|
system |
Metagegevens met betrekking tot het maken en de laatste wijziging van de resource. |
CloudError
Bevat informatie over een API-fout.
| Name | Type | Description |
|---|---|---|
| error |
Beschrijft een bepaalde API-fout met een foutcode en een bericht. |
|
| message |
string |
Een korte beschrijving van de fout die aangeeft wat er fout is gegaan (voor informatie over details/foutopsporing raadpleegt u de eigenschap 'error.message'). |
CloudErrorBody
Beschrijft een bepaalde API-fout met een foutcode en een bericht.
| Name | Type | Description |
|---|---|---|
| code |
string |
Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt om programmatisch specifieke foutcases af te handelen. |
| details |
Bevat geneste fouten die betrekking hebben op deze fout. |
|
| message |
string |
Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing. |
| target |
string |
Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout). |
createdByType
Het type identiteit waarmee de resource is gemaakt.
| Waarde | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
SharedPrivateLinkResource
Beschrijft een gedeelde private link-resource die wordt beheerd door de Azure AI Search-service.
| Name | Type | Description |
|---|---|---|
| id |
string (arm-id) |
Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}" |
| name |
string |
De naam van de resource |
| properties |
Beschrijft de eigenschappen van een gedeelde private link-resource die wordt beheerd door de Azure AI Search-service. |
|
| systemData |
Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens. |
|
| type |
string |
Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
SharedPrivateLinkResourceProperties
Beschrijft de eigenschappen van een bestaande gedeelde private link-resource die wordt beheerd door de Azure AI Search-service.
| Name | Type | Description |
|---|---|---|
| groupId |
string |
De groeps-id van de provider van de resource waarvoor de gedeelde private link-resource is bedoeld. |
| privateLinkResourceId |
string |
De resource-id van de resource waarvoor de gedeelde private link-resource is bedoeld. |
| provisioningState |
De inrichtingsstatus van de gedeelde private link-resource. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig. |
|
| requestMessage |
string |
Het bericht voor het aanvragen van goedkeuring van de gedeelde private link-resource. |
| resourceRegion |
string |
Facultatief. Kan worden gebruikt om de Azure Resource Manager-locatie op te geven van de resource waarvoor een gedeelde privékoppeling wordt gemaakt. Dit is alleen vereist voor de resources waarvan de DNS-configuratie regionaal is (zoals Azure Kubernetes Service). |
| status |
Status van de gedeelde private link-resource. Geldige waarden zijn in behandeling, goedgekeurd, geweigerd of verbroken. |
SharedPrivateLinkResourceProvisioningState
De inrichtingsstatus van de gedeelde private link-resource. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig.
| Waarde | Description |
|---|---|
| Updating |
De gedeelde private link-resource wordt samen met andere resources gemaakt, zodat deze volledig functioneel is. |
| Deleting |
De gedeelde private link-resource wordt verwijderd. |
| Failed |
De gedeelde private link-resource kan niet worden ingericht of verwijderd. |
| Succeeded |
De gedeelde private link-resource is ingericht en is gereed voor goedkeuring. |
| Incomplete |
De inrichtingsaanvraag voor de gedeelde private link-resource is geaccepteerd, maar het maken is nog niet gestart. |
SharedPrivateLinkResourceStatus
Status van de gedeelde private link-resource. Geldige waarden zijn in behandeling, goedgekeurd, geweigerd of verbroken.
| Waarde | Description |
|---|---|
| Pending |
De gedeelde private link-resource is gemaakt en wacht op goedkeuring. |
| Approved |
De gedeelde private link-resource is goedgekeurd en is klaar voor gebruik. |
| Rejected |
De gedeelde private link-resource is geweigerd en kan niet worden gebruikt. |
| Disconnected |
De gedeelde private link-resource is verwijderd uit de service. |
systemData
Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
| Name | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
De tijdstempel van het maken van resources (UTC). |
| createdBy |
string |
De identiteit waarmee de resource is gemaakt. |
| createdByType |
Het type identiteit waarmee de resource is gemaakt. |
|
| lastModifiedAt |
string (date-time) |
De tijdstempel van de laatste wijziging van de resource (UTC) |
| lastModifiedBy |
string |
De identiteit die de resource voor het laatst heeft gewijzigd. |
| lastModifiedByType |
Het type identiteit dat de resource voor het laatst heeft gewijzigd. |