Namespace Topics - Update

服务:

Event Grid

API 版本:

2025-02-15

更新命名空间主题。
使用指定的参数异步更新命名空间主题。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}?api-version=2025-02-15

URI 参数

名称	在	必需	类型	说明
namespaceName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-zA-Z0-9-]*$	命名空间的名称。
resourceGroupName	path	True	string	用户订阅中的资源组的名称。
subscriptionId	path	True	string	唯一标识Microsoft Azure 订阅的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
topicName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-zA-Z0-9-]*$	命名空间主题的名称。
api-version	query	True	string	要用于客户端请求的 API 的版本。

请求正文

名称	类型	说明
properties.eventRetentionInDays	integer (int32)	命名空间主题的事件保留期（以天为单位）。 属性默认值为 1 天。 最小事件保留持续时间值为 1 天，最大事件保留持续时间值为 1 天。

响应

名称	类型	说明
200 OK	NamespaceTopic	还行
202 Accepted	NamespaceTopic	已接受命名空间主题更新请求。 标头 Location: string
Other Status Codes	ErrorResponse	如果请求失败，则返回错误响应。

示例

NamespaceTopics_Update

示例请求

HTTP

PATCH https://management.azure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/topics/exampleNamespaceTopicName1?api-version=2025-02-15

{
  "properties": {
    "eventRetentionInDays": 1
  }
}

Java

import com.azure.resourcemanager.eventgrid.models.NamespaceTopic;

/**
 * Samples for NamespaceTopics Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/NamespaceTopics_Update.
     * json
     */
    /**
     * Sample code: NamespaceTopics_Update.
     * 
     * @param manager Entry point to EventGridManager.
     */
    public static void namespaceTopicsUpdate(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        NamespaceTopic resource = manager.namespaceTopics().getWithResponse("examplerg", "exampleNamespaceName1",
            "exampleNamespaceTopicName1", com.azure.core.util.Context.NONE).getValue();
        resource.update().withEventRetentionInDays(1).apply();
    }
}

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 namespace_topics_update.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="8f6b6269-84f2-4d09-9e31-1127efcd1e40",
    )

    response = client.namespace_topics.begin_update(
        resource_group_name="examplerg",
        namespace_name="exampleNamespaceName1",
        topic_name="exampleNamespaceTopicName1",
        namespace_topic_update_parameters={"properties": {"eventRetentionInDays": 1}},
    ).result()
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/NamespaceTopics_Update.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/azcore/to"
	"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/NamespaceTopics_Update.json
