Shared Private Link Resources - List By Service

Hämtar en lista över alla delade privata länkresurser som hanteras av den angivna tjänsten.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Namnet på resursgruppen i den aktuella prenumerationen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.

searchServiceName
path True

string

Namnet på söktjänsten som är associerad med den angivna resursgruppen.

subscriptionId
path True

string

Den unika identifieraren för en Microsoft Azure-prenumeration. Du kan hämta det här värdet från Azure Resource Manager API, kommandoradsverktyg eller portalen.

api-version
query True

string

DEN API-version som ska användas för varje begäran.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-request-id

string

uuid

Ett klientgenererat GUID-värde som identifierar den här begäran. Om detta anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran.

Svar

Name Typ Description
200 OK

SharedPrivateLinkResourceListResult

Åtgärden lyckades. Svaret innehåller listan över alla delade privata länkresurser som hanteras av den angivna tjänsten.

Other Status Codes

CloudError

Ett oväntat fel inträffade under åtgärden.

Säkerhet

azure_auth

Microsoft Entra ID OAuth2-auktoriseringsflöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ListSharedPrivateLinkResourcesByService

Exempelbegäran

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

Exempelsvar

{
  "value": [
    {
      "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
      }
    }
  ]
}

Definitioner

Name Description
CloudError

Innehåller information om ett API-fel.

CloudErrorBody

Beskriver ett visst API-fel med en felkod och ett meddelande.

SharedPrivateLinkResource

Beskriver en delad Private Link resurs som hanteras av söktjänsten.

SharedPrivateLinkResourceListResult

Svar som innehåller en lista över delade Private Link resurser.

SharedPrivateLinkResourceProperties

Beskriver egenskaperna för en befintlig delad Private Link resurs som hanteras av söktjänsten.

SharedPrivateLinkResourceProvisioningState

Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.

SharedPrivateLinkResourceStatus

Status för resursen för delad privat länk. Giltiga värden är Väntar, Godkänd, Avvisad eller Frånkopplad.

CloudError

Innehåller information om ett API-fel.

Name Typ Description
error

CloudErrorBody

Beskriver ett visst API-fel med en felkod och ett meddelande.

CloudErrorBody

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name Typ Description
code

string

En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.

details

CloudErrorBody[]

Innehåller kapslade fel som är relaterade till det här felet.

message

string

Ett meddelande som beskriver felet i detalj och innehåller felsökningsinformation.

target

string

Målet för det specifika felet (till exempel namnet på egenskapen i fel).

SharedPrivateLinkResource

Beskriver en delad Private Link resurs som hanteras av söktjänsten.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties

SharedPrivateLinkResourceProperties

Beskriver egenskaperna för en delad Private Link resurs som hanteras av söktjänsten.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceListResult

Svar som innehåller en lista över delade Private Link resurser.

Name Typ Description
nextLink

string

URL:en för att hämta nästa uppsättning delade privata länkresurser, om det finns några.

value

SharedPrivateLinkResource[]

Listan över delade Private Link resurser.

SharedPrivateLinkResourceProperties

Beskriver egenskaperna för en befintlig delad Private Link resurs som hanteras av söktjänsten.

Name Typ Description
groupId

string

Grupp-ID:t från resursprovidern som den delade privata länkresursen är till för.

privateLinkResourceId

string

Resurs-ID:t för resursen som den delade privata länkresursen är för.

provisioningState

SharedPrivateLinkResourceProvisioningState

Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.

requestMessage

string

Begärandemeddelandet för att begära godkännande av resursen för delad privat länk.

resourceRegion

string

Valfritt. Kan användas för att ange azure-Resource Manager plats för resursen som en delad privat länk ska skapas till. Detta krävs endast för de resurser vars DNS-konfiguration är regional (till exempel Azure Kubernetes Service).

status

SharedPrivateLinkResourceStatus

Status för resursen för delad privat länk. Giltiga värden är Väntar, Godkänd, Avvisad eller Frånkopplad.

SharedPrivateLinkResourceProvisioningState

Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.

Name Typ Description
Deleting

string

Failed

string

Incomplete

string

Succeeded

string

Updating

string

SharedPrivateLinkResourceStatus

Status för resursen för delad privat länk. Giltiga värden är Väntar, Godkänd, Avvisad eller Frånkopplad.

Name Typ Description
Approved

string

Disconnected

string

Pending

string

Rejected

string