Partner Namespaces - List By Subscription

Service:

Event Grid

API Version:

2022-06-15

Azure aboneliği altında iş ortağı ad alanlarını listeleme.
Azure aboneliği kapsamındaki tüm iş ortağı ad alanlarını listeleme.

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}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci isteğiyle kullanılacak API sürümü.
$filter	query		string	OData söz dizimini kullanarak arama sonuçlarını filtrelemek için kullanılan sorgu. Filtrelemeye yalnızca 'name' özelliğinde ve sınırlı sayıda OData işlemiyle izin verilir. Bu işlemler şunlardır: 'contains' işlevinin yanı sıra aşağıdaki mantıksal işlemler: not, and veya, eq (eşit için) ve ne (eşit değildir). Hiçbir aritmetik işlem desteklenmez. Aşağıda geçerli bir filtre örneği verilmiştir: $filter=contains(namE, 'PATTERN') ve ne 'PATTERN-1' adı. Aşağıdaki geçerli bir filtre örneği değildir: $filter=location eq 'westus'.
$top	query		integer int32	Liste işlemi için sayfa başına döndürülecek sonuç sayısı. Üst parametre için geçerli aralık 1 ile 100 arasındadır. Belirtilmezse, döndürülecek varsayılan sonuç sayısı sayfa başına 20 öğedir.

Yanıtlar

Name	Tür	Description
200 OK	PartnerNamespacesListResult	Tamam
Other Status Codes		Hata Yanıtları: *** 400 Hatalı İstek. 500 İç Sunucu Hatası.

Örnekler

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

Tanımlar

Name	Description
ConnectionState	ConnectionState bilgileri.
createdByType	Kaynağı oluşturan kimliğin türü.
InboundIpRule
IpActionType	IpMask'in eşleşmesine veya eşleşmesine bağlı olarak gerçekleştirilecek eylem.
PartnerNamespace	EventGrid İş Ortağı Ad Alanı.
PartnerNamespaceProvisioningState	İş ortağı ad alanının sağlama durumu.
PartnerNamespacesListResult	İş Ortağı Ad Alanlarını Listele işleminin sonucu
PartnerTopicRoutingMode	Bu, bu iş ortağı ad alanında yayımlanan olayların olay yükündeki kaynak özniteliği mi yoksa iş ortağı konusuyla eşleşirken üst bilgideki kanal adını mı kullanması gerektiğini belirler. Hiçbiri belirtilmezse, iş ortağı konusuyla eşleştirmek için kaynak öznitelik yönlendirmesi kullanılır.
PersistedConnectionStatus	Bağlantının durumu.
PrivateEndpoint	PrivateEndpoint bilgileri.
PrivateEndpointConnection
PublicNetworkAccess	Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Yapılandırarak belirli IP'leri daha da kısıtlayabilirsiniz
ResourceProvisioningState	Özel Uç Nokta Bağlantısının sağlama durumu.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

ConnectionState

ConnectionState bilgileri.

Name	Tür	Description
actionsRequired	string	Gerekli eylemler (varsa).
description	string	Bağlantı durumunun açıklaması.
status	PersistedConnectionStatus	Bağlantının durumu.

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Name	Tür	Description
action	IpActionType	IpMask'in eşleşmesine veya eşleşmesine bağlı olarak gerçekleştirilecek eylem.
ipMask	string	CIDR gösteriminde IP Adresi; örneğin, 10.0.0.0/8.

IpActionType

IpMask'in eşleşmesine veya eşleşmesine bağlı olarak gerçekleştirilecek eylem.

Name	Tür	Description
Allow	string

PartnerNamespace

EventGrid İş Ortağı Ad Alanı.

Name	Tür	Varsayılan değer	Description
id	string		Kaynağın tam tanımlayıcısı.
location	string		Kaynağın konumu.
name	string		Kaynağın adı.
properties.disableLocalAuth	boolean	False	Bu boole yerel kimlik doğrulamasını etkinleştirmek veya devre dışı bırakmak için kullanılır. Varsayılan değer false'tur. Özellik true olarak ayarlandığında, kullanıcının iş ortağı ad alanında yayımlamasına izin verilirse kimlik doğrulaması için yalnızca AAD belirteci kullanılır.
properties.endpoint	string		İş ortağı ad alanı için uç nokta.
properties.inboundIpRules	InboundIpRule[]		Bu, tüm IP'ler yerine belirli IP'lerden gelen trafiği kısıtlamak için kullanılabilir. Not: Bunlar yalnızca PublicNetworkAccess etkinleştirildiğinde dikkate alınır.
properties.partnerRegistrationFullyQualifiedId	string		Bu iş ortağı ad alanıyla ilişkilendirilmesi gereken iş ortağı kaydının tam ARM Kimliği. Bu şu biçimi alır: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Bu, bu iş ortağı ad alanında yayımlanan olayların olay yükündeki kaynak özniteliği mi yoksa iş ortağı konusuyla eşleşirken üst bilgideki kanal adını mı kullanması gerektiğini belirler. Hiçbiri belirtilmezse, iş ortağı konusuyla eşleştirmek için kaynak öznitelik yönlendirmesi kullanılır.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		İş ortağı ad alanının sağlama durumu.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Yapılandırarak belirli IP'leri daha da kısıtlayabilirsiniz
systemData	systemData		İş Ortağı Ad Alanı kaynağıyla ilgili sistem meta verileri.
tags	object		Kaynağın etiketleri.
type	string		Kaynağın türü.

PartnerNamespaceProvisioningState

İş ortağı ad alanının sağlama durumu.

Name	Tür	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerNamespacesListResult

İş Ortağı Ad Alanlarını Listele işleminin sonucu

Name	Tür	Description
nextLink	string	İş ortağı ad alanlarının sonraki sayfası için bir bağlantı.
value	PartnerNamespace[]	İş ortağı ad alanları koleksiyonu.

PartnerTopicRoutingMode

Bu, bu iş ortağı ad alanında yayımlanan olayların olay yükündeki kaynak özniteliği mi yoksa iş ortağı konusuyla eşleşirken üst bilgideki kanal adını mı kullanması gerektiğini belirler. Hiçbiri belirtilmezse, iş ortağı konusuyla eşleştirmek için kaynak öznitelik yönlendirmesi kullanılır.

Name	Tür	Description
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

Bağlantının durumu.

Name	Tür	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint bilgileri.

Name	Tür	Description
id	string	Özel Uç Nokta için ARM tanımlayıcısı.

PrivateEndpointConnection

Name	Tür	Description
id	string	Kaynağın tam tanımlayıcısı.
name	string	Kaynağın adı.
properties.groupIds	string[]	Özel bağlantı hizmeti kaynağındaki GroupId'ler.
properties.privateEndpoint	PrivateEndpoint	Bu Bağlantı için Özel Uç Nokta kaynağı.
properties.privateLinkServiceConnectionState	ConnectionState	Bağlantının durumuyla ilgili ayrıntılar.
properties.provisioningState	ResourceProvisioningState	Özel Uç Nokta Bağlantısının sağlama durumu.
type	string	Kaynağın türü.

PublicNetworkAccess

Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Yapılandırarak belirli IP'leri daha da kısıtlayabilirsiniz

Name	Tür	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Özel Uç Nokta Bağlantısının sağlama durumu.

Name	Tür	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.