Partner Namespaces - List By Subscription

Dienst:

Event Grid

API-Version:

2025-02-15

Auflisten von Partnernamespaces unter einem Azure-Abonnement.
Listet alle Partnernamespaces unter einem Azure-Abonnement auf.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerNamespaces?api-version=2025-02-15

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerNamespaces?api-version=2025-02-15&$filter={$filter}&$top={$top}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll.
$filter	query		string	Die Abfrage zum Filtern der Suchergebnisse mithilfe der OData-Syntax. Filterung ist nur für die Eigenschaft "name" und mit begrenzter Anzahl von OData-Vorgängen zulässig. Diese Vorgänge sind: die Funktion "contains" sowie die folgenden logischen Vorgänge: not, and, and, or, eq (for equal) and ne (for not equal). Es werden keine arithmetischen Vorgänge unterstützt. Es folgt ein gültiges Filterbeispiel: $filter=contains(namE, 'PATTERN') und name ne 'PATTERN-1'. Es folgt kein gültiges Filterbeispiel: $filter=location eq 'westus'.
$top	query		integer (int32)	Die Anzahl der Ergebnisse, die pro Seite für den Listenvorgang zurückgegeben werden sollen. Der gültige Bereich für den oberen Parameter beträgt 1 bis 100. Wenn nicht angegeben, beträgt die Standardanzahl der zurückgegebenen Ergebnisse 20 Elemente pro Seite.

Antworten

Name	Typ	Beschreibung
200 OK	PartnerNamespacesListResult	OKAY
Other Status Codes	ErrorResponse	Fehlerantwort, die zurückgegeben wurde, wenn die Anforderung nicht erfolgreich war.

Beispiele

PartnerNamespaces_ListBySubscription

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/partnerNamespaces?api-version=2025-02-15

Java

/**
 * Samples for PartnerNamespaces List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/
     * PartnerNamespaces_ListBySubscription.json
     */
    /**
     * Sample code: PartnerNamespaces_ListBySubscription.
     * 
     * @param manager Entry point to EventGridManager.
     */
    public static void
        partnerNamespacesListBySubscription(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.partnerNamespaces().list(null, null, 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python partner_namespaces_list_by_subscription.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 = EventGridManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.partner_namespaces.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/PartnerNamespaces_ListBySubscription.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

Go

package armeventgrid_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/PartnerNamespaces_ListBySubscription.json
func ExamplePartnerNamespacesClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPartnerNamespacesClient().NewListBySubscriptionPager(&armeventgrid.PartnerNamespacesClientListBySubscriptionOptions{Filter: nil,
		Top: 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.PartnerNamespacesListResult = armeventgrid.PartnerNamespacesListResult{
		// 	Value: []*armeventgrid.PartnerNamespace{
		// 		{
		// 			Name: to.Ptr("partnerNamespace123"),
		// 			Type: to.Ptr("Microsoft.EventGrid/partnerNamespaces"),
		// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerNamespaces/partnerNamespace123"),
		// 			Location: to.Ptr("Central US EUAP"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 				"key2": to.Ptr("value2"),
		// 				"key3": to.Ptr("value3"),
		// 			},
		// 			Properties: &armeventgrid.PartnerNamespaceProperties{
		// 				Endpoint: to.Ptr("https://partnernamespace123.centraluseuap-1.eventgrid.azure.net/api/events"),
		// 				PartnerRegistrationFullyQualifiedID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1"),
		// 				ProvisioningState: to.Ptr(armeventgrid.PartnerNamespaceProvisioningStateSucceeded),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

const { EventGridManagementClient } = require("@azure/arm-eventgrid");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to List all the partner namespaces under an Azure subscription.
 *
 * @summary List all the partner namespaces under an Azure subscription.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/PartnerNamespaces_ListBySubscription.json
 */
async function partnerNamespacesListBySubscription() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.partnerNamespaces.listBySubscription()) {
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.EventGrid;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/PartnerNamespaces_ListBySubscription.json
// this example is just showing the usage of "PartnerNamespaces_ListBySubscription" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (PartnerNamespaceResource item in subscriptionResource.GetPartnerNamespacesAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    PartnerNamespaceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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": {
        "provisioningState": "Succeeded",
        "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1",
        "endpoint": "https://partnernamespace123.centraluseuap-1.eventgrid.azure.net/api/events"
      },
      "location": "Central US EUAP",
      "tags": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
      },
      "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerNamespaces/partnerNamespace123",
      "name": "partnerNamespace123",
      "type": "Microsoft.EventGrid/partnerNamespaces"
    }
  ]
}

Definitionen

Name	Beschreibung
ConnectionState	ConnectionState-Informationen.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
InboundIpRule
IpActionType	Aktion, die basierend auf der Übereinstimmung oder ohne Übereinstimmung der IpMask ausgeführt werden soll.
PartnerNamespace	EventGrid-Partnernamespace.
PartnerNamespaceProvisioningState	Bereitstellungsstatus des Partnernamespaces.
PartnerNamespacesListResult	Ergebnis des Vorgangs "Partnernamespaces auflisten"
PartnerTopicRoutingMode	Dadurch wird ermittelt, ob ereignisse, die in diesem Partnernamespace veröffentlicht wurden, das Quellattribute in der Ereignisnutzlast verwenden oder den Kanalnamen im Header verwenden sollen, wenn sie mit dem Partnerthema übereinstimmen. Wenn keines angegeben ist, wird das Quellattributerouting verwendet, um dem Partnerthema zu entsprechen.
PersistedConnectionStatus	Status der Verbindung.
PrivateEndpoint	PrivateEndpoint-Informationen.
PrivateEndpointConnection
PublicNetworkAccess	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert. Sie können auf bestimmte IPs weiter einschränken, indem Sie konfigurieren
ResourceProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TlsVersion	Minimale TLS-Version des Herausgebers, die in dieser Domäne veröffentlicht werden darf

