Channels - Create Or Update

Szolgáltatás:

Event Grid

API-verzió:

2025-02-15

Csatorna létrehozása vagy frissítése.
Szinkron módon létrehoz vagy frissít egy új csatornát a megadott paraméterekkel.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
channelName	path	True	string	A csatorna neve.
partnerNamespaceName	path	True	string	A partnernévtér neve.
resourceGroupName	path	True	string	A partnerek előfizetésében lévő erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója.

Kérelem törzse

Name	Típus	Description
properties.channelType	ChannelType	Az eseménycsatorna típusa, amely az események irányfolyamát jelöli.
properties.expirationTimeIfNotActivatedUtc	string (date-time)	A csatorna lejárati ideje. Ha ez az időzítő lejár, amíg a megfelelő partnertémakör soha nem aktiválódik, a csatorna és a megfelelő partnertémakör törlődik.
properties.messageForActivation	string	Az előfizető által a jóváhagyási folyamat során használható környezet vagy hasznos üzenet.
properties.partnerTopicInfo	PartnerTopicInfo	Ezt a tulajdonságot akkor kell kitölteni, ha a channelType partnertopikus, és a csatornának megfelelő partnertémakör-erőforrás adatait jelöli.
properties.provisioningState	ChannelProvisioningState	A csatorna kiépítési állapota.
properties.readinessState	ReadinessState	A megfelelő partnertéma felkészültségi állapota.

Válaszok

Name	Típus	Description
200 OK	Channel	OKÉ
201 Created	Channel	Létrehozott
Other Status Codes		Hibaválaszok: *** 400 Rossz kérés. 500 belső kiszolgálóhiba.

Példák

Channels_CreateOrUpdate

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Állapotkód:

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

Definíciók

Name	Description
Channel	Csatornaadatok.
ChannelProvisioningState	A csatorna kiépítési állapota.
ChannelType	Az eseménycsatorna típusa, amely az események irányfolyamát jelöli.
createdByType	Az erőforrást létrehozó identitás típusa.
EventDefinitionKind	A használt esemény típusa.
EventTypeInfo	A Csatornák eseménytípus-információi.
InlineEventProperties	További információk minden beágyazott eseményről.
PartnerTopicInfo	A csatorna megfelelő partnertémakörének tulajdonságai.
ReadinessState	A megfelelő partnertéma felkészültségi állapota.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Channel

Objektum

Csatornaadatok.

Name	Típus	Description
id	string	Az erőforrás teljes azonosítója.
name	string	Az erőforrás neve.
properties.channelType	ChannelType	Az eseménycsatorna típusa, amely az események irányfolyamát jelöli.
properties.expirationTimeIfNotActivatedUtc	string (date-time)	A csatorna lejárati ideje. Ha ez az időzítő lejár, amíg a megfelelő partnertémakör soha nem aktiválódik, a csatorna és a megfelelő partnertémakör törlődik.
properties.messageForActivation	string	Az előfizető által a jóváhagyási folyamat során használható környezet vagy hasznos üzenet.
properties.partnerTopicInfo	PartnerTopicInfo	Ezt a tulajdonságot akkor kell kitölteni, ha a channelType partnertopikus, és a csatornának megfelelő partnertémakör-erőforrás adatait jelöli.
properties.provisioningState	ChannelProvisioningState	A csatorna kiépítési állapota.
properties.readinessState	ReadinessState	A megfelelő partnertéma felkészültségi állapota.
systemData	systemData	Az Event Grid-erőforráshoz kapcsolódó rendszer metaadatai.
type	string	Az erőforrás típusa.

ChannelProvisioningState

Enumerálás

A csatorna kiépítési állapota.

Érték	Description
Canceled
Creating
Deleting
Failed
IdleDueToMirroredPartnerTopicDeletion
Succeeded
Updating

ChannelType

Enumerálás

Az eseménycsatorna típusa, amely az események irányfolyamát jelöli.

Érték	Description
PartnerTopic

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

EventDefinitionKind

Enumerálás

A használt esemény típusa.

Érték	Description
Inline

EventTypeInfo

Objektum

A Csatornák eseménytípus-információi.

Name	Típus	Description
inlineEventTypes	<string,  InlineEventProperties>	Az erőforrás beágyazott eseménytípusainak gyűjteménye. A beágyazott eseménytípus-kulcsok sztring típusúak, amelyek az esemény nevét jelölik. Egy érvényes beágyazott eseménynév például a "Contoso.OrderCreated". A beágyazott eseménytípus értékei InlineEventProperties típusúak, és minden beágyazott eseménytípushoz további információkat tartalmaznak.
kind	EventDefinitionKind	A használt esemény típusa.

InlineEventProperties

Objektum

További információk minden beágyazott eseményről.

Name	Típus	Description
dataSchemaUrl	string	A dataSchemaUrl a beágyazott eseményhez.
description	string	A beágyazott esemény leírása.
displayName	string	A beágyazott esemény displayName neve.
documentationUrl	string	A beágyazott esemény dokumentációja.

PartnerTopicInfo

Objektum

A csatorna megfelelő partnertémakörének tulajdonságai.

Name	Típus	Description
azureSubscriptionId	string	Az előfizető Azure-előfizetés-azonosítója. A csatornához társított partnertémakör ebben az Azure-előfizetésben jön létre.
eventTypeInfo	EventTypeInfo	A partnertéma eseménytípus-információi. Ezeket az információkat a közzétevő adja meg, és az előfizető felhasználhatja a közzétett események különböző típusainak megtekintésére.
name	string	A csatornához társított partnertémakör neve.
resourceGroupName	string	Az előfizető Azure-erőforráscsoportja. A csatornához társított partnertémakör ebben az erőforráscsoportban jön létre.
source	string	A forrásinformációkat a közzétevő adja meg annak a hatókörnek vagy környezetnek a meghatározásához, amelyből az események származnak. Ezeket az információkat az előfizető felhasználhatja a létrehozott partnertéma jóváhagyási folyamata során.

ReadinessState

Enumerálás

A megfelelő partnertéma felkészültségi állapota.

Érték	Description
Activated
NeverActivated

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.