Partner Topics - List By Subscription

服务:

Event Grid

API 版本:

2022-06-15

列出 Azure 订阅下的合作伙伴主题。
列出 Azure 订阅下的所有合作伙伴主题。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	唯一标识Microsoft Azure 订阅的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	要用于客户端请求的 API 的版本。
$filter	query		string	用于使用 OData 语法筛选搜索结果的查询。 仅允许对“name”属性进行筛选，并且 OData作数量有限。 这些作包括：“contains”函数以及以下逻辑作：not、or， or， eq （for equal）和 ne （对于不相等）。 不支持算术运算。 下面是有效的筛选器示例：$filter=contains（namE、'PATTERN'）和名称 ne 'PATTERN-1'。 下面是无效的筛选器示例：$filter=location eq 'westus'。
$top	query		integer (int32)	要为列表作返回每页的结果数。 顶部参数的有效范围为 1 到 100。 如果未指定，则返回的默认结果数是每页 20 个项目。

响应

名称	类型	说明
200 OK	PartnerTopicsListResult	还行
Other Status Codes		错误响应： *** 400 错误的请求。 500 内部服务器错误。

示例

PartnerTopics_ListBySubscription

示例请求

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for PartnerTopics List. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopics_ListBySubscription.json
     */
    /**
     * Sample code: PartnerTopics_ListBySubscription.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void partnerTopicsListBySubscription(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.partnerTopics().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_topics_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_topics.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopics_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/PartnerTopics_ListBySubscription.json
func ExamplePartnerTopicsClient_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.NewPartnerTopicsClient().NewListBySubscriptionPager(&armeventgrid.PartnerTopicsClientListBySubscriptionOptions{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.PartnerTopicsListResult = armeventgrid.PartnerTopicsListResult{
		// 	Value: []*armeventgrid.PartnerTopic{
		// 		{
		// 			Name: to.Ptr("examplePartnerTopic1"),
		// 			Type: to.Ptr("Microsoft.EventGrid/partnerTopics"),
		// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1"),
		// 			Location: to.Ptr("centraluseuap"),
		// 			Properties: &armeventgrid.PartnerTopicProperties{
		// 				ActivationState: to.Ptr(armeventgrid.PartnerTopicActivationStateNeverActivated),
		// 				ProvisioningState: to.Ptr(armeventgrid.PartnerTopicProvisioningStateSucceeded),
		// 				Source: to.Ptr("ContosoCorp.Accounts.User1"),
		// 			},
		// 	}},
		// }
	}
}

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 topics under an Azure subscription.
 *
 * @summary List all the partner topics under an Azure subscription.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerTopics_ListBySubscription.json
 */
async function partnerTopicsListBySubscription() {
  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.partnerTopics.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/PartnerTopics_ListBySubscription.json
// this example is just showing the usage of "PartnerTopics_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 (PartnerTopicResource item in subscriptionResource.GetPartnerTopicsAsync())
{
    // 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
    PartnerTopicData 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": {
        "source": "ContosoCorp.Accounts.User1",
        "provisioningState": "Succeeded",
        "activationState": "NeverActivated"
      },
      "location": "centraluseuap",
      "tags": null,
      "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1",
      "name": "examplePartnerTopic1",
      "type": "Microsoft.EventGrid/partnerTopics"
    }
  ]
}

定义

名称	说明
createdByType	创建资源的标识的类型。
EventDefinitionKind	所使用的事件类型。
EventTypeInfo	通道的事件类型信息。
IdentityInfo	资源的标识信息。
IdentityType	使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。
InlineEventProperties	有关每个内联事件的其他信息。
PartnerTopic	事件网格合作伙伴主题。
PartnerTopicActivationState	合作伙伴主题的激活状态。
PartnerTopicProvisioningState	合作伙伴主题的预配状态。
PartnerTopicsListResult	列出合作伙伴主题作的结果。
systemData	与创建和上次修改资源相关的元数据。
UserIdentityProperties	有关用户标识的信息。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

EventDefinitionKind

枚举

所使用的事件类型。

值	说明
Inline

EventTypeInfo

Object

通道的事件类型信息。

名称	类型	说明
inlineEventTypes	<string,  InlineEventProperties>	资源的内联事件类型的集合。 内联事件类型键是表示事件名称的类型字符串。 有效的内联事件名称示例是“Contoso.OrderCreated”。 内联事件类型值的类型为 InlineEventProperties，并且将包含每个内联事件类型的附加信息。
kind	EventDefinitionKind	所使用的事件类型。

IdentityInfo

Object

资源的标识信息。

名称	类型	说明
principalId	string	资源标识的主体 ID。
tenantId	string	资源的租户 ID。
type	IdentityType	使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。
userAssignedIdentities	<string,  UserIdentityProperties>	与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 此属性当前未使用，并保留以供将来使用。

IdentityType

枚举

使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。

值	说明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

InlineEventProperties

Object

有关每个内联事件的其他信息。

名称	类型	说明
dataSchemaUrl	string	内联事件的 dataSchemaUrl。
description	string	内联事件的说明。
displayName	string	内联事件的 displayName。
documentationUrl	string	内联事件的 documentationUrl。

PartnerTopic

Object

事件网格合作伙伴主题。

名称	类型	说明
id	string	资源的完全限定标识符。
identity	IdentityInfo	合作伙伴主题资源的标识信息。
location	string	资源的位置。
name	string	资源的名称。
properties.activationState	PartnerTopicActivationState	合作伙伴主题的激活状态。
properties.eventTypeInfo	EventTypeInfo	来自相应事件通道的事件类型信息。
properties.expirationTimeIfNotActivatedUtc	string (date-time)	合作伙伴主题的过期时间。 如果此计时器在合作伙伴主题仍未激活时过期，则会删除合作伙伴主题和相应的事件通道。
properties.messageForActivation	string	订阅者可在审批过程中使用的上下文或有用消息。
properties.partnerRegistrationImmutableId	string (uuid)	相应伙伴注册的不可变 Id。
properties.partnerTopicFriendlyDescription	string	有关主题的友好说明。 这可由发布者/合作伙伴设置，以显示客户合作伙伴主题的自定义说明。 这有助于删除客户创建合作伙伴主题的源点的任何歧义。
properties.provisioningState	PartnerTopicProvisioningState	合作伙伴主题的预配状态。
properties.source	string	与此合作伙伴主题关联的源。 这表示唯一的合作伙伴资源。
systemData	systemData	与合作伙伴主题资源相关的系统元数据。
tags	object	资源的标记。
type	string	资源的类型。

PartnerTopicActivationState

枚举

合作伙伴主题的激活状态。

值	说明
Activated
Deactivated
NeverActivated

PartnerTopicProvisioningState

枚举

合作伙伴主题的预配状态。

值	说明
Canceled
Creating
Deleting
Failed
IdleDueToMirroredChannelResourceDeletion
Succeeded
Updating

PartnerTopicsListResult

Object

列出合作伙伴主题作的结果。

名称	类型	说明
nextLink	string	合作伙伴主题的下一页的链接。
value	PartnerTopic[]	合作伙伴主题的集合。

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UserIdentityProperties

Object

有关用户标识的信息。

名称	类型	说明
clientId	string	用户分配标识的客户端 ID。
principalId	string	用户分配标识的主体 ID。