Topics - Update

Referencia

Servicio:: Event Grid

Versión de la API:: 2022-06-15

Actualizar un tema.
Actualiza de forma asincrónica un tema con los parámetros especificados.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción del usuario.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
topicName	path	True	string	Nombre del tema.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
identity	IdentityInfo	Información de identidad de recursos del tema.
properties.dataResidencyBoundary	DataResidencyBoundary	Límite de residencia de datos para el tema.
properties.disableLocalAuth	boolean	Este valor booleano se usa para habilitar o deshabilitar la autenticación local. El valor predeterminado es false. Cuando la propiedad se establece en true, solo se usará el token de AAD para autenticarse si el usuario puede publicar en el tema.
properties.inboundIpRules	InboundIpRule[]	Esto se puede usar para restringir el tráfico de direcciones IP específicas en lugar de todas las direcciones IP. Nota: Solo se consideran si PublicNetworkAccess está habilitado.
properties.publicNetworkAccess	PublicNetworkAccess	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas mediante la configuración
tags	object	Etiquetas del recurso Tema.

Respuestas

Nombre

Tipo

Description

200 OK

Aceptar

201 Created

Solicitud de actualización de temas aceptada.

Other Status Codes

Respuestas de error: ***

400 Solicitud incorrecta.
500 Internal Server Error.

Ejemplos

Topics_Update

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 200

status code:: 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"
}

Definiciones

Nombre	Description
ConnectionState	Información de ConnectionState.
createdByType	Tipo de identidad que creó el recurso.
DataResidencyBoundary	Data Residency Límite del recurso.
IdentityInfo	Información de identidad del recurso.
IdentityType	Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad.
InboundIpRule
InputSchema	Esto determina el formato que Event Grid debe esperar para los eventos entrantes publicados en el recurso de dominio de Event Grid.
IpActionType	Acción que se va a realizar en función de la coincidencia o ninguna coincidencia de IpMask.
JsonField	Se usa para expresar el origen de una asignación de esquema de entrada para un único campo de destino en el esquema de eventos de Event Grid. Esto se usa actualmente en las asignaciones de las propiedades "id", "topic" y "eventtime". Representa un campo en el esquema de eventos de entrada.
JsonFieldWithDefault	Se usa para expresar el origen de una asignación de esquema de entrada para un único campo de destino en el esquema de eventos de Event Grid. Esto se usa actualmente en las asignaciones de las propiedades "subject", "eventtype" y "dataversion". Representa un campo en el esquema de eventos de entrada junto con un valor predeterminado que se va a usar y se debe proporcionar al menos una de estas dos propiedades.
JsonInputSchemaMapping	Esto permite publicar en Event Grid mediante un esquema de entrada personalizado. Esto se puede usar para asignar propiedades de un esquema JSON de entrada personalizado al esquema de eventos de Event Grid.
PersistedConnectionStatus	Estado de la conexión.
PrivateEndpoint	Información de PrivateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas mediante la configuración
ResourceProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
Topic	Tema de EventGrid
TopicProvisioningState	Estado de aprovisionamiento del tema.
TopicUpdateParameters	Propiedades de la actualización del tema
UserIdentityProperties	Información sobre la identidad del usuario.

ConnectionState

Información de ConnectionState.

Nombre	Tipo	Description
actionsRequired	string	Acciones necesarias (si las hay).
description	string	Descripción del estado de conexión.
status	PersistedConnectionStatus	Estado de la conexión.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataResidencyBoundary

Data Residency Límite del recurso.

Nombre	Tipo	Description
WithinGeopair	string
WithinRegion	string

IdentityInfo

Información de identidad del recurso.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad de recurso.
tenantId	string	Identificador de inquilino del recurso.
type	IdentityType	Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad.
userAssignedIdentities	<string, UserIdentityProperties>	Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Esta propiedad no se usa actualmente y está reservada para uso futuro.

IdentityType

Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad.

Nombre	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

InboundIpRule

Nombre	Tipo	Description
action	IpActionType	Acción que se va a realizar en función de la coincidencia o ninguna coincidencia de IpMask.
ipMask	string	Dirección IP en notación CIDR, por ejemplo, 10.0.0.0/8.

InputSchema

Esto determina el formato que Event Grid debe esperar para los eventos entrantes publicados en el recurso de dominio de Event Grid.

Nombre	Tipo	Description
CloudEventSchemaV1_0	string
CustomEventSchema	string
EventGridSchema	string

IpActionType

Acción que se va a realizar en función de la coincidencia o ninguna coincidencia de IpMask.

Nombre	Tipo	Description
Allow	string

JsonField

Se usa para expresar el origen de una asignación de esquema de entrada para un único campo de destino en el esquema de eventos de Event Grid. Esto se usa actualmente en las asignaciones de las propiedades "id", "topic" y "eventtime". Representa un campo en el esquema de eventos de entrada.

Nombre	Tipo	Description
sourceField	string	Nombre de un campo en el esquema de eventos de entrada que se va a usar como origen de una asignación.

JsonFieldWithDefault

Se usa para expresar el origen de una asignación de esquema de entrada para un único campo de destino en el esquema de eventos de Event Grid. Esto se usa actualmente en las asignaciones de las propiedades "subject", "eventtype" y "dataversion". Representa un campo en el esquema de eventos de entrada junto con un valor predeterminado que se va a usar y se debe proporcionar al menos una de estas dos propiedades.

Nombre	Tipo	Description
defaultValue	string	Valor predeterminado que se va a usar para la asignación cuando no se proporciona un SourceField o si no hay ninguna propiedad con el nombre especificado en la carga del evento JSON publicado.
sourceField	string	Nombre de un campo en el esquema de eventos de entrada que se va a usar como origen de una asignación.

JsonInputSchemaMapping

Esto permite publicar en Event Grid mediante un esquema de entrada personalizado. Esto se puede usar para asignar propiedades de un esquema JSON de entrada personalizado al esquema de eventos de Event Grid.

Nombre	Tipo	Description
inputSchemaMappingType	string: Json	Tipo de la asignación personalizada
properties.dataVersion	JsonFieldWithDefault	Información de asignación de la propiedad DataVersion del evento de Event Grid.
properties.eventTime	JsonField	Información de asignación de la propiedad EventTime del evento de Event Grid.
properties.eventType	JsonFieldWithDefault	Información de asignación de la propiedad EventType del evento de Event Grid.
properties.id	JsonField	Información de asignación de la propiedad Id del evento de Event Grid.
properties.subject	JsonFieldWithDefault	Información de asignación de la propiedad Subject del evento de Event Grid.
properties.topic	JsonField	Información de asignación de la propiedad Topic del evento de Event Grid.

PersistedConnectionStatus

Estado de la conexión.

Nombre	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

Información de PrivateEndpoint.

Nombre	Tipo	Description
id	string	Identificador de ARM para punto de conexión privado.

PrivateEndpointConnection

Nombre	Tipo	Description
id	string	Identificador completo del recurso.
name	string	Nombre del recurso.
properties.groupIds	string[]	GroupIds del recurso del servicio Private Link.
properties.privateEndpoint	PrivateEndpoint	Recurso de punto de conexión privado para esta conexión.
properties.privateLinkServiceConnectionState	ConnectionState	Detalles sobre el estado de la conexión.
properties.provisioningState	ResourceProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.
type	string	Tipo de recurso.

PublicNetworkAccess

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas mediante la configuración

Nombre	Tipo	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Estado de aprovisionamiento de la conexión de punto de conexión privado.

Nombre	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Topic

Tema de EventGrid

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador completo del recurso.
identity	IdentityInfo		Información de identidad del recurso.
location	string		Ubicación del recurso.
name	string		Nombre del recurso.
properties.dataResidencyBoundary	DataResidencyBoundary		Data Residency Límite del recurso.
properties.disableLocalAuth	boolean	False	Este valor booleano se usa para habilitar o deshabilitar la autenticación local. El valor predeterminado es false. Cuando la propiedad se establece en true, solo se usará el token de AAD para autenticarse si el usuario puede publicar en el tema.
properties.endpoint	string		Punto de conexión para el tema.
properties.inboundIpRules	InboundIpRule[]		Esto se puede usar para restringir el tráfico de direcciones IP específicas en lugar de todas las direcciones IP. Nota: Solo se consideran si PublicNetworkAccess está habilitado.
properties.inputSchema	InputSchema	EventGridSchema	Esto determina el formato que Event Grid debe esperar para los eventos entrantes publicados en el tema.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Esto permite la publicación mediante esquemas de eventos personalizados. Se puede especificar InputSchemaMapping para asignar varias propiedades de un esquema de origen a varias propiedades necesarias del esquema EventGridEvent.
properties.metricResourceId	string		Identificador de recurso de métrica para el tema.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	TopicProvisioningState		Estado de aprovisionamiento del tema.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas mediante la configuración
systemData	systemData		Metadatos del sistema relacionados con el recurso Topic.
tags	object		Etiquetas del recurso.
type	string		Tipo de recurso.

TopicProvisioningState

Estado de aprovisionamiento del tema.

Nombre	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

TopicUpdateParameters

Propiedades de la actualización del tema

Nombre	Tipo	Valor predeterminado	Description
identity	IdentityInfo		Información de identidad de recursos del tema.
properties.dataResidencyBoundary	DataResidencyBoundary		Límite de residencia de datos para el tema.
properties.disableLocalAuth	boolean		Este valor booleano se usa para habilitar o deshabilitar la autenticación local. El valor predeterminado es false. Cuando la propiedad se establece en true, solo se usará el token de AAD para autenticarse si el usuario puede publicar en el tema.
properties.inboundIpRules	InboundIpRule[]		Esto se puede usar para restringir el tráfico de direcciones IP específicas en lugar de todas las direcciones IP. Nota: Solo se consideran si PublicNetworkAccess está habilitado.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas mediante la configuración
tags	object		Etiquetas del recurso Tema.

UserIdentityProperties

Información sobre la identidad del usuario.

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la identidad asignada por el usuario.
principalId	string	Identificador principal de la identidad asignada por el usuario.