Topics - Update

Služba:

Event Grid

Verze rozhraní API:

2022-06-15

Aktualizujte téma.
Asynchronně aktualizuje téma se zadanými parametry.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků v rámci předplatného uživatele.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
topicName	path	True	string	Název tématu.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta.

Text požadavku

Name	Typ	Description
identity	IdentityInfo	Informace o identitě prostředku tématu
properties.dataResidencyBoundary	DataResidencyBoundary	Hranice rezidence dat pro téma.
properties.disableLocalAuth	boolean	Tato logická hodnota se používá k povolení nebo zakázání místního ověřování. Výchozí hodnota je false. Pokud je vlastnost nastavená na hodnotu true, použije se k ověření pouze token AAD, pokud má uživatel povoleno publikovat do tématu.
properties.inboundIpRules	InboundIpRule[]	Můžete ho použít k omezení provozu z konkrétních IP adres místo všech IP adres. Poznámka: Tyto možnosti jsou považovány pouze v případě, že je povolená technologie PublicNetworkAccess.
properties.publicNetworkAccess	PublicNetworkAccess	Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená. Další omezení na konkrétní IP adresy můžete provést konfigurací
tags	object	Značky prostředku Téma

Odpovědi

Name	Typ	Description
200 OK		OK
201 Created	Topic	Žádost o aktualizaci tématu byla přijata.
Other Status Codes		Chybové odpovědi: *** 400 – Chybný požadavek. 500 Vnitřní chyba serveru.

Příklady

Topics_Update

Ukázkový požadavek

HTTP

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

{
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "inboundIpRules": [
      {
        "ipMask": "12.18.30.15",
        "action": "Allow"
      },
      {
        "ipMask": "12.18.176.1",
        "action": "Allow"
      }
    ]
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.eventgrid.models.InboundIpRule;
import com.azure.resourcemanager.eventgrid.models.IpActionType;
import com.azure.resourcemanager.eventgrid.models.PublicNetworkAccess;
import com.azure.resourcemanager.eventgrid.models.Topic;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/** Samples for Topics Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_Update.json
     */
    /**
     * Sample code: Topics_Update.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void topicsUpdate(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        Topic resource =
            manager.topics().getByResourceGroupWithResponse("examplerg", "exampletopic1", Context.NONE).getValue();
        resource
            .update()
            .withTags(mapOf("tag1", "value1", "tag2", "value2"))
            .withPublicNetworkAccess(PublicNetworkAccess.ENABLED)
            .withInboundIpRules(
                Arrays
                    .asList(
                        new InboundIpRule().withIpMask("12.18.30.15").withAction(IpActionType.ALLOW),
                        new InboundIpRule().withIpMask("12.18.176.1").withAction(IpActionType.ALLOW)))
            .apply();
    }

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

    response = client.topics.begin_update(
        resource_group_name="examplerg",
        topic_name="exampletopic1",
        topic_update_parameters={
            "properties": {
                "inboundIpRules": [
                    {"action": "Allow", "ipMask": "12.18.30.15"},
                    {"action": "Allow", "ipMask": "12.18.176.1"},
                ],
                "publicNetworkAccess": "Enabled",
            },
            "tags": {"tag1": "value1", "tag2": "value2"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_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/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_Update.json
func ExampleTopicsClient_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.NewTopicsClient().BeginUpdate(ctx, "examplerg", "exampletopic1", armeventgrid.TopicUpdateParameters{
		Properties: &armeventgrid.TopicUpdateParameterProperties{
			InboundIPRules: []*armeventgrid.InboundIPRule{
				{
					Action: to.Ptr(armeventgrid.IPActionTypeAllow),
					IPMask: to.Ptr("12.18.30.15"),
				},
				{
					Action: to.Ptr(armeventgrid.IPActionTypeAllow),
					IPMask: to.Ptr("12.18.176.1"),
				}},
			PublicNetworkAccess: to.Ptr(armeventgrid.PublicNetworkAccessEnabled),
		},
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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 updates a topic with the specified parameters.
 *
 * @summary Asynchronously updates a topic with the specified parameters.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_Update.json
 */
async function topicsUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const topicName = "exampletopic1";
  const topicUpdateParameters = {
    inboundIpRules: [
      { action: "Allow", ipMask: "12.18.30.15" },
      { action: "Allow", ipMask: "12.18.176.1" },
    ],
    publicNetworkAccess: "Enabled",
    tags: { tag1: "value1", tag2: "value2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.topics.beginUpdateAndWait(
    resourceGroupName,
    topicName,
    topicUpdateParameters
  );
  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.EventGrid.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_Update.json
// this example is just showing the usage of "Topics_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 EventGridTopicResource created on azure
// for more information of creating EventGridTopicResource, please refer to the document of EventGridTopicResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
string topicName = "exampletopic1";
ResourceIdentifier eventGridTopicResourceId = EventGridTopicResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, topicName);
EventGridTopicResource eventGridTopic = client.GetEventGridTopicResource(eventGridTopicResourceId);

// invoke the operation
EventGridTopicPatch patch = new EventGridTopicPatch()
{
    Tags =
    {
    ["tag1"] = "value1",
    ["tag2"] = "value2",
    },
    PublicNetworkAccess = EventGridPublicNetworkAccess.Enabled,
    InboundIPRules =
    {
    new EventGridInboundIPRule()
    {
    IPMask = "12.18.30.15",
    Action = EventGridIPActionType.Allow,
    },new EventGridInboundIPRule()
    {
    IPMask = "12.18.176.1",
    Action = EventGridIPActionType.Allow,
    }
    },
};
await eventGridTopic.UpdateAsync(WaitUntil.Completed, patch);

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

Ukázková odpověď

Stavový kód:

200

Stavový kód:

201

{
  "properties": {
    "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled",
    "inboundIpRules": [
      {
        "ipMask": "12.18.30.15",
        "action": "Allow"
      },
      {
        "ipMask": "12.18.176.1",
        "action": "Allow"
      }
    ]
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
  "location": "westus2",
  "name": "exampletopic1",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "type": "Microsoft.EventGrid/topics"
}

Definice

Name	Description
ConnectionState	ConnectionState informace.
createdByType	Typ identity, která prostředek vytvořila.
DataResidencyBoundary	Data Residency hranice prostředku.
IdentityInfo	Informace o identitě prostředku.
IdentityType	Typ použité spravované identity. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere jakoukoli identitu.
InboundIpRule
InputSchema	Určuje formát, který má Event Grid očekávat u příchozích událostí publikovaných do prostředku domény Event Gridu.
IpActionType	Akce, která se má provést na základě shody nebo žádné shody IpMask.
JsonField	Používá se k vyjádření zdroje mapování vstupního schématu pro jedno cílové pole ve schématu událostí Event Gridu. V současné době se používá v mapování vlastností id, topic a eventtime. Představuje pole ve schématu vstupní události.
JsonFieldWithDefault	Používá se k vyjádření zdroje mapování vstupního schématu pro jedno cílové pole ve schématu událostí Event Gridu. V současné době se používá v mapování vlastností subject, eventtype a dataversion. Představuje pole ve schématu vstupní události spolu s výchozí hodnotou, která se má použít, a měla by být k dispozici alespoň jedna z těchto dvou vlastností.
JsonInputSchemaMapping	To umožňuje publikování do Event Gridu pomocí vlastního vstupního schématu. To se dá použít k mapování vlastností z vlastního vstupního schématu JSON na schéma událostí Event Gridu.
PersistedConnectionStatus	Stav připojení.
PrivateEndpoint	Informace o privátním koncovém bodu
PrivateEndpointConnection
PublicNetworkAccess	Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená. Další omezení na konkrétní IP adresy můžete provést konfigurací
ResourceProvisioningState	Stav zřizování připojení privátního koncového bodu.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
Topic	EventGrid – téma
TopicProvisioningState	Stav zřizování tématu.
TopicUpdateParameters	Vlastnosti aktualizace tématu
UserIdentityProperties	Informace o identitě uživatele.

ConnectionState

ConnectionState informace.

Name	Typ	Description
actionsRequired	string	Požadované akce (pokud nějaké jsou)
description	string	Popis stavu připojení
status	PersistedConnectionStatus	Stav připojení.

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataResidencyBoundary

Data Residency hranice prostředku.

Name	Typ	Description
WithinGeopair	string
WithinRegion	string

IdentityInfo

Informace o identitě prostředku.

Name	Typ	Description
principalId	string	ID objektu zabezpečení identity prostředku.
tenantId	string	ID tenanta prostředku.
type	IdentityType	Typ použité spravované identity. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere jakoukoli identitu.
userAssignedIdentities	<string,  UserIdentityProperties>	Seznam identit uživatelů přidružených k prostředku. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Tato vlastnost není aktuálně používána a rezervována pro budoucí použití.

IdentityType

Typ použité spravované identity. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere jakoukoli identitu.

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

InboundIpRule

Name	Typ	Description
action	IpActionType	Akce, která se má provést na základě shody nebo žádné shody IpMask.
ipMask	string	IP adresa v zápisu CIDR, například 10.0.0.0/8.

InputSchema

Určuje formát, který má Event Grid očekávat u příchozích událostí publikovaných do prostředku domény Event Gridu.

Name	Typ	Description
CloudEventSchemaV1_0	string
CustomEventSchema	string
EventGridSchema	string

IpActionType

Akce, která se má provést na základě shody nebo žádné shody IpMask.

Name	Typ	Description
Allow	string

JsonField

Používá se k vyjádření zdroje mapování vstupního schématu pro jedno cílové pole ve schématu událostí Event Gridu. V současné době se používá v mapování vlastností id, topic a eventtime. Představuje pole ve schématu vstupní události.

Name	Typ	Description
sourceField	string	Název pole ve schématu vstupní události, které se má použít jako zdroj mapování.

JsonFieldWithDefault

Používá se k vyjádření zdroje mapování vstupního schématu pro jedno cílové pole ve schématu událostí Event Gridu. V současné době se používá v mapování vlastností subject, eventtype a dataversion. Představuje pole ve schématu vstupní události spolu s výchozí hodnotou, která se má použít, a měla by být k dispozici alespoň jedna z těchto dvou vlastností.

Name	Typ	Description
defaultValue	string	Výchozí hodnota, která se má použít pro mapování, když není k dispozici SourceField nebo pokud v publikované datové části události JSON není žádná vlastnost se zadaným názvem.
sourceField	string	Název pole ve schématu vstupní události, které se má použít jako zdroj mapování.

JsonInputSchemaMapping

To umožňuje publikování do Event Gridu pomocí vlastního vstupního schématu. To se dá použít k mapování vlastností z vlastního vstupního schématu JSON na schéma událostí Event Gridu.

Name	Typ	Description
inputSchemaMappingType	string: Json	Typ vlastního mapování
properties.dataVersion	JsonFieldWithDefault	Informace o mapování pro vlastnost DataVersion události Event Grid.
properties.eventTime	JsonField	Informace o mapování pro vlastnost EventTime události Event Gridu.
properties.eventType	JsonFieldWithDefault	Informace o mapování pro vlastnost EventType události event gridu.
properties.id	JsonField	Informace o mapování pro vlastnost Id události Event Gridu.
properties.subject	JsonFieldWithDefault	Informace o mapování pro vlastnost Subject události Event Gridu.
properties.topic	JsonField	Informace o mapování pro vlastnost Téma události Event Gridu.

PersistedConnectionStatus

Stav připojení.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

Informace o privátním koncovém bodu

Name	Typ	Description
id	string	Identifikátor ARM pro privátní koncový bod.

PrivateEndpointConnection

Name	Typ	Description
id	string	Plně kvalifikovaný identifikátor prostředku.
name	string	Název prostředku.
properties.groupIds	string[]	GroupIds z prostředku služby private link.
properties.privateEndpoint	PrivateEndpoint	Prostředek privátního koncového bodu pro toto připojení.
properties.privateLinkServiceConnectionState	ConnectionState	Podrobnosti o stavu připojení.
properties.provisioningState	ResourceProvisioningState	Stav zřizování připojení privátního koncového bodu.
type	string	Typ prostředku.

PublicNetworkAccess

Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená. Další omezení na konkrétní IP adresy můžete provést konfigurací

Name	Typ	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Stav zřizování připojení privátního koncového bodu.

Name	Typ	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Topic

EventGrid – téma

Name	Typ	Default value	Description
id	string		Plně kvalifikovaný identifikátor prostředku.
identity	IdentityInfo		Informace o identitě prostředku.
location	string		Umístění prostředku.
name	string		Název prostředku.
properties.dataResidencyBoundary	DataResidencyBoundary		Data Residency hranice prostředku.
properties.disableLocalAuth	boolean	False	Tato logická hodnota se používá k povolení nebo zakázání místního ověřování. Výchozí hodnota je false. Pokud je vlastnost nastavená na hodnotu true, použije se k ověření pouze token AAD, pokud má uživatel povoleno publikovat do tématu.
properties.endpoint	string		Koncový bod tématu.
properties.inboundIpRules	InboundIpRule[]		Můžete ho použít k omezení provozu z konkrétních IP adres místo ze všech IP adres. Poznámka: Tyto možnosti se považují pouze v případě, že je povolená technologie PublicNetworkAccess.
properties.inputSchema	InputSchema	EventGridSchema	Určuje formát, který má Event Grid očekávat u příchozích událostí publikovaných do tématu.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		To umožňuje publikování pomocí vlastních schémat událostí. Je možné zadat InputSchemaMapping pro mapování různých vlastností zdrojového schématu na různé požadované vlastnosti schématu EventGridEvent.
properties.metricResourceId	string		ID prostředku metriky pro téma
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	TopicProvisioningState		Stav zřizování tématu.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená. Další omezení na konkrétní IP adresy můžete provést konfigurací
systemData	systemData		Systémová metadata související s prostředkem Tématu.
tags	object		Značky prostředku.
type	string		Typ prostředku.

TopicProvisioningState

Stav zřizování tématu.

Name	Typ	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

TopicUpdateParameters

Vlastnosti aktualizace tématu

Name	Typ	Default value	Description
identity	IdentityInfo		Informace o identitě prostředku tématu.
properties.dataResidencyBoundary	DataResidencyBoundary		Hranice rezidence dat pro dané téma.
properties.disableLocalAuth	boolean		Tato logická hodnota se používá k povolení nebo zakázání místního ověřování. Výchozí hodnota je false. Pokud je vlastnost nastavená na hodnotu true, použije se k ověření pouze token AAD, pokud má uživatel povoleno publikovat do tématu.
properties.inboundIpRules	InboundIpRule[]		Můžete ho použít k omezení provozu z konkrétních IP adres místo ze všech IP adres. Poznámka: Tyto možnosti se považují pouze v případě, že je povolená technologie PublicNetworkAccess.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Tím se určí, jestli je povolený provoz přes veřejnou síť. Ve výchozím nastavení je povolená. Další omezení na konkrétní IP adresy můžete provést konfigurací
tags	object		Značky prostředku Téma.

UserIdentityProperties

Informace o identitě uživatele.

Name	Typ	Description
clientId	string	ID klienta identity přiřazené uživatelem.
principalId	string	ID objektu zabezpečení identity přiřazené uživatelem.