ConnectionState

Objekt

ConnectionState-Informationen.

Name	Typ	Beschreibung
actionsRequired	string	Erforderliche Aktionen (falls vorhanden).
description	string	Beschreibung des Verbindungszustands.
status	PersistedConnectionStatus	Status der Verbindung.

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.

InboundIpRule

Objekt

Name	Typ	Beschreibung
action	IpActionType	Aktion, die basierend auf der Übereinstimmung oder ohne Übereinstimmung der IpMask ausgeführt werden soll.
ipMask	string	IP-Adresse in CIDR-Notation z. B. 10.0.0.0/8.

IpActionType

Enumeration

Aktion, die basierend auf der Übereinstimmung oder ohne Übereinstimmung der IpMask ausgeführt werden soll.

Wert	Beschreibung
Allow

PartnerNamespace

Objekt

EventGrid-Partnernamespace.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierter Bezeichner der Ressource.
location	string		Speicherort der Ressource.
name	string		Name der Ressource.
properties.disableLocalAuth	boolean	False	Dieser boolesche Wert wird verwendet, um die lokale Authentifizierung zu aktivieren oder zu deaktivieren. Der Standardwert ist "false". Wenn die Eigenschaft auf "true" festgelegt ist, wird nur ein AAD-Token verwendet, um sich zu authentifizieren, wenn der Benutzer im Partnernamespace veröffentlichen darf.
properties.endpoint	string		Endpunkt für den Partnernamespace.
properties.inboundIpRules	InboundIpRule[]		Dies kann verwendet werden, um den Datenverkehr von bestimmten IPs anstelle aller IPs einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist.
properties.minimumTlsVersionAllowed	TlsVersion		Minimale TLS-Version des Herausgebers, die in diesem Partnernamespace veröffentlicht werden darf
properties.partnerRegistrationFullyQualifiedId	string		Die vollqualifizierte ARM-ID der Partnerregistrierung, die diesem Partnernamespace zugeordnet werden soll. Dies hat das folgende Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Dadurch wird ermittelt, ob ereignisse, die in diesem Partnernamespace veröffentlicht wurden, das Quellattribute in der Ereignisnutzlast verwenden oder den Kanalnamen im Header verwenden sollen, wenn sie mit dem Partnerthema übereinstimmen. Wenn keines angegeben ist, wird das Quellattributerouting verwendet, um dem Partnerthema zu entsprechen.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste der privaten Endpunktverbindungen.
properties.provisioningState	PartnerNamespaceProvisioningState		Bereitstellungsstatus des Partnernamespaces.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert. Sie können auf bestimmte IPs weiter einschränken, indem Sie konfigurieren
systemData	systemData		Die Systemmetadaten, die sich auf die Event Grid-Ressource beziehen.
tags	object		Tags der Ressource.
type	string		Typ der Ressource.

PartnerNamespaceProvisioningState

Enumeration

Bereitstellungsstatus des Partnernamespaces.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
Succeeded
Updating

PartnerNamespacesListResult

Objekt

Ergebnis des Vorgangs "Partnernamespaces auflisten"

Name	Typ	Beschreibung
nextLink	string	Ein Link für die nächste Seite von Partnernamespaces.
value	PartnerNamespace[]	Eine Sammlung von Partnernamespaces.

PartnerTopicRoutingMode

Enumeration

Dadurch wird ermittelt, ob ereignisse, die in diesem Partnernamespace veröffentlicht wurden, das Quellattribute in der Ereignisnutzlast verwenden oder den Kanalnamen im Header verwenden sollen, wenn sie mit dem Partnerthema übereinstimmen. Wenn keines angegeben ist, wird das Quellattributerouting verwendet, um dem Partnerthema zu entsprechen.

Wert	Beschreibung
ChannelNameHeader
SourceEventAttribute

PersistedConnectionStatus

Enumeration

Status der Verbindung.

Wert	Beschreibung
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Objekt

PrivateEndpoint-Informationen.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für private Endpunkte.

PrivateEndpointConnection

Objekt

Name	Typ	Beschreibung
id	string	Vollqualifizierter Bezeichner der Ressource.
name	string	Name der Ressource.
properties.groupIds	string[]	GroupIds aus der Ressource für den privaten Linkdienst.
properties.privateEndpoint	PrivateEndpoint	Die Private Endpoint-Ressource für diese Verbindung.
properties.privateLinkServiceConnectionState	ConnectionState	Details zum Status der Verbindung.
properties.provisioningState	ResourceProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
type	string	Typ der Ressource.

PublicNetworkAccess

Enumeration

Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert. Sie können auf bestimmte IPs weiter einschränken, indem Sie konfigurieren

Wert	Beschreibung
Disabled
Enabled

ResourceProvisioningState

Enumeration

Bereitstellungsstatus der privaten Endpunktverbindung.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
Succeeded
Updating

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.

TlsVersion

Enumeration

Minimale TLS-Version des Herausgebers, die in dieser Domäne veröffentlicht werden darf

Wert	Beschreibung
1.0
1.1
1.2