Partner Namespaces - List By Subscription

Service:

Event Grid

API Version:

2022-06-15

Répertorier les espaces de noms des partenaires sous un abonnement Azure.
Répertoriez tous les espaces de noms partenaires sous un abonnement 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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API à utiliser avec la demande du client.
$filter	query		string	Requête utilisée pour filtrer les résultats de la recherche à l’aide de la syntaxe OData. Le filtrage est autorisé sur la propriété « name » uniquement et avec un nombre limité d’opérations OData. Ces opérations sont : la fonction « contains » ainsi que les opérations logiques suivantes : not, and, ou, eq (pour égal) et ne (pour non égal). Aucune opération arithmétique n’est prise en charge. Voici un exemple de filtre valide : $filter=contains(namE, 'PATTERN') et name ne 'PATTERN-1'. L’exemple de filtre suivant n’est pas valide : $filter=location eq 'westus'.
$top	query		integer int32	Nombre de résultats à retourner par page pour l’opération de liste. La plage valide pour le paramètre supérieur est comprise entre 1 et 100. S’il n’est pas spécifié, le nombre par défaut de résultats à retourner est de 20 éléments par page.

Réponses

Nom	Type	Description
200 OK	PartnerNamespacesListResult	Ok
Other Status Codes		Réponses d’erreur : *** 400 Requête incorrecte. 500 Erreur interne du serveur.

Exemples

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

Définitions

Nom	Description
ConnectionState	Informations ConnectionState.
createdByType	Type d’identité qui a créé la ressource.
InboundIpRule
IpActionType	Action à effectuer en fonction de la correspondance ou de l’absence de correspondance du masque Ip.
PartnerNamespace	Espace de noms de partenaire EventGrid.
PartnerNamespaceProvisioningState	État d’approvisionnement de l’espace de noms du partenaire.
PartnerNamespacesListResult	Résultat de l’opération Répertorier les espaces de noms des partenaires
PartnerTopicRoutingMode	Cela détermine si les événements publiés dans cet espace de noms partenaire doivent utiliser l’attribut source dans la charge utile de l’événement ou utiliser le nom du canal dans l’en-tête lors de la correspondance avec la rubrique partenaire. Si aucun n’est spécifié, le routage des attributs sources est utilisé pour correspondre à la rubrique partenaire.
PersistedConnectionStatus	État de la connexion.
PrivateEndpoint	Informations privateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant
ResourceProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

ConnectionState

Informations ConnectionState.

Nom	Type	Description
actionsRequired	string	Actions requises (le cas échéant).
description	string	Description de l’état de la connexion.
status	PersistedConnectionStatus	État de la connexion.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Nom	Type	Description
action	IpActionType	Action à effectuer en fonction de la correspondance ou de l’absence de correspondance du masque Ip.
ipMask	string	Adresse IP en notation CIDR, par exemple, 10.0.0.0/8.

IpActionType

Action à effectuer en fonction de la correspondance ou de l’absence de correspondance du masque Ip.

Nom	Type	Description
Allow	string

PartnerNamespace

Espace de noms de partenaire EventGrid.

Nom	Type	Valeur par défaut	Description
id	string		Identificateur complet de la ressource.
location	string		Emplacement de la ressource.
name	string		Nom de la ressource.
properties.disableLocalAuth	boolean	False	Cette valeur booléenne est utilisée pour activer ou désactiver l’authentification locale. La valeur par défaut est false. Lorsque la propriété a la valeur true, seul le jeton AAD est utilisé pour s’authentifier si l’utilisateur est autorisé à publier dans l’espace de noms du partenaire.
properties.endpoint	string		Point de terminaison de l’espace de noms du partenaire.
properties.inboundIpRules	InboundIpRule[]		Cela peut être utilisé pour limiter le trafic provenant d’adresses IP spécifiques au lieu de toutes les adresses IP. Remarque : Celles-ci sont prises en compte uniquement si PublicNetworkAccess est activé.
properties.partnerRegistrationFullyQualifiedId	string		ID ARM complet de l’inscription de partenaire qui doit être associée à cet espace de noms partenaire. Le format est le suivant : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Cela détermine si les événements publiés dans cet espace de noms partenaire doivent utiliser l’attribut source dans la charge utile de l’événement ou utiliser le nom du canal dans l’en-tête lors de la correspondance avec la rubrique partenaire. Si aucun n’est spécifié, le routage des attributs sources est utilisé pour correspondre à la rubrique partenaire.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		État d’approvisionnement de l’espace de noms du partenaire.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant
systemData	systemData		Métadonnées système relatives à la ressource Espace de noms partenaire.
tags	object		Étiquettes de la ressource.
type	string		Type de la ressource.

PartnerNamespaceProvisioningState

État d’approvisionnement de l’espace de noms du partenaire.

Nom	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerNamespacesListResult

Résultat de l’opération Répertorier les espaces de noms des partenaires

Nom	Type	Description
nextLink	string	Lien vers la page suivante des espaces de noms partenaires.
value	PartnerNamespace[]	Collection d’espaces de noms partenaires.

PartnerTopicRoutingMode

Cela détermine si les événements publiés dans cet espace de noms partenaire doivent utiliser l’attribut source dans la charge utile de l’événement ou utiliser le nom du canal dans l’en-tête lors de la correspondance avec la rubrique partenaire. Si aucun n’est spécifié, le routage des attributs sources est utilisé pour correspondre à la rubrique partenaire.

Nom	Type	Description
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

État de la connexion.

Nom	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

Informations privateEndpoint.

Nom	Type	Description
id	string	Identificateur ARM pour le point de terminaison privé.

PrivateEndpointConnection

Nom	Type	Description
id	string	Identificateur complet de la ressource.
name	string	Nom de la ressource.
properties.groupIds	string[]	GroupIds de la ressource de service private link.
properties.privateEndpoint	PrivateEndpoint	Ressource de point de terminaison privé pour cette connexion.
properties.privateLinkServiceConnectionState	ConnectionState	Détails sur l’état de la connexion.
properties.provisioningState	ResourceProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
type	string	Type de la ressource.

PublicNetworkAccess

Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant

Nom	Type	Description
Disabled	string
Enabled	string

ResourceProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

Nom	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.