Shared Private Link Resources - Get
Obtient les détails de la ressource de liaison privée partagée gérée par le service de recherche dans le groupe de ressources donné.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2024-03-01-preview
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
resource
|
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. |
search
|
path | True |
string |
Nom du service Search Azure AI associé au groupe de ressources spécifié. Modèle d’expression régulière: |
shared
|
path | True |
string |
Nom de la ressource de liaison privée partagée gérée par l’service Search Azure AI au sein du groupe de ressources spécifié. |
subscription
|
path | True |
string |
Identificateur unique d’un abonnement Microsoft Azure. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager 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. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
La définition de la ressource de liaison privée partagée a été récupérée avec succès et figure dans la réponse. |
|
Other Status Codes |
HTTP 404 (introuvable) : l’abonnement, le groupe de ressources, le service de recherche ou la ressource de liaison privée partagée sont introuvables. |
Sécurité
azure_auth
Spécifie un flux d’octroi implicite, tel que pris en charge sur la plateforme Microsoft Identity.
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
SharedPrivateLinkResourceGet
Exemple de requête
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2024-03-01-preview
Exemple de réponse
{
"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 |
---|---|
Cloud |
Contient des informations sur une erreur d’API. |
Cloud |
Décrit une erreur d’API particulière avec un code d’erreur et un message. |
Shared |
Décrit une ressource de liaison privée partagée gérée par le service Search Azure AI. |
Shared |
Décrit les propriétés d’une ressource de liaison privée partagée existante gérée par le service Search Azure AI. |
Shared |
État d’approvisionnement de la ressource de liaison privée partagée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussi ou Incomplet. |
Shared |
É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 |
Décrit une erreur d’API particulière avec un code d’erreur et un message. |
|
message |
string |
Une brève description de l’erreur qui indique ce qui s’est passé (pour plus d’informations/informations de débogage, reportez-vous à la propriété « error.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 |
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 liaison privée partagée gérée par le service Search Azure AI.
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 |
Décrit les propriétés d’une ressource de liaison privée partagée gérée par le service Search Azure AI. |
|
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 liaison privée partagée existante gérée par le service Search Azure AI.
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 |
É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 pour laquelle une liaison privée partagée est en cours de création. Cela est nécessaire uniquement pour les ressources dont la configuration DNS est régionale (par exemple, Azure Kubernetes Service). |
status |
É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 |
La ressource de liaison privée partagée est en cours de suppression. |
Failed |
string |
La ressource de liaison privée partagée n’a pas pu être provisionnée ou supprimée. |
Incomplete |
string |
La demande d’approvisionnement pour la ressource de liaison privée partagée a été acceptée, mais le processus de création n’a pas encore commencé. |
Succeeded |
string |
La ressource de liaison privée partagée a terminé l’approvisionnement et est prête pour approbation. |
Updating |
string |
La ressource de liaison privée partagée est en cours de création avec d’autres ressources pour qu’elle soit entièrement fonctionnelle. |
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 |
La ressource de liaison privée partagée est approuvée et prête à être utilisée. |
Disconnected |
string |
La ressource de liaison privée partagée a été supprimée du service. |
Pending |
string |
La ressource de liaison privée partagée a été créée et est en attente d’approbation. |
Rejected |
string |
La ressource de liaison privée partagée a été rejetée et ne peut pas être utilisée. |