Partner Namespaces - List By Subscription

服務:

Event Grid

API 版本:

2025-02-15

列出 Azure 訂用帳戶底下的合作夥伴命名空間。
列出 Azure 訂用帳戶下的所有合作夥伴命名空間。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。
$filter	query		string	用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 『name』 屬性，且 OData 作業數目有限。 這些作業包括：『contains』 函式以及下列邏輯作業：not、 和， 或 eq （針對 equal）， 和 ne （for not equal） 。 不支持算術運算。 以下是有效的篩選範例：$filter=contains（namE，'PATTERN'） 和名稱 ne 'PATTERN-1'。 下列不是有效的篩選範例：$filter=location eq 'westus'。
$top	query		integer (int32)	要針對清單作業傳回每個頁面的結果數目。 top 參數的有效範圍是 1 到 100。 如果未指定，每個頁面要傳回的默認結果數目為20個專案。

回應

名稱	類型	Description
200 OK	PartnerNamespacesListResult	還行
Other Status Codes	ErrorResponse	如果要求失敗，則傳回的錯誤回應。

範例

PartnerNamespaces_ListBySubscription

範例要求

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

範例回覆

狀態碼:

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

定義

名稱	Description
ConnectionState	ConnectionState 資訊。
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
InboundIpRule
IpActionType	根據相符專案或 IpMask 不相符執行的動作。
PartnerNamespace	EventGrid Partner 命名空間。
PartnerNamespaceProvisioningState	合作夥伴命名空間的布建狀態。
PartnerNamespacesListResult	列出合作夥伴命名空間作業的結果
PartnerTopicRoutingMode	這會判斷發佈至此夥伴命名空間的事件是否應該在事件承載中使用來源屬性，或在與夥伴主題相符時，在標頭中使用通道名稱。 如果未指定任何專案，則會使用來源屬性路由來比對夥伴主題。
PersistedConnectionStatus	線上的狀態。
PrivateEndpoint	PrivateEndpoint 資訊。
PrivateEndpointConnection
PublicNetworkAccess	這會判斷是否允許透過公用網路傳輸流量。 默認會啟用。 您可以設定 <seealso cref=“P：Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules” />
ResourceProvisioningState	私人端點聯機的布建狀態。
systemData	與建立和上次修改資源相關的元數據。
TlsVersion	允許發佈至此網域之發行者的最低 TLS 版本

ConnectionState

Object

ConnectionState 資訊。

名稱	類型	Description
actionsRequired	string	需要動作（如果有的話）。
description	string	連接狀態的描述。
status	PersistedConnectionStatus	線上的狀態。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

InboundIpRule

Object

名稱	類型	Description
action	IpActionType	根據相符專案或 IpMask 不相符執行的動作。
ipMask	string	CIDR 表示法中的IP位址，例如10.0.0.0.0/8。

IpActionType

列舉型別

根據相符專案或 IpMask 不相符執行的動作。

值	Description
Allow

PartnerNamespace

Object

EventGrid Partner 命名空間。

名稱	類型	預設值	Description
id	string		資源的完整標識碼。
location	string		資源的位置。
name	string		資源的名稱。
properties.disableLocalAuth	boolean	False	此布爾值是用來啟用或停用本機驗證。默認值為 false。 當 屬性設定為 true 時，只有在允許使用者發佈至夥伴命名空間時，才會使用 AAD 令牌進行驗證。
properties.endpoint	string		夥伴命名空間的端點。
properties.inboundIpRules	InboundIpRule[]		這可用來限制來自特定IP的流量，而不是所有IP的流量。 注意：只有在啟用 PublicNetworkAccess 時，才會考慮這些專案。
properties.minimumTlsVersionAllowed	TlsVersion		允許發佈至此夥伴命名空間之發行者的最低 TLS 版本
properties.partnerRegistrationFullyQualifiedId	string		夥伴註冊的完整 ARM 標識碼，應該與此夥伴命名空間相關聯。 這會採用下列格式：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}。
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	這會判斷發佈至此夥伴命名空間的事件是否應該在事件承載中使用來源屬性，或在與夥伴主題相符時，在標頭中使用通道名稱。 如果未指定任何專案，則會使用來源屬性路由來比對夥伴主題。
properties.privateEndpointConnections	PrivateEndpointConnection[]		私人端點連線的清單。
properties.provisioningState	PartnerNamespaceProvisioningState		合作夥伴命名空間的布建狀態。
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	這會判斷是否允許透過公用網路傳輸流量。 默認會啟用。 您可以設定 <seealso cref=“P：Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PartnerNamespaceProperties.InboundIpRules” />
systemData	systemData		與事件方格資源相關的系統元數據。
tags	object		資源的標記。
type	string		資源的類型。

PartnerNamespaceProvisioningState

列舉型別

合作夥伴命名空間的布建狀態。

值	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

PartnerNamespacesListResult

Object

列出合作夥伴命名空間作業的結果

名稱	類型	Description
nextLink	string	合作夥伴命名空間下一頁的連結。
value	PartnerNamespace[]	夥伴命名空間的集合。

PartnerTopicRoutingMode

列舉型別

這會判斷發佈至此夥伴命名空間的事件是否應該在事件承載中使用來源屬性，或在與夥伴主題相符時，在標頭中使用通道名稱。 如果未指定任何專案，則會使用來源屬性路由來比對夥伴主題。

值	Description
SourceEventAttribute
ChannelNameHeader

PersistedConnectionStatus

列舉型別

線上的狀態。

值	Description
Pending
Approved
Rejected
Disconnected

PrivateEndpoint

Object

PrivateEndpoint 資訊。

名稱	類型	Description
id	string	私人端點的ARM標識碼。

PrivateEndpointConnection

Object

名稱	類型	Description
id	string	資源的完整標識碼。
name	string	資源的名稱。
properties.groupIds	string[]	Private Link 服務資源的 GroupId。
properties.privateEndpoint	PrivateEndpoint	此連線的私人端點資源。
properties.privateLinkServiceConnectionState	ConnectionState	線上狀態的詳細數據。
properties.provisioningState	ResourceProvisioningState	私人端點聯機的布建狀態。
type	string	資源的類型。

PublicNetworkAccess

列舉型別

這會判斷是否允許透過公用網路傳輸流量。 默認會啟用。 您可以設定 <seealso cref=“P：Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules” />

值	Description
Enabled
Disabled

ResourceProvisioningState

列舉型別

私人端點聯機的布建狀態。

值	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

TlsVersion

列舉型別

允許發佈至此網域之發行者的最低 TLS 版本

值	Description
1.0
1.1
1.2