Channels - Create Or Update

Servicio:

Event Grid

Versión de la API:

2025-02-15

Cree o actualice un canal.
Crea o actualiza sincrónicamente un nuevo canal con los parámetros especificados.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}?api-version=2025-02-15

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
channelName	path	True	string	Nombre del canal.
partnerNamespaceName	path	True	string	Nombre del espacio de nombres del asociado.
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción de asociados.
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 de cada llamada de servicio.
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
properties.channelType	ChannelType	Tipo del canal de eventos que representa el flujo de dirección de los eventos.
properties.expirationTimeIfNotActivatedUtc	string (date-time)	Hora de expiración del canal. Si este temporizador expira mientras el tema de asociado correspondiente nunca está activado, se eliminan el canal y el tema de asociado correspondiente.
properties.messageForActivation	string	Contexto o mensaje útil que el suscriptor puede usar durante el proceso de aprobación.
properties.partnerTopicInfo	PartnerTopicInfo	Esta propiedad debe rellenarse cuando channelType es PartnerTopic y representa información sobre el recurso del tema del asociado correspondiente al canal.
properties.provisioningState	ChannelProvisioningState	Estado de aprovisionamiento del canal.
properties.readinessState	ReadinessState	Estado de preparación del tema de asociado correspondiente.

Respuestas

Nombre	Tipo	Description
200 OK	Channel	De acuerdo
201 Created	Channel	Creado
Other Status Codes		Respuestas de error: *** 400 Solicitud incorrecta. Error interno del servidor 500.

Ejemplos

Channels_CreateOrUpdate

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1/channels/exampleChannelName1?api-version=2025-02-15

{
  "properties": {
    "channelType": "PartnerTopic",
    "partnerTopicInfo": {
      "azureSubscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
      "resourceGroupName": "examplerg2",
      "name": "examplePartnerTopic1",
      "source": "ContosoCorp.Accounts.User1"
    },
    "messageForActivation": "Example message to approver",
    "expirationTimeIfNotActivatedUtc": "2021-10-21T22:50:25.410433Z"
  }
}

Java

import com.azure.resourcemanager.eventgrid.models.ChannelType;
import com.azure.resourcemanager.eventgrid.models.PartnerTopicInfo;
import java.time.OffsetDateTime;

/**
 * Samples for Channels CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/Channels_CreateOrUpdate.
     * json
     */
    /**
     * Sample code: Channels_CreateOrUpdate.
     * 
     * @param manager Entry point to EventGridManager.
     */
    public static void channelsCreateOrUpdate(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.channels().define("exampleChannelName1")
            .withExistingPartnerNamespace("examplerg", "examplePartnerNamespaceName1")
            .withChannelType(ChannelType.PARTNER_TOPIC)
            .withPartnerTopicInfo(new PartnerTopicInfo().withAzureSubscriptionId("5b4b650e-28b9-4790-b3ab-ddbd88d727c4")
                .withResourceGroupName("examplerg2").withName("examplePartnerTopic1")
                .withSource("ContosoCorp.Accounts.User1"))
            .withMessageForActivation("Example message to approver")
            .withExpirationTimeIfNotActivatedUtc(OffsetDateTime.parse("2021-10-21T22:50:25.410433Z")).create();
    }
}

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 channels_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.channels.create_or_update(
        resource_group_name="examplerg",
        partner_namespace_name="examplePartnerNamespaceName1",
        channel_name="exampleChannelName1",
        channel_info={
            "properties": {
                "channelType": "PartnerTopic",
                "expirationTimeIfNotActivatedUtc": "2021-10-21T22:50:25.410433Z",
                "messageForActivation": "Example message to approver",
                "partnerTopicInfo": {
                    "azureSubscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
                    "name": "examplePartnerTopic1",
                    "resourceGroupName": "examplerg2",
                    "source": "ContosoCorp.Accounts.User1",
                },
            }
        },
    )
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/Channels_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"

	"time"

	"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/Channels_CreateOrUpdate.json
