Partner Namespaces - List By Subscription

Service:

Event Grid

API Version:

2022-06-15

Elencare gli spazi dei nomi dei partner in una sottoscrizione di Azure.
Elencare tutti gli spazi dei nomi partner in una sottoscrizione di Azure.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco una sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.
$filter	query		string	Query usata per filtrare i risultati della ricerca usando la sintassi OData. Il filtro è consentito solo nella proprietà 'name' e con un numero limitato di operazioni OData. Queste operazioni sono: la funzione 'contiene' e le operazioni logiche seguenti: non, eq (per uguale) e ne (per non uguale). Non sono supportate operazioni aritmetiche. Di seguito è riportato un esempio di filtro valido: $filter=contains(namE, 'PATTERN') e nome ne 'PATTERN-1'. Di seguito non è riportato un esempio di filtro valido: $filter=location eq 'westus'.
$top	query		integer int32	Numero di risultati da restituire per pagina per l'operazione di elenco. Intervallo valido per il parametro principale è da 1 a 100. Se non specificato, il numero predefinito di risultati da restituire è 20 elementi per pagina.

Risposte

Nome	Tipo	Descrizione
200 OK	PartnerNamespacesListResult	OK
Other Status Codes		Risposte agli errori: ** 400 Richiesta non valida. 500 - Errore interno del server.

Esempio

PartnerNamespaces_ListBySubscription

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for PartnerNamespaces List. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-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, 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/2022-06-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/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-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");

/**
 * 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/2022-06-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 (let 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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.EventGrid;
using Azure.ResourceManager.EventGrid.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-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

Sample Response

Status code:

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

Definizioni

Nome	Descrizione
ConnectionState	Informazioni di ConnectionState.
createdByType	Tipo di identità che ha creato la risorsa.
InboundIpRule
IpActionType	Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask.
PartnerNamespace	Spazio dei nomi partner EventGrid.
PartnerNamespaceProvisioningState	Stato di provisioning dello spazio dei nomi partner.
PartnerNamespacesListResult	Risultato dell'operazione List Partner Namespaces
PartnerTopicRoutingMode	Ciò determina se gli eventi pubblicati in questo spazio dei nomi partner devono usare l'attributo di origine nel payload dell'evento o usare il nome del canale nell'intestazione quando corrisponde all'argomento partner. Se non è specificato alcun elemento, il routing degli attributi di origine verrà usato per corrispondere all'argomento partner.
PersistedConnectionStatus	Stato della connessione.
PrivateEndpoint	Informazioni privateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli INDIRIZZI IP specifici configurando
ResourceProvisioningState	Stato di provisioning della connessione endpoint privato.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

ConnectionState

Informazioni di ConnectionState.

Nome	Tipo	Descrizione
actionsRequired	string	Azioni necessarie (se presenti).
description	string	Descrizione dello stato della connessione.
status	PersistedConnectionStatus	Stato della connessione.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Nome	Tipo	Descrizione
action	IpActionType	Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask.
ipMask	string	Indirizzo IP nella notazione CIDR, ad esempio 10.0.0.0.0/8.

IpActionType

Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask.

Nome	Tipo	Descrizione
Allow	string

PartnerNamespace

Spazio dei nomi partner EventGrid.

Nome	Tipo	Valore predefinito	Descrizione
id	string		Identificatore completo della risorsa.
location	string		Posizione della risorsa.
name	string		Nome della risorsa.
properties.disableLocalAuth	boolean	False	Questo valore booleano viene usato per abilitare o disabilitare l'autenticazione locale. Il valore predefinito è false. Quando la proprietà è impostata su true, verrà usato solo il token AAD per l'autenticazione se l'utente può pubblicare nello spazio dei nomi partner.
properties.endpoint	string		Endpoint per lo spazio dei nomi partner.
properties.inboundIpRules	InboundIpRule[]		Questa operazione può essere usata per limitare il traffico da indirizzi IP specifici anziché da tutti gli INDIRIZZI IP. Nota: questi vengono considerati solo se PublicNetworkAccess è abilitato.
properties.partnerRegistrationFullyQualifiedId	string		ID arm completo della registrazione partner che deve essere associato a questo spazio dei nomi partner. In questo modo si accetta il formato seguente: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Ciò determina se gli eventi pubblicati in questo spazio dei nomi partner devono usare l'attributo di origine nel payload dell'evento o usare il nome del canale nell'intestazione quando corrisponde all'argomento partner. Se non è specificato alcun elemento, il routing degli attributi di origine verrà usato per corrispondere all'argomento partner.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		Stato di provisioning dello spazio dei nomi partner.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli INDIRIZZI IP specifici configurando
systemData	systemData		Metadati di sistema relativi alla risorsa spazio dei nomi partner.
tags	object		Tag della risorsa.
type	string		Tipo di risorsa.

PartnerNamespaceProvisioningState

Stato di provisioning dello spazio dei nomi partner.

Nome	Tipo	Descrizione
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerNamespacesListResult

Risultato dell'operazione List Partner Namespaces

Nome	Tipo	Descrizione
nextLink	string	Collegamento per la pagina successiva degli spazi dei nomi partner.
value	PartnerNamespace[]	Raccolta di spazi dei nomi partner.

PartnerTopicRoutingMode

Ciò determina se gli eventi pubblicati in questo spazio dei nomi partner devono usare l'attributo di origine nel payload dell'evento o usare il nome del canale nell'intestazione quando corrisponde all'argomento partner. Se non è specificato alcun elemento, il routing degli attributi di origine verrà usato per corrispondere all'argomento partner.

Nome	Tipo	Descrizione
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

Stato della connessione.

Nome	Tipo	Descrizione
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

Informazioni privateEndpoint.

Nome	Tipo	Descrizione
id	string	Identificatore arm per endpoint privato.

PrivateEndpointConnection

Nome	Tipo	Descrizione
id	string	Identificatore completo della risorsa.
name	string	Nome della risorsa.
properties.groupIds	string[]	GroupIds dalla risorsa del servizio di collegamento privato.
properties.privateEndpoint	PrivateEndpoint	Risorsa endpoint privato per questa connessione.
properties.privateLinkServiceConnectionState	ConnectionState	Dettagli sullo stato della connessione.
properties.provisioningState	ResourceProvisioningState	Stato di provisioning della connessione endpoint privato.
type	string	Tipo di risorsa.

PublicNetworkAccess

Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli INDIRIZZI IP specifici configurando

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

ResourceProvisioningState

Stato di provisioning della connessione endpoint privato.

Nome	Tipo	Descrizione
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.