func ExampleNamespaceTopicsClient_BeginUpdate() {
	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)
	}
	poller, err := clientFactory.NewNamespaceTopicsClient().BeginUpdate(ctx, "examplerg", "exampleNamespaceName1", "exampleNamespaceTopicName1", armeventgrid.NamespaceTopicUpdateParameters{
		Properties: &armeventgrid.NamespaceTopicUpdateParameterProperties{
			EventRetentionInDays: to.Ptr[int32](1),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.NamespaceTopic = armeventgrid.NamespaceTopic{
	// 	Name: to.Ptr("examplenamespacetopic2"),
	// 	Type: to.Ptr("Microsoft.EventGrid/namespaces/topics"),
	// 	ID: to.Ptr("/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/topics/exampleNamespaceTopicName1"),
	// 	Properties: &armeventgrid.NamespaceTopicProperties{
	// 		EventRetentionInDays: to.Ptr[int32](1),
	// 		InputSchema: to.Ptr(armeventgrid.EventInputSchemaCloudEventSchemaV10),
	// 		ProvisioningState: to.Ptr(armeventgrid.NamespaceTopicProvisioningStateSucceeded),
	// 		PublisherType: to.Ptr(armeventgrid.PublisherTypeCustom),
	// 	},
	// }
}

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 Asynchronously updates a namespace topic with the specified parameters.
 *
 * @summary Asynchronously updates a namespace topic with the specified parameters.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/NamespaceTopics_Update.json
 */
async function namespaceTopicsUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "8f6b6269-84f2-4d09-9e31-1127efcd1e40";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const namespaceName = "exampleNamespaceName1";
  const topicName = "exampleNamespaceTopicName1";
  const namespaceTopicUpdateParameters = {
    eventRetentionInDays: 1,
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.namespaceTopics.beginUpdateAndWait(
    resourceGroupName,
    namespaceName,
    topicName,
    namespaceTopicUpdateParameters,
  );
  console.log(result);
}

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.EventGrid.Models;
using Azure.ResourceManager.EventGrid;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/NamespaceTopics_Update.json
// this example is just showing the usage of "NamespaceTopics_Update" 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 NamespaceTopicResource created on azure
// for more information of creating NamespaceTopicResource, please refer to the document of NamespaceTopicResource
string subscriptionId = "8f6b6269-84f2-4d09-9e31-1127efcd1e40";
string resourceGroupName = "examplerg";
string namespaceName = "exampleNamespaceName1";
string topicName = "exampleNamespaceTopicName1";
ResourceIdentifier namespaceTopicResourceId = NamespaceTopicResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName, topicName);
NamespaceTopicResource namespaceTopic = client.GetNamespaceTopicResource(namespaceTopicResourceId);

// invoke the operation
NamespaceTopicPatch patch = new NamespaceTopicPatch
{
    EventRetentionInDays = 1,
};
ArmOperation<NamespaceTopicResource> lro = await namespaceTopic.UpdateAsync(WaitUntil.Completed, patch);
NamespaceTopicResource result = lro.Value;

// the variable result 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
NamespaceTopicData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "properties": {
    "provisioningState": "Succeeded",
    "publisherType": "Custom",
    "inputSchema": "CloudEventSchemaV1_0",
    "eventRetentionInDays": 1
  },
  "id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/topics/exampleNamespaceTopicName1",
  "name": "examplenamespacetopic2",
  "type": "Microsoft.EventGrid/namespaces/topics",
  "systemData": null
}

状态代码:

202

Azure-AsyncOperation: https://management.windowsazure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/topics/exampleNamespaceTopicName1/operationStatus/7B023877-A473-457B-B462-562F97048FB6?api-version=2025-02-15
Location: https://management.windowsazure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/topics/exampleNamespaceTopicName1/operationResults/7B023877-A473-457B-B462-562F97048FB6?api-version=2025-02-15
Retry-After: 60

{
  "properties": {
    "provisioningState": "Succeeded",
    "publisherType": "Custom",
    "inputSchema": "CloudEventSchemaV1_0",
    "eventRetentionInDays": 1
  },
  "id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/topics/exampleNamespaceTopicName1",
  "name": "examplenamespacetopic2",
  "type": "Microsoft.EventGrid/namespaces/topics",
  "systemData": null
}

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
EventInputSchema	这将确定发布到主题的传入事件的预期格式。
NamespaceTopic	命名空间主题详细信息。
NamespaceTopicProvisioningState	命名空间主题的预配状态。
NamespaceTopicUpdateParameters	命名空间主题更新的属性。
PublisherType	命名空间主题的发布者类型。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

EventInputSchema

枚举

这将确定发布到主题的传入事件的预期格式。

值	说明
CloudEventSchemaV1_0

NamespaceTopic

Object

命名空间主题详细信息。

名称	类型	默认值	说明
id	string		资源的完全限定标识符。
name	string		资源的名称。
properties.eventRetentionInDays	integer (int32)		命名空间主题的事件保留期（以天为单位）。 属性默认值为 1 天。 最小事件保留持续时间值为 1 天，最大事件保留持续时间值为 1 天。
properties.inputSchema	EventInputSchema	CloudEventSchemaV1_0	这将确定发布到主题的传入事件的预期格式。
properties.provisioningState	NamespaceTopicProvisioningState		命名空间主题的预配状态。
properties.publisherType	PublisherType		命名空间主题的发布者类型。
systemData	systemData		与事件网格资源相关的系统元数据。
type	string		资源的类型。

NamespaceTopicProvisioningState

枚举

命名空间主题的预配状态。

值	说明
Canceled
CreateFailed
Creating
DeleteFailed
Deleted
Deleting
Failed
Succeeded
UpdatedFailed
Updating

NamespaceTopicUpdateParameters

Object

命名空间主题更新的属性。

名称	类型	说明
properties.eventRetentionInDays	integer (int32)	命名空间主题的事件保留期（以天为单位）。 属性默认值为 1 天。 最小事件保留持续时间值为 1 天，最大事件保留持续时间值为 1 天。

PublisherType

枚举

命名空间主题的发布者类型。

值	说明
Custom

systemData

Object

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

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