Partner Namespaces - List By Resource Group

Service:

Event Grid

API Version:

2022-06-15

Lista partnernamnområden under en resursgrupp.
Visa en lista över alla partnernamnområden under en resursgrupp.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen i användarens prenumeration.
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar en Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran.
$filter	query		string	Frågan som används för att filtrera sökresultaten med OData-syntax. Filtrering tillåts endast för egenskapen "name" och med ett begränsat antal OData-åtgärder. Dessa åtgärder är: funktionen "contains" samt följande logiska åtgärder: inte, och eller eq (för lika med) och ne (för inte lika med). Inga aritmetiska åtgärder stöds. Följande är ett giltigt filterexempel: $filter=contains(namE, 'PATTERN') och name ne 'PATTERN-1'. Följande är inte ett giltigt filterexempel: $filter=location eq 'westus'.
$top	query		integer int32	Antalet resultat som ska returneras per sida för liståtgärden. Giltigt intervall för den översta parametern är 1 till 100. Om inget anges är standardantalet resultat som ska returneras 20 objekt per sida.

Svar

Name	Typ	Description
200 OK	PartnerNamespacesListResult	OK
Other Status Codes		Felsvar: *** 400 Felaktig begäran. 500 Internt serverfel.

Exempel

PartnerNamespaces_ListByResourceGroup

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for PartnerNamespaces ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_ListByResourceGroup.json
     */
    /**
     * Sample code: PartnerNamespaces_ListByResourceGroup.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void partnerNamespacesListByResourceGroup(
        com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.partnerNamespaces().listByResourceGroup("examplerg", 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_resource_group.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_resource_group(
        resource_group_name="examplerg",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_ListByResourceGroup.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_ListByResourceGroup.json
func ExamplePartnerNamespacesClient_NewListByResourceGroupPager() {
	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().NewListByResourceGroupPager("examplerg", &armeventgrid.PartnerNamespacesClientListByResourceGroupOptions{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/examplerg/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/examplerg/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 a resource group.
 *
 * @summary List all the partner namespaces under a resource group.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_ListByResourceGroup.json
 */
async function partnerNamespacesListByResourceGroup() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.partnerNamespaces.listByResourceGroup(resourceGroupName)) {
    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.Resources;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_ListByResourceGroup.json
// this example is just showing the usage of "PartnerNamespaces_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this PartnerNamespaceResource
PartnerNamespaceCollection collection = resourceGroupResource.GetPartnerNamespaces();

// invoke the operation and iterate over the result
await foreach (PartnerNamespaceResource item in collection.GetAllAsync())
{
    // 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/examplerg/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/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/partnerNamespace123",
      "name": "partnerNamespace123",
      "type": "Microsoft.EventGrid/partnerNamespaces"
    }
  ]
}

Definitioner

Name	Description
ConnectionState	ConnectionState-information.
createdByType	Den typ av identitet som skapade resursen.
InboundIpRule
IpActionType	Åtgärd som ska utföras baserat på matchningen eller ingen matchning för IpMask.
PartnerNamespace	EventGrid Partner Namespace.
PartnerNamespaceProvisioningState	Etableringstillstånd för partnernamnområdet.
PartnerNamespacesListResult	Resultatet av åtgärden List Partner Namespaces (Lista partnernamnområden)
PartnerTopicRoutingMode	Detta avgör om händelser som publicerats till det här partnernamnområdet ska använda källattributet i händelsenyttolasten eller använda kanalnamnet i rubriken vid matchning till partnerämnet. Om ingen anges används routning av källattribut för att matcha partnerämnet.
PersistedConnectionStatus	Status för anslutningen.
PrivateEndpoint	PrivateEndpoint-information.
PrivateEndpointConnection
PublicNetworkAccess	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
ResourceProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
systemData	Metadata som rör skapande och senaste ändring av resursen.

ConnectionState

ConnectionState-information.

Name	Typ	Description
actionsRequired	string	Åtgärder som krävs (om det finns några).
description	string	Beskrivning av anslutningstillståndet.
status	PersistedConnectionStatus	Status för anslutningen.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Name	Typ	Description
action	IpActionType	Åtgärd som ska utföras baserat på matchningen eller ingen matchning för IpMask.
ipMask	string	IP-adress i CIDR-notation, t.ex. 10.0.0.0/8.

IpActionType

Åtgärd som ska utföras baserat på matchningen eller ingen matchning för IpMask.

Name	Typ	Description
Allow	string

PartnerNamespace

EventGrid Partner Namespace.

Name	Typ	Standardvärde	Description
id	string		Fullständigt kvalificerad identifierare för resursen.
location	string		Platsen för resursen.
name	string		Namn på resursen.
properties.disableLocalAuth	boolean	False	Det här booleska värdet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är false. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till partnernamnområdet.
properties.endpoint	string		Slutpunkt för partnernamnområdet.
properties.inboundIpRules	InboundIpRule[]		Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa beaktas endast om PublicNetworkAccess är aktiverat.
properties.partnerRegistrationFullyQualifiedId	string		Det fullständigt kvalificerade ARM-ID:t för partnerregistreringen som ska associeras med det här partnernamnområdet. Detta har följande format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Detta avgör om händelser som publicerats till det här partnernamnområdet ska använda källattributet i händelsenyttolasten eller använda kanalnamnet i rubriken vid matchning till partnerämnet. Om ingen anges används routning av källattribut för att matcha partnerämnet.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		Etableringstillstånd för partnernamnområdet.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
systemData	systemData		Systemmetadata som relaterar till resursen partnernamnområde.
tags	object		Taggar för resursen.
type	string		Typ av resurs.

PartnerNamespaceProvisioningState

Etableringstillstånd för partnernamnområdet.

Name	Typ	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerNamespacesListResult

Resultatet av åtgärden List Partner Namespaces (Lista partnernamnområden)

Name	Typ	Description
nextLink	string	En länk till nästa sida i partnernamnområden.
value	PartnerNamespace[]	En samling partnernamnområden.

PartnerTopicRoutingMode

Detta avgör om händelser som publicerats till det här partnernamnområdet ska använda källattributet i händelsenyttolasten eller använda kanalnamnet i rubriken vid matchning till partnerämnet. Om ingen anges används routning av källattribut för att matcha partnerämnet.

Name	Typ	Description
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

Status för anslutningen.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint-information.

Name	Typ	Description
id	string	ARM-identifieraren för privat slutpunkt.

PrivateEndpointConnection

Name	Typ	Description
id	string	Fullständigt kvalificerad identifierare för resursen.
name	string	Namn på resursen.
properties.groupIds	string[]	GroupIds från private link-tjänstresursen.
properties.privateEndpoint	PrivateEndpoint	Den privata slutpunktsresursen för den här anslutningen.
properties.privateLinkServiceConnectionState	ConnectionState	Information om anslutningens tillstånd.
properties.provisioningState	ResourceProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
type	string	Typ av resurs.

PublicNetworkAccess

Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera

Name	Typ	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Etableringstillstånd för den privata slutpunktsanslutningen.

Name	Typ	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.