System Topics - Create Or Update

서비스:

Event Grid

API 버전:

2022-06-15

시스템 토픽을 만듭니다.
지정된 매개 변수를 사용하여 새 시스템 토픽을 비동기적으로 만듭니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	사용자의 구독 내에서 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
systemTopicName	path	True	string	시스템 토픽의 이름입니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다.

요청 본문

Name	필수	형식	Description
location	True	string	리소스의 위치입니다.
identity		IdentityInfo	리소스에 대한 ID 정보입니다.
properties.source		string	시스템 토픽의 원본입니다.
properties.topicType		string	시스템 토픽에 대한 TopicType입니다.
tags		object	리소스의 태그입니다.

응답

Name	형식	Description
200 OK	SystemTopic	정상
201 Created	SystemTopic	생성일
Other Status Codes		오류 응답: *** 400 잘못된 요청. 500 내부 서버 오류.

예제

SystemTopics_CreateOrUpdate

샘플 요청

HTTP

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

{
  "properties": {
    "source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e",
    "topicType": "microsoft.storage.storageaccounts"
  },
  "location": "westus2",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Java

import java.util.HashMap;
import java.util.Map;

/** Samples for SystemTopics CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopics_CreateOrUpdate.json
     */
    /**
     * Sample code: SystemTopics_CreateOrUpdate.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void systemTopicsCreateOrUpdate(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager
            .systemTopics()
            .define("exampleSystemTopic1")
            .withRegion("westus2")
            .withExistingResourceGroup("examplerg")
            .withTags(mapOf("tag1", "value1", "tag2", "value2"))
            .withSource(
                "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e")
            .withTopicType("microsoft.storage.storageaccounts")
            .create();
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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 system_topics_create_or_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="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.system_topics.begin_create_or_update(
        resource_group_name="examplerg",
        system_topic_name="exampleSystemTopic1",
        system_topic_info={
            "location": "westus2",
            "properties": {
                "source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e",
                "topicType": "microsoft.storage.storageaccounts",
            },
            "tags": {"tag1": "value1", "tag2": "value2"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopics_CreateOrUpdate.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/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopics_CreateOrUpdate.json
func ExampleSystemTopicsClient_BeginCreateOrUpdate() {
	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.NewSystemTopicsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleSystemTopic1", armeventgrid.SystemTopic{
		Location: to.Ptr("westus2"),
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
		Properties: &armeventgrid.SystemTopicProperties{
			Source:    to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e"),
			TopicType: to.Ptr("microsoft.storage.storageaccounts"),
		},
	}, 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.SystemTopic = armeventgrid.SystemTopic{
	// 	Name: to.Ptr("exampleSystemTopic2"),
	// 	Type: to.Ptr("Microsoft.EventGrid/systemTopics"),
	// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2"),
	// 	Location: to.Ptr("centraluseuap"),
	// 	Properties: &armeventgrid.SystemTopicProperties{
	// 		MetricResourceID: to.Ptr("183c0fb1-17ff-47b6-ac77-5a47420ab01e"),
	// 		ProvisioningState: to.Ptr(armeventgrid.ResourceProvisioningStateSucceeded),
	// 		Source: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e"),
	// 		TopicType: to.Ptr("microsoft.storage.storageaccounts"),
	// 	},
	// }
}

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 Asynchronously creates a new system topic with the specified parameters.
 *
 * @summary Asynchronously creates a new system topic with the specified parameters.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopics_CreateOrUpdate.json
 */
async function systemTopicsCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const systemTopicName = "exampleSystemTopic1";
  const systemTopicInfo = {
    location: "westus2",
    source:
      "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e",
    tags: { tag1: "value1", tag2: "value2" },
    topicType: "microsoft.storage.storageaccounts",
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.systemTopics.beginCreateOrUpdateAndWait(
    resourceGroupName,
    systemTopicName,
    systemTopicInfo
  );
  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 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/SystemTopics_CreateOrUpdate.json
// this example is just showing the usage of "SystemTopics_CreateOrUpdate" 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 SystemTopicResource
SystemTopicCollection collection = resourceGroupResource.GetSystemTopics();

// invoke the operation
string systemTopicName = "exampleSystemTopic1";
SystemTopicData data = new SystemTopicData(new AzureLocation("westus2"))
{
    Source = new ResourceIdentifier("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e"),
    TopicType = "microsoft.storage.storageaccounts",
    Tags =
    {
    ["tag1"] = "value1",
    ["tag2"] = "value2",
    },
};
ArmOperation<SystemTopicResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, systemTopicName, data);
SystemTopicResource 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
SystemTopicData 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",
    "source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e",
    "topicType": "microsoft.storage.storageaccounts",
    "metricResourceId": "183c0fb1-17ff-47b6-ac77-5a47420ab01e"
  },
  "location": "centraluseuap",
  "tags": null,
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2",
  "name": "exampleSystemTopic2",
  "type": "Microsoft.EventGrid/systemTopics"
}

상태 코드:

201

{
  "properties": {
    "provisioningState": "Succeeded",
    "source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e",
    "topicType": "microsoft.storage.storageaccounts",
    "metricResourceId": "183c0fb1-17ff-47b6-ac77-5a47420ab01e"
  },
  "location": "centraluseuap",
  "tags": null,
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2",
  "name": "exampleSystemTopic2",
  "type": "Microsoft.EventGrid/systemTopics"
}

정의

Name	Description
createdByType	리소스를 만든 ID의 형식입니다.
IdentityInfo	리소스에 대한 ID 정보입니다.
IdentityType	사용되는 관리 ID의 유형입니다. 'SystemAssigned, UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 모든 ID를 제거합니다.
ResourceProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
SystemTopic	EventGrid 시스템 토픽.
UserIdentityProperties	사용자 ID에 대한 정보입니다.

createdByType

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

IdentityInfo

리소스에 대한 ID 정보입니다.

Name	형식	Description
principalId	string	리소스 ID의 보안 주체 ID입니다.
tenantId	string	리소스의 테넌트 ID입니다.
type	IdentityType	사용되는 관리 ID의 유형입니다. 'SystemAssigned, UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 모든 ID를 제거합니다.
userAssignedIdentities	<string,  UserIdentityProperties>	리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다. 이 속성은 현재 사용되지 않으며 향후 사용을 위해 예약되어 있습니다.

IdentityType

사용되는 관리 ID의 유형입니다. 'SystemAssigned, UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 모든 ID를 제거합니다.

Name	형식	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ResourceProvisioningState

프라이빗 엔드포인트 연결의 프로비전 상태입니다.

Name	형식	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.

SystemTopic

EventGrid 시스템 토픽.

Name	형식	Description
id	string	리소스의 정규화된 식별자입니다.
identity	IdentityInfo	리소스에 대한 ID 정보입니다.
location	string	리소스의 위치입니다.
name	string	리소스의 이름입니다.
properties.metricResourceId	string	시스템 토픽의 메트릭 리소스 ID입니다.
properties.provisioningState	ResourceProvisioningState	시스템 토픽의 프로비전 상태입니다.
properties.source	string	시스템 토픽의 원본입니다.
properties.topicType	string	시스템 토픽에 대한 TopicType입니다.
systemData	systemData	시스템 토픽 리소스와 관련된 시스템 메타데이터입니다.
tags	object	리소스의 태그입니다.
type	string	리소스 유형입니다.

UserIdentityProperties

사용자 ID에 대한 정보입니다.

Name	형식	Description
clientId	string	사용자 할당 ID의 클라이언트 ID입니다.
principalId	string	사용자 할당 ID의 보안 주체 ID입니다.