Web Pub Sub Private Link Resources - List

Referenz

Dienst:: Azure Web PubSub Service

API-Version:: 2024-03-01

Rufen Sie die privaten Linkressourcen ab, die für eine Ressource erstellt werden müssen.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources?api-version=2024-03-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$	Der Name der Ressource.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateLinkResourceList	Erfolg. Die Antwort beschreibt eine Liste privater Linkressourcen.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

WebPubSubPrivateLinkResources_List

Beispielanforderung

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/webPubSub/myWebPubSubService/privateLinkResources?api-version=2024-03-01


/**
 * Samples for WebPubSubPrivateLinkResources List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/
     * WebPubSubPrivateLinkResources_List.json
     */
    /**
     * Sample code: WebPubSubPrivateLinkResources_List.
     * 
     * @param manager Entry point to WebPubSubManager.
     */
    public static void webPubSubPrivateLinkResourcesList(com.azure.resourcemanager.webpubsub.WebPubSubManager manager) {
        manager.webPubSubPrivateLinkResources().list("myResourceGroup", "myWebPubSubService",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.webpubsub import WebPubSubManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-webpubsub
# USAGE
    python web_pub_sub_private_link_resources_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebPubSubManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.web_pub_sub_private_link_resources.list(
        resource_group_name="myResourceGroup",
        resource_name="myWebPubSubService",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSubPrivateLinkResources_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armwebpubsub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/webpubsub/armwebpubsub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7189fb57f69468c56df76f9a4d68dd9ff04ab100/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSubPrivateLinkResources_List.json
func ExamplePrivateLinkResourcesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armwebpubsub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateLinkResourcesClient().NewListPager("myResourceGroup", "myWebPubSubService", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateLinkResourceList = armwebpubsub.PrivateLinkResourceList{
		// 	Value: []*armwebpubsub.PrivateLinkResource{
		// 		{
		// 			Name: to.Ptr("myPrivateLink"),
		// 			Type: to.Ptr("privateLinkResources"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateLinkResources/myPrivateLink"),
		// 			Properties: &armwebpubsub.PrivateLinkResourceProperties{
		// 				GroupID: to.Ptr("webpubsub"),
		// 				RequiredMembers: []*string{
		// 					to.Ptr("webpubsub")},
		// 					RequiredZoneNames: []*string{
		// 						to.Ptr("privatelink.webpubsub.azure.com")},
		// 						ShareablePrivateLinkResourceTypes: []*armwebpubsub.ShareablePrivateLinkResourceType{
		// 							{
		// 								Name: to.Ptr("site"),
		// 								Properties: &armwebpubsub.ShareablePrivateLinkResourceProperties{
		// 									Type: to.Ptr("Microsoft.Web/sites"),
		// 									Description: to.Ptr("Azure App Service can be used as an upstream"),
		// 									GroupID: to.Ptr("sites"),
		// 								},
		// 							},
		// 							{
		// 								Name: to.Ptr("vault"),
		// 								Properties: &armwebpubsub.ShareablePrivateLinkResourceProperties{
		// 									Type: to.Ptr("Microsoft.KeyVault/vaults"),
		// 									Description: to.Ptr("Azure Key Vault can be used as credentials store"),
		// 									GroupID: to.Ptr("vault"),
		// 								},
		// 							},
		// 							{
		// 								Name: to.Ptr("table"),
		// 								Properties: &armwebpubsub.ShareablePrivateLinkResourceProperties{
		// 									Type: to.Ptr("Microsoft.Storage/storageAccounts"),
		// 									Description: to.Ptr("Azure Storage Table can be used as message store"),
		// 									GroupID: to.Ptr("table"),
		// 								},
		// 						}},
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { WebPubSubManagementClient } = require("@azure/arm-webpubsub");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the private link resources that need to be created for a resource.
 *
 * @summary Get the private link resources that need to be created for a resource.
 * x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSubPrivateLinkResources_List.json
 */
async function webPubSubPrivateLinkResourcesList() {
  const subscriptionId =
    process.env["WEB-PUBSUB_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["WEB-PUBSUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "myWebPubSubService";
  const credential = new DefaultAzureCredential();
  const client = new WebPubSubManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.webPubSubPrivateLinkResources.list(
    resourceGroupName,
    resourceName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "properties": {
        "groupId": "webpubsub",
        "requiredMembers": [
          "webpubsub"
        ],
        "requiredZoneNames": [
          "privatelink.webpubsub.azure.com"
        ],
        "shareablePrivateLinkResourceTypes": [
          {
            "name": "site",
            "properties": {
              "description": "Azure App Service can be used as an upstream",
              "groupId": "sites",
              "type": "Microsoft.Web/sites"
            }
          },
          {
            "name": "vault",
            "properties": {
              "description": "Azure Key Vault can be used as credentials store",
              "groupId": "vault",
              "type": "Microsoft.KeyVault/vaults"
            }
          },
          {
            "name": "table",
            "properties": {
              "description": "Azure Storage Table can be used as message store",
              "groupId": "table",
              "type": "Microsoft.Storage/storageAccounts"
            }
          }
        ]
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateLinkResources/myPrivateLink",
      "name": "myPrivateLink",
      "type": "privateLinkResources"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..."
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
PrivateLinkResource	Private Link-Ressource
PrivateLinkResourceList	Enthält eine Liste von PrivateLinkResource und einen möglichen Link zum Abfragen weiterer Ergebnisse
ShareablePrivateLinkResourceProperties	Beschreibt die Eigenschaften eines Ressourcentyps, der in den privaten Linkdienst integriert wurde.
ShareablePrivateLinkResourceType	Beschreibt einen Ressourcentyp, der in den privaten Linkdienst integriert wurde.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PrivateLinkResource

Objekt

Private Link-Ressource

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.groupId	string	Gruppen-ID der Ressource für private Verknüpfungen
properties.requiredMembers	string[]	Erforderliche Member der Ressource für private Verknüpfungen
properties.requiredZoneNames	string[]	Erforderliche private DNS-Zonennamen
properties.shareablePrivateLinkResourceTypes	ShareablePrivateLinkResourceType[]	Die Liste der Ressourcen, die in den privaten Linkdienst integriert sind
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateLinkResourceList

Objekt

Enthält eine Liste von PrivateLinkResource und einen möglichen Link zum Abfragen weiterer Ergebnisse

Name	Typ	Beschreibung
nextLink	string	Die URL, die der Client zum Abrufen der nächsten Seite (pro serverseitigem Paging) verwenden soll. Es ist null für jetzt, für die zukünftige Verwendung hinzugefügt.
value	PrivateLinkResource[]	Liste der PrivateLinkResource

ShareablePrivateLinkResourceProperties

Objekt

Beschreibt die Eigenschaften eines Ressourcentyps, der in den privaten Linkdienst integriert wurde.

Name	Typ	Beschreibung
description	string	Die Beschreibung des Ressourcentyps, der in den privaten Linkdienst integriert wurde
groupId	string	Die Gruppen-ID des Ressourcenanbieters für die Ressource, die in den privaten Linkdienst integriert wurde
type	string	Der Ressourcenanbietertyp für die Ressource, die in den privaten Linkdienst integriert wurde

ShareablePrivateLinkResourceType

Objekt

Beschreibt einen Ressourcentyp, der in den privaten Linkdienst integriert wurde.

Name	Typ	Beschreibung
name	string	Der Name des Ressourcentyps, der in den privaten Linkdienst integriert wurde
properties	ShareablePrivateLinkResourceProperties	Beschreibt die Eigenschaften eines Ressourcentyps, der in den privaten Linkdienst integriert wurde.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Web Pub Sub Private Link Resources - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

WebPubSubPrivateLinkResources_List

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PrivateLinkResource

PrivateLinkResourceList

ShareablePrivateLinkResourceProperties

ShareablePrivateLinkResourceType

systemData