Partager via


Shared Private Link Resources - Create Or Update

Lance la création ou la mise à jour d’une ressource de liaison privée partagée gérée par le service de recherche dans le groupe de ressources donné.

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

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
path True

string

Nom du groupe de ressources au sein de l’abonnement actuel. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.

searchServiceName
path True

string

Nom du service de recherche associé au groupe de ressources spécifié.

sharedPrivateLinkResourceName
path True

string

Nom de la ressource de liaison privée partagée gérée par le service de recherche dans le groupe de ressources spécifié.

subscriptionId
path True

string

Identificateur unique d’un abonnement Microsoft Azure. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager, des outils en ligne de commande ou du portail.

api-version
query True

string

Version de l’API à utiliser pour chaque requête.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-request-id

string

uuid

Valeur GUID générée par le client, qui identifie cette demande. S’il est spécifié, il est inclus dans les informations de réponse afin de suivre la demande.

Corps de la demande

Nom Type Description
properties

SharedPrivateLinkResourceProperties

Décrit les propriétés d’une ressource de Private Link partagée gérée par le service de recherche.

Réponses

Nom Type Description
200 OK

SharedPrivateLinkResource

Détails de la ressource de liaison privée partagée qui a été créée ou mise à jour.

202 Accepted

L’opération de création ou de mise à jour de la ressource de liaison privée partagée a été acceptée et se termine de manière asynchrone.

Other Status Codes

CloudError

HTTP 400 (requête incorrecte) : le nom de ressource de liaison privée partagée ou la définition de ressource de liaison privée partagée n’est pas valide ; Pour plus d’informations, consultez le code d’erreur et le message dans la réponse. HTTP 404 (introuvable) : l’abonnement, le groupe de ressources, le service de recherche ou la ressource de liaison privée partagée sont introuvables. HTTP 409 (conflit) : l’abonnement spécifié est désactivé.

Sécurité

azure_auth

Microsoft Entra ID flux d’autorisation OAuth2.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

SharedPrivateLinkResourceCreateOrUpdate

Exemple de requête

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

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

Exemple de réponse

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

Définitions

Nom Description
CloudError

Contient des informations sur une erreur d’API.

CloudErrorBody

Décrit une erreur d’API particulière avec un code d’erreur et un message.

SharedPrivateLinkResource

Décrit une ressource de Private Link partagée gérée par le service de recherche.

SharedPrivateLinkResourceProperties

Décrit les propriétés d’une ressource de Private Link partagée existante gérée par le service de recherche.

SharedPrivateLinkResourceProvisioningState

État d’approvisionnement de la ressource de liaison privée partagée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussi ou Incomplet.

SharedPrivateLinkResourceStatus

État de la ressource de liaison privée partagée. Les valeurs valides sont Pending, Approved, Rejected ou Disconnected.

CloudError

Contient des informations sur une erreur d’API.

Nom Type Description
error

CloudErrorBody

Décrit une erreur d’API particulière avec un code d’erreur et un message.

CloudErrorBody

Décrit une erreur d’API particulière avec un code d’erreur et un message.

Nom Type Description
code

string

Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code status HTTP. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.

details

CloudErrorBody[]

Contient des erreurs imbriquées liées à cette erreur.

message

string

Message qui décrit l’erreur en détail et fournit des informations de débogage.

target

string

Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur).

SharedPrivateLinkResource

Décrit une ressource de Private Link partagée gérée par le service de recherche.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nom de la ressource.

properties

SharedPrivateLinkResourceProperties

Décrit les propriétés d’une ressource de Private Link partagée gérée par le service de recherche.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SharedPrivateLinkResourceProperties

Décrit les propriétés d’une ressource de Private Link partagée existante gérée par le service de recherche.

Nom Type Description
groupId

string

ID de groupe du fournisseur de la ressource pour laquelle la ressource de liaison privée partagée est destinée.

privateLinkResourceId

string

ID de ressource de la ressource pour laquelle la ressource de liaison privée partagée est destinée.

provisioningState

SharedPrivateLinkResourceProvisioningState

État d’approvisionnement de la ressource de liaison privée partagée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussi ou Incomplet.

requestMessage

string

Message de demande d’approbation de la ressource de liaison privée partagée.

resourceRegion

string

facultatif. Peut être utilisé pour spécifier l’emplacement azure Resource Manager de la ressource vers laquelle une liaison privée partagée doit être créée. Cela est nécessaire uniquement pour les ressources dont la configuration DNS est régionale (par exemple, Azure Kubernetes Service).

status

SharedPrivateLinkResourceStatus

État de la ressource de liaison privée partagée. Les valeurs valides sont Pending, Approved, Rejected ou Disconnected.

SharedPrivateLinkResourceProvisioningState

État d’approvisionnement de la ressource de liaison privée partagée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussi ou Incomplet.

Nom Type Description
Deleting

string

Failed

string

Incomplete

string

Succeeded

string

Updating

string

SharedPrivateLinkResourceStatus

État de la ressource de liaison privée partagée. Les valeurs valides sont Pending, Approved, Rejected ou Disconnected.

Nom Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string