Shared Private Link Resources - Create Or Update

Service:
Search Management
API-versie:
2025-02-01-preview

Start het maken of bijwerken van een gedeelde private link-resource die wordt beheerd door de zoekservice in de opgegeven resourcegroep.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
 path True

string

De naam van de resourcegroep binnen het huidige abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
searchServiceName
 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.
sharedPrivateLinkResourceName
 path True

string

De naam van de gedeelde private link-resource die wordt beheerd door de Azure AI Search-service binnen de opgegeven resourcegroep.
subscriptionId
 path True

string

De unieke id voor een Microsoft Azure-abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
api-version
 query True

string

De API-versie die voor elke aanvraag 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.

Aanvraagbody

Name Type Description
properties

SharedPrivateLinkResourceProperties

Beschrijft de eigenschappen van een gedeelde private link-resource die wordt beheerd door de Azure AI Search-service.

Antwoorden

Name Type Description
200 OK

SharedPrivateLinkResource

De details van de gedeelde private link-resource die is gemaakt of bijgewerkt.
202 Accepted

De gedeelde private link-resource is geaccepteerd en wordt asynchroon voltooid.
Other Status Codes

CloudError

HTTP 400 (ongeldige aanvraag): de opgegeven naam van de gedeelde private link-resource of de definitie van de gedeelde private link-resource is ongeldig; Zie de foutcode en het bericht in het antwoord voor meer informatie. HTTP 404 (niet gevonden): het abonnement, de resourcegroep, de zoekservice of de gedeelde private link-resource zijn niet gevonden. HTTP 409 (conflict): het opgegeven abonnement is uitgeschakeld.

Beveiliging

azure_auth

Hiermee geeft u een impliciete toekenningsstroom op, zoals ondersteund op het Microsoft Identity-platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

SharedPrivateLinkResourceCreateOrUpdate

Voorbeeldaanvraag

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
  }
}

Voorbeeldrespons

Statuscode:
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
Statuscode:
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
  }
}

Definities

Name Description
CloudError

Bevat informatie over een API-fout.
CloudErrorBody

Beschrijft een bepaalde API-fout met een foutcode en een bericht.
SharedPrivateLinkResource

Beschrijft een gedeelde private link-resource die wordt beheerd door de Azure AI Search-service.
SharedPrivateLinkResourceProperties

Beschrijft de eigenschappen van een bestaande gedeelde private link-resource die wordt beheerd door de Azure AI Search-service.
SharedPrivateLinkResourceProvisioningState

De inrichtingsstatus van de gedeelde private link-resource. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig.
SharedPrivateLinkResourceStatus

Status van de gedeelde private link-resource. Geldige waarden zijn in behandeling, goedgekeurd, geweigerd of verbroken.

CloudError

Object

Bevat informatie over een API-fout.

Name Type Description
error

CloudErrorBody

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

Object

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

CloudErrorBody[]

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

SharedPrivateLinkResource

Object

Beschrijft een gedeelde private link-resource die wordt beheerd door de Azure AI Search-service.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

De naam van de resource
properties

SharedPrivateLinkResourceProperties

Beschrijft de eigenschappen van een gedeelde private link-resource die wordt beheerd door de Azure AI Search-service.
type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SharedPrivateLinkResourceProperties

Object

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

SharedPrivateLinkResourceProvisioningState

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

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

SharedPrivateLinkResourceStatus

Status van de gedeelde private link-resource. Geldige waarden zijn in behandeling, goedgekeurd, geweigerd of verbroken.

SharedPrivateLinkResourceProvisioningState

Opsomming

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

Opsomming

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.