func ExampleChannelsClient_CreateOrUpdate() {
	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)
	}
	res, err := clientFactory.NewChannelsClient().CreateOrUpdate(ctx, "examplerg", "examplePartnerNamespaceName1", "exampleChannelName1", armeventgrid.Channel{
		Properties: &armeventgrid.ChannelProperties{
			ChannelType:                     to.Ptr(armeventgrid.ChannelTypePartnerTopic),
			ExpirationTimeIfNotActivatedUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-21T22:50:25.410Z"); return t }()),
			MessageForActivation:            to.Ptr("Example message to approver"),
			PartnerTopicInfo: &armeventgrid.PartnerTopicInfo{
				Name:                to.Ptr("examplePartnerTopic1"),
				AzureSubscriptionID: to.Ptr("5b4b650e-28b9-4790-b3ab-ddbd88d727c4"),
				ResourceGroupName:   to.Ptr("examplerg2"),
				Source:              to.Ptr("ContosoCorp.Accounts.User1"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.Channel = armeventgrid.Channel{
	// 	Name: to.Ptr("exampleChannelName1"),
	// 	Type: to.Ptr("Microsoft.EventGrid/partnerNamespaces/channels"),
	// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1/changes/exampleChannelName1"),
	// 	Properties: &armeventgrid.ChannelProperties{
	// 		ChannelType: to.Ptr(armeventgrid.ChannelTypePartnerTopic),
	// 		ExpirationTimeIfNotActivatedUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-21T22:50:25.410Z"); return t}()),
	// 		MessageForActivation: to.Ptr("Example message to approver"),
	// 		PartnerTopicInfo: &armeventgrid.PartnerTopicInfo{
	// 			Name: to.Ptr("examplePartnerTopic1"),
	// 			AzureSubscriptionID: to.Ptr("5b4b650e-28b9-4790-b3ab-ddbd88d727c4"),
	// 			ResourceGroupName: to.Ptr("examplerg2"),
	// 			Source: to.Ptr("ContosoCorp.Accounts.User1"),
	// 		},
	// 	},
	// }
}

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 Synchronously creates or updates a new channel with the specified parameters.
 *
 * @summary Synchronously creates or updates a new channel with the specified parameters.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/Channels_CreateOrUpdate.json
 */
async function channelsCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const partnerNamespaceName = "examplePartnerNamespaceName1";
  const channelName = "exampleChannelName1";
  const channelInfo = {
    channelType: "PartnerTopic",
    expirationTimeIfNotActivatedUtc: new Date("2021-10-21T22:50:25.410433Z"),
    messageForActivation: "Example message to approver",
    partnerTopicInfo: {
      name: "examplePartnerTopic1",
      azureSubscriptionId: "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
      resourceGroupName: "examplerg2",
      source: "ContosoCorp.Accounts.User1",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.channels.createOrUpdate(
    resourceGroupName,
    partnerNamespaceName,
    channelName,
    channelInfo,
  );
  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/Channels_CreateOrUpdate.json
// this example is just showing the usage of "Channels_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 PartnerNamespaceResource created on azure
// for more information of creating PartnerNamespaceResource, please refer to the document of PartnerNamespaceResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
string partnerNamespaceName = "examplePartnerNamespaceName1";
ResourceIdentifier partnerNamespaceResourceId = PartnerNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, partnerNamespaceName);
PartnerNamespaceResource partnerNamespace = client.GetPartnerNamespaceResource(partnerNamespaceResourceId);

// get the collection of this PartnerNamespaceChannelResource
PartnerNamespaceChannelCollection collection = partnerNamespace.GetPartnerNamespaceChannels();

// invoke the operation
string channelName = "exampleChannelName1";
PartnerNamespaceChannelData data = new PartnerNamespaceChannelData
{
    ChannelType = PartnerNamespaceChannelType.PartnerTopic,
    PartnerTopicInfo = new PartnerTopicInfo
    {
        AzureSubscriptionId = Guid.Parse("5b4b650e-28b9-4790-b3ab-ddbd88d727c4"),
        ResourceGroupName = "examplerg2",
        Name = "examplePartnerTopic1",
        Source = "ContosoCorp.Accounts.User1",
    },
    MessageForActivation = "Example message to approver",
    ExpireOnIfNotActivated = DateTimeOffset.Parse("2021-10-21T22:50:25.410433Z"),
};
ArmOperation<PartnerNamespaceChannelResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, channelName, data);
PartnerNamespaceChannelResource 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
PartnerNamespaceChannelData 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

Respuesta de muestra

status code:

200

{
  "properties": {
    "channelType": "PartnerTopic",
    "partnerTopicInfo": {
      "azureSubscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
      "resourceGroupName": "examplerg2",
      "name": "examplePartnerTopic1",
      "source": "ContosoCorp.Accounts.User1"
    },
    "messageForActivation": "Example message to approver",
    "expirationTimeIfNotActivatedUtc": "2021-10-21T22:50:25.410433Z"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1/changes/exampleChannelName1",
  "name": "exampleChannelName1",
  "type": "Microsoft.EventGrid/partnerNamespaces/channels"
}

status code:

201

{
  "properties": {
    "channelType": "PartnerTopic",
    "partnerTopicInfo": {
      "azureSubscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
      "resourceGroupName": "examplerg2",
      "name": "examplePartnerTopic1",
      "source": "ContosoCorp.Accounts.User1"
    },
    "messageForActivation": "Example message to approver",
    "expirationTimeIfNotActivatedUtc": "2021-10-21T22:50:25.410433Z"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1/changes/exampleChannelName1",
  "name": "exampleChannelName1",
  "type": "Microsoft.EventGrid/partnerNamespaces/channels"
}

Definiciones

Nombre	Description
Channel	Información del canal.
ChannelProvisioningState	Estado de aprovisionamiento del canal.
ChannelType	Tipo del canal de eventos que representa el flujo de dirección de los eventos.
createdByType	Tipo de identidad que creó el recurso.
EventDefinitionKind	Tipo de evento usado.
EventTypeInfo	Información de tipo de evento para Canales.
InlineEventProperties	Información adicional sobre cada evento insertado.
PartnerTopicInfo	Propiedades del tema de asociado correspondiente de un canal.
ReadinessState	Estado de preparación del tema de asociado correspondiente.
systemData	Metadatos relativos a la creación y última modificación del recurso.

Channel

Object

Información del canal.

Nombre	Tipo	Description
id	string	Identificador completo del recurso.
name	string	Nombre del recurso.
properties.channelType	ChannelType	Tipo del canal de eventos que representa el flujo de dirección de los eventos.
properties.expirationTimeIfNotActivatedUtc	string (date-time)	Hora de expiración del canal. Si este temporizador expira mientras el tema de asociado correspondiente nunca está activado, se eliminan el canal y el tema de asociado correspondiente.
properties.messageForActivation	string	Contexto o mensaje útil que el suscriptor puede usar durante el proceso de aprobación.
properties.partnerTopicInfo	PartnerTopicInfo	Esta propiedad debe rellenarse cuando channelType es PartnerTopic y representa información sobre el recurso del tema del asociado correspondiente al canal.
properties.provisioningState	ChannelProvisioningState	Estado de aprovisionamiento del canal.
properties.readinessState	ReadinessState	Estado de preparación del tema de asociado correspondiente.
systemData	systemData	Metadatos del sistema relacionados con el recurso de Event Grid.
type	string	Tipo del recurso.

ChannelProvisioningState

Enumeración

Estado de aprovisionamiento del canal.

Valor	Description
Canceled
Creating
Deleting
Failed
IdleDueToMirroredPartnerTopicDeletion
Succeeded
Updating

ChannelType

Enumeración

Tipo del canal de eventos que representa el flujo de dirección de los eventos.

Valor	Description
PartnerTopic

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

EventDefinitionKind

Enumeración

Tipo de evento usado.

Valor	Description
Inline

EventTypeInfo

Object

Información de tipo de evento para Canales.

Nombre	Tipo	Description
inlineEventTypes	<string,  InlineEventProperties>	Colección de tipos de eventos insertados para el recurso. Las claves de tipo de evento insertadas son de tipo cadena que representa el nombre del evento. Un ejemplo de un nombre de evento insertado válido es "Contoso.OrderCreated". Los valores de tipo de evento insertado son de tipo InlineEventProperties y contendrán información adicional para cada tipo de evento insertado.
kind	EventDefinitionKind	Tipo de evento usado.

InlineEventProperties

Object

Información adicional sobre cada evento insertado.

Nombre	Tipo	Description
dataSchemaUrl	string	DataSchemaUrl para el evento insertado.
description	string	Descripción del evento insertado.
displayName	string	DisplayName para el evento insertado.
documentationUrl	string	DocumentationUrl para el evento insertado.

PartnerTopicInfo

Object

Propiedades del tema de asociado correspondiente de un canal.

Nombre	Tipo	Description
azureSubscriptionId	string	Identificador de suscripción de Azure del suscriptor. El tema de asociado asociado al canal se creará en esta suscripción de Azure.
eventTypeInfo	EventTypeInfo	Información de tipo de evento para el tema del asociado. El publicador proporciona esta información y el suscriptor puede usar esta información para ver diferentes tipos de eventos publicados.
name	string	Nombre del tema de asociado asociado al canal.
resourceGroupName	string	Grupo de recursos de Azure del suscriptor. El tema del asociado asociado al canal se creará en este grupo de recursos.
source	string	El publicador proporciona la información de origen para determinar el ámbito o el contexto desde el que se originan los eventos. El suscriptor puede usar esta información durante el proceso de aprobación del tema de asociado creado.

ReadinessState

Enumeración

Estado de preparación del tema de asociado correspondiente.

Valor	Description
Activated
NeverActivated

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.