Topics - Update

Referens

Tjänst:: Event Grid

API-version:: 2022-06-15

Uppdatera ett ämne.
Asynkront uppdaterar ett ämne med de angivna parametrarna.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen i användarens prenumeration.
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar en Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
topicName	path	True	string	Namnet på ämnet.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran.

Begärandetext

Name	Typ	Description
identity	IdentityInfo	Ämnesinformation om resursidentitet.
properties.dataResidencyBoundary	DataResidencyBoundary	Datahemvistgränsen för ämnet.
properties.disableLocalAuth	boolean	Det här booleska värdet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är false. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till ämnet.
properties.inboundIpRules	InboundIpRule[]	Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa beaktas endast om PublicNetworkAccess är aktiverat.
properties.publicNetworkAccess	PublicNetworkAccess	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
tags	object	Taggar för ämnesresursen.

Svar

Name

Typ

Description

200 OK

OK

201 Created

Begäran om ämnesuppdatering har godkänts.

Other Status Codes

Felsvar: ***

400 Felaktig begäran.
500 Internt serverfel.

Exempel

Topics_Update

Exempelbegäran

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

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

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

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

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

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

Exempelsvar

Statuskod:: 200

Statuskod:: 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"
}

Definitioner

Name	Description
ConnectionState	Information om ConnectionState.
createdByType	Den typ av identitet som skapade resursen.
DataResidencyBoundary	Data Residency resursens gräns.
IdentityInfo	Identitetsinformationen för resursen.
IdentityType	Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter.
InboundIpRule
InputSchema	Detta avgör vilket format Event Grid ska förvänta sig för inkommande händelser som publicerats till Event Grid-domänresursen.
IpActionType	Åtgärd att utföra baserat på matchningen eller ingen matchning av IpMask.
JsonField	Detta används för att uttrycka källan för en mappning av indatascheman för ett enda målfält i Event Grid-händelseschemat. Detta används för närvarande i mappningarna för egenskaperna "id", "topic" och "eventtime". Detta representerar ett fält i indatahändelseschemat.
JsonFieldWithDefault	Detta används för att uttrycka källan för en mappning av indatascheman för ett enda målfält i Event Grid-händelseschemat. Detta används för närvarande i mappningarna för egenskaperna "ämne", "eventtype" och "dataversion". Detta representerar ett fält i indatahändelseschemat tillsammans med ett standardvärde som ska användas, och minst en av dessa två egenskaper bör anges.
JsonInputSchemaMapping	På så sätt kan du publicera till Event Grid med ett anpassat indataschema. Detta kan användas för att mappa egenskaper från ett anpassat JSON-indataschema till Event Grid-händelseschemat.
PersistedConnectionStatus	Status för anslutningen.
PrivateEndpoint	PrivateEndpoint-information.
PrivateEndpointConnection
PublicNetworkAccess	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
ResourceProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
systemData	Metadata som rör skapande och senaste ändring av resursen.
Topic	EventGrid-ämne
TopicProvisioningState	Etableringstillstånd för ämnet.
TopicUpdateParameters	Egenskaper för ämnesuppdateringen
UserIdentityProperties	Information om användaridentiteten.

ConnectionState

Information om ConnectionState.

Name	Typ	Description
actionsRequired	string	Åtgärder som krävs (om sådana finns).
description	string	Beskrivning av anslutningstillståndet.
status	PersistedConnectionStatus	Status för anslutningen.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataResidencyBoundary

Data Residency resursens gräns.

Name	Typ	Description
WithinGeopair	string
WithinRegion	string

IdentityInfo

Identitetsinformationen för resursen.

Name	Typ	Description
principalId	string	Huvud-ID för resursidentitet.
tenantId	string	Resursens klientorganisations-ID.
type	IdentityType	Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter.
userAssignedIdentities	<string, UserIdentityProperties>	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Den här egenskapen används för närvarande inte och är reserverad för framtida användning.

IdentityType

Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter.

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

InboundIpRule

Name	Typ	Description
action	IpActionType	Åtgärd att utföra baserat på matchningen eller ingen matchning av IpMask.
ipMask	string	IP-adress i CIDR-notation, t.ex. 10.0.0.0/8.

InputSchema

Detta avgör vilket format Event Grid ska förvänta sig för inkommande händelser som publicerats till Event Grid-domänresursen.

Name	Typ	Description
CloudEventSchemaV1_0	string
CustomEventSchema	string
EventGridSchema	string

IpActionType

Åtgärd att utföra baserat på matchningen eller ingen matchning av IpMask.

Name	Typ	Description
Allow	string

JsonField

Detta används för att uttrycka källan för en mappning av indatascheman för ett enda målfält i Event Grid-händelseschemat. Detta används för närvarande i mappningarna för egenskaperna "id", "topic" och "eventtime". Detta representerar ett fält i indatahändelseschemat.

Name	Typ	Description
sourceField	string	Namn på ett fält i indatahändelseschemat som ska användas som källa för en mappning.

JsonFieldWithDefault

Detta används för att uttrycka källan för en mappning av indatascheman för ett enda målfält i Event Grid-händelseschemat. Detta används för närvarande i mappningarna för egenskaperna "ämne", "eventtype" och "dataversion". Detta representerar ett fält i indatahändelseschemat tillsammans med ett standardvärde som ska användas, och minst en av dessa två egenskaper bör anges.

Name	Typ	Description
defaultValue	string	Standardvärdet som ska användas för mappning när ett SourceField inte har angetts eller om det inte finns någon egenskap med det angivna namnet i den publicerade JSON-händelsenyttolasten.
sourceField	string	Namn på ett fält i indatahändelseschemat som ska användas som källa för en mappning.

JsonInputSchemaMapping

På så sätt kan du publicera till Event Grid med ett anpassat indataschema. Detta kan användas för att mappa egenskaper från ett anpassat JSON-indataschema till Event Grid-händelseschemat.

Name	Typ	Description
inputSchemaMappingType	string: Json	Typ av anpassad mappning
properties.dataVersion	JsonFieldWithDefault	Mappningsinformationen för egenskapen DataVersion för Event Grid-händelsen.
properties.eventTime	JsonField	Mappningsinformationen för EventTime-egenskapen för Event Grid-händelsen.
properties.eventType	JsonFieldWithDefault	Mappningsinformationen för eventtype-egenskapen för Event Grid-händelsen.
properties.id	JsonField	Mappningsinformationen för ID-egenskapen för Event Grid-händelsen.
properties.subject	JsonFieldWithDefault	Mappningsinformationen för egenskapen Subject för Event Grid-händelsen.
properties.topic	JsonField	Mappningsinformationen för egenskapen Topic för Event Grid-händelsen.

PersistedConnectionStatus

Status för anslutningen.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint-information.

Name	Typ	Description
id	string	ARM-identifieraren för privat slutpunkt.

PrivateEndpointConnection

Name	Typ	Description
id	string	Fullständigt kvalificerad identifierare för resursen.
name	string	Namn på resursen.
properties.groupIds	string[]	GroupIds från private link-tjänstresursen.
properties.privateEndpoint	PrivateEndpoint	Den privata slutpunktsresursen för den här anslutningen.
properties.privateLinkServiceConnectionState	ConnectionState	Information om anslutningens tillstånd.
properties.provisioningState	ResourceProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
type	string	Resurstyp.

PublicNetworkAccess

Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera

Name	Typ	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Etableringstillstånd för den privata slutpunktsanslutningen.

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

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Topic

EventGrid-ämne

Name	Typ	Standardvärde	Description
id	string		Fullständigt kvalificerad identifierare för resursen.
identity	IdentityInfo		Identitetsinformation för resursen.
location	string		Platsen för resursen.
name	string		Namn på resursen.
properties.dataResidencyBoundary	DataResidencyBoundary		Data Residency resursens gräns.
properties.disableLocalAuth	boolean	False	Det här booleska objektet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är falskt. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till ämnet.
properties.endpoint	string		Slutpunkt för ämnet.
properties.inboundIpRules	InboundIpRule[]		Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa betraktas endast om PublicNetworkAccess är aktiverat.
properties.inputSchema	InputSchema	EventGridSchema	Detta avgör vilket format Event Grid ska förvänta sig för inkommande händelser som publicerats i ämnet.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Detta möjliggör publicering med hjälp av anpassade händelsescheman. En InputSchemaMapping kan anges för att mappa olika egenskaper för ett källschema till olika nödvändiga egenskaper för EventGridEvent-schemat.
properties.metricResourceId	string		Måttresurs-ID för ämnet.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	TopicProvisioningState		Etableringstillstånd för ämnet.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
systemData	systemData		Systemmetadata som relaterar till ämnesresursen.
tags	object		Taggar för resursen.
type	string		Resurstyp.

TopicProvisioningState

Etableringstillstånd för ämnet.

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

TopicUpdateParameters

Egenskaper för ämnesuppdateringen

Name	Typ	Standardvärde	Description
identity	IdentityInfo		Ämnesresursidentitetsinformation.
properties.dataResidencyBoundary	DataResidencyBoundary		Datahemvistgränsen för ämnet.
properties.disableLocalAuth	boolean		Det här booleska objektet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är falskt. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till ämnet.
properties.inboundIpRules	InboundIpRule[]		Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa betraktas endast om PublicNetworkAccess är aktiverat.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
tags	object		Taggar för ämnesresursen.

UserIdentityProperties

Information om användaridentiteten.

Name	Typ	Description
clientId	string	Klient-ID för användartilldelad identitet.
principalId	string	Huvud-ID för användartilldelad identitet.