Shared Private Link Resources - List By Service

Ruft eine Liste aller freigegebenen privaten Linkressourcen ab, die vom angegebenen Dienst verwaltet werden.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

searchServiceName
path True

string

Der Name des Suchdiensts, der der angegebenen Ressourcengruppe zugeordnet ist.

subscriptionId
path True

string

Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Sie können diesen Wert über die Azure Resource Manager-API, Befehlszeilentools oder das Portal abrufen.

api-version
query True

string

Die API-Version, die für jede Anforderung verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-request-id

string

uuid

Ein vom Client generierter GUID-Wert zur Identifizierung dieser Anforderung. Falls angegeben, wird dies in die Antwortinformationen aufgenommen, um die Anforderung nachzuverfolgen.

Antworten

Name Typ Beschreibung
200 OK

SharedPrivateLinkResourceListResult

Der Vorgang wurde erfolgreich ausgeführt. Die Antwort enthält die Liste aller freigegebenen privaten Linkressourcen, die vom angegebenen Dienst verwaltet werden.

Other Status Codes

CloudError

Während des Vorgangs ist ein unerwarteter Fehler aufgetreten.

Sicherheit

azure_auth

Microsoft Entra ID OAuth2-Autorisierungsflow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ListSharedPrivateLinkResourcesByService

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
CloudError

Enthält Informationen zu einem API-Fehler.

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

SharedPrivateLinkResource

Beschreibt eine freigegebene Private Link-Ressource, die vom Suchdienst verwaltet wird.

SharedPrivateLinkResourceListResult

Antwort, die eine Liste mit freigegebenen Private Link Ressourcen enthält.

SharedPrivateLinkResourceProperties

Beschreibt die Eigenschaften einer vorhandenen shared Private Link Ressource, die vom Suchdienst verwaltet wird.

SharedPrivateLinkResourceProvisioningState

Der Bereitstellungsstatus der freigegebenen privaten Linkressource. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig.

SharedPrivateLinkResourceStatus

Status der freigegebenen Private Link-Ressource. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.

CloudError

Enthält Informationen zu einem API-Fehler.

Name Typ Beschreibung
error

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name Typ Beschreibung
code

string

Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-status Code. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.

details

CloudErrorBody[]

Enthält geschachtelte Fehler, die sich auf diesen Fehler beziehen.

message

string

Eine Meldung, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt.

target

string

Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

SharedPrivateLinkResource

Beschreibt eine freigegebene Private Link-Ressource, die vom Suchdienst verwaltet wird.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Der Name der Ressource

properties

SharedPrivateLinkResourceProperties

Beschreibt die Eigenschaften einer freigegebenen Private Link Ressource, die vom Suchdienst verwaltet wird.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceListResult

Antwort, die eine Liste mit freigegebenen Private Link Ressourcen enthält.

Name Typ Beschreibung
nextLink

string

Die URL, um den nächsten Satz freigegebener privater Linkressourcen abzurufen, falls vorhanden.

value

SharedPrivateLinkResource[]

Die Liste der freigegebenen Private Link Ressourcen.

SharedPrivateLinkResourceProperties

Beschreibt die Eigenschaften einer vorhandenen shared Private Link Ressource, die vom Suchdienst verwaltet wird.

Name Typ Beschreibung
groupId

string

Die Gruppen-ID des Ressourcenanbieters, für den die freigegebene Private Link-Ressource verwendet wird.

privateLinkResourceId

string

Die Ressourcen-ID der Ressource, für die die freigegebene Private Link-Ressource verwendet wird.

provisioningState

SharedPrivateLinkResourceProvisioningState

Der Bereitstellungsstatus der freigegebenen privaten Linkressource. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig.

requestMessage

string

Die Anforderungsnachricht zum Anfordern der Genehmigung der freigegebenen privaten Linkressource.

resourceRegion

string

Optional. Kann verwendet werden, um den Azure-Resource Manager Speicherort der Ressource anzugeben, zu der ein freigegebener privater Link erstellt werden soll. Dies ist nur für ressourcen erforderlich, deren DNS-Konfiguration regional ist (z. B. Azure Kubernetes Service).

status

SharedPrivateLinkResourceStatus

Status der freigegebenen Private Link-Ressource. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.

SharedPrivateLinkResourceProvisioningState

Der Bereitstellungsstatus der freigegebenen privaten Linkressource. Gültige Werte sind Aktualisieren, Löschen, Fehler, Erfolgreich oder Unvollständig.

Name Typ Beschreibung
Deleting

string

Failed

string

Incomplete

string

Succeeded

string

Updating

string

SharedPrivateLinkResourceStatus

Status der freigegebenen Private Link-Ressource. Gültige Werte sind Ausstehend, Genehmigt, Abgelehnt oder Getrennt.

Name Typ Beschreibung
Approved

string

Disconnected

string

Pending

string

Rejected

string