Partner Topics - Create Or Update

Szolgáltatás:

Event Grid

API-verzió:

2025-02-15

Partnertémakör létrehozása.
Aszinkron módon létrehoz egy új partnertémakört a megadott paraméterekkel.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
partnerTopicName	path	True	string	A partnertéma neve.
resourceGroupName	path	True	string	A felhasználó 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	Kötelező	Típus	Description
location	True	string	Az erőforrás helye.
identity		IdentityInfo	A partnertémakör-erőforrás identitásadatai.
properties.activationState		PartnerTopicActivationState	A partnertéma aktiválási állapota.
properties.eventTypeInfo		EventTypeInfo	Eseménytípus-információk a megfelelő eseménycsatornából.
properties.expirationTimeIfNotActivatedUtc		string (date-time)	A partnertéma lejárati ideje. Ha ez az időzítő lejár, amíg a partnertémakör még mindig nem aktiválódik, a partnertémakör és a kapcsolódó eseménycsatorna 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.partnerRegistrationImmutableId		string (uuid)	A megfelelő partnerregisztráció immutableId azonosítója.
properties.partnerTopicFriendlyDescription		string	A témakör rövid leírása. Ezt a közzétevő/partner beállíthatja az ügyfélpartner-témakör egyéni leírásának megjelenítéséhez. Ez hasznos lesz, ha eltávolítja a partnertéma létrehozásának eredetét az ügyfél számára.
properties.source		string	A partnertémakörhöz társított forrás. Ez egy egyedi partnererőforrást jelöl.
tags		object	Az erőforrás címkéi.

Válaszok

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

Példák

PartnerTopics_CreateOrUpdate

Mintakérelem

HTTP

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

{
  "properties": {
    "partnerRegistrationImmutableId": "6f541064-031d-4cc8-9ec3-a3b4fc0f7185",
    "source": "ContosoCorp.Accounts.User1",
    "expirationTimeIfNotActivatedUtc": "2022-03-23T23:06:13.109Z",
    "partnerTopicFriendlyDescription": "Example description",
    "messageForActivation": "Example message for activation"
  },
  "location": "westus2"
}

Java

import java.time.OffsetDateTime;
import java.util.UUID;

/**
 * Samples for PartnerTopics CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/
     * PartnerTopics_CreateOrUpdate.json
     */
    /**
     * Sample code: PartnerTopics_CreateOrUpdate.
     * 
     * @param manager Entry point to EventGridManager.
     */
    public static void partnerTopicsCreateOrUpdate(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.partnerTopics().define("examplePartnerTopicName1").withRegion("westus2")
            .withExistingResourceGroup("examplerg")
            .withPartnerRegistrationImmutableId(UUID.fromString("6f541064-031d-4cc8-9ec3-a3b4fc0f7185"))
            .withSource("ContosoCorp.Accounts.User1")
            .withExpirationTimeIfNotActivatedUtc(OffsetDateTime.parse("2022-03-23T23:06:13.109Z"))
            .withPartnerTopicFriendlyDescription("Example description")
            .withMessageForActivation("Example message for activation").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 partner_topics_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.partner_topics.create_or_update(
        resource_group_name="examplerg",
        partner_topic_name="examplePartnerTopicName1",
        partner_topic_info={
            "location": "westus2",
            "properties": {
                "expirationTimeIfNotActivatedUtc": "2022-03-23T23:06:13.109Z",
                "messageForActivation": "Example message for activation",
                "partnerRegistrationImmutableId": "6f541064-031d-4cc8-9ec3-a3b4fc0f7185",
                "partnerTopicFriendlyDescription": "Example description",
                "source": "ContosoCorp.Accounts.User1",
            },
        },
    )
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/PartnerTopics_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/PartnerTopics_CreateOrUpdate.json
func ExamplePartnerTopicsClient_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.NewPartnerTopicsClient().CreateOrUpdate(ctx, "examplerg", "examplePartnerTopicName1", armeventgrid.PartnerTopic{
		Location: to.Ptr("westus2"),
		Properties: &armeventgrid.PartnerTopicProperties{
			ExpirationTimeIfNotActivatedUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-23T23:06:13.109Z"); return t }()),
			MessageForActivation:            to.Ptr("Example message for activation"),
			PartnerRegistrationImmutableID:  to.Ptr("6f541064-031d-4cc8-9ec3-a3b4fc0f7185"),
			PartnerTopicFriendlyDescription: to.Ptr("Example description"),
			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.PartnerTopic = armeventgrid.PartnerTopic{
	// 	Name: to.Ptr("examplePartnerTopicName1"),
	// 	Type: to.Ptr("Microsoft.EventGrid/partnerTopics"),
	// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopicName1"),
	// 	Location: to.Ptr("centraluseuap"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("value1"),
	// 		"tag2": to.Ptr("value2"),
	// 	},
	// 	Properties: &armeventgrid.PartnerTopicProperties{
	// 		ActivationState: to.Ptr(armeventgrid.PartnerTopicActivationStateNeverActivated),
	// 		ExpirationTimeIfNotActivatedUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-23T23:06:13.109Z"); return t}()),
	// 		MessageForActivation: to.Ptr("Example message for activation"),
	// 		PartnerRegistrationImmutableID: to.Ptr("6f541064-031d-4cc8-9ec3-a3b4fc0f7185"),
	// 		PartnerTopicFriendlyDescription: to.Ptr("Example description"),
	// 		ProvisioningState: to.Ptr(armeventgrid.PartnerTopicProvisioningStateSucceeded),
	// 		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 Asynchronously creates a new partner topic with the specified parameters.
 *
 * @summary Asynchronously creates a new partner topic with the specified parameters.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/PartnerTopics_CreateOrUpdate.json
 */
async function partnerTopicsCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const partnerTopicName = "examplePartnerTopicName1";
  const partnerTopicInfo = {
    expirationTimeIfNotActivatedUtc: new Date("2022-03-23T23:06:13.109Z"),
    location: "westus2",
    messageForActivation: "Example message for activation",
    partnerRegistrationImmutableId: "6f541064-031d-4cc8-9ec3-a3b4fc0f7185",
    partnerTopicFriendlyDescription: "Example description",
    source: "ContosoCorp.Accounts.User1",
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.partnerTopics.createOrUpdate(
    resourceGroupName,
    partnerTopicName,
    partnerTopicInfo,
  );
  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.Resources;
using Azure.ResourceManager.EventGrid;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/PartnerTopics_CreateOrUpdate.json
// this example is just showing the usage of "PartnerTopics_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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this PartnerTopicResource
PartnerTopicCollection collection = resourceGroupResource.GetPartnerTopics();

// invoke the operation
string partnerTopicName = "examplePartnerTopicName1";
PartnerTopicData data = new PartnerTopicData(new AzureLocation("westus2"))
{
    PartnerRegistrationImmutableId = Guid.Parse("6f541064-031d-4cc8-9ec3-a3b4fc0f7185"),
    Source = "ContosoCorp.Accounts.User1",
    ExpireOnIfNotActivated = DateTimeOffset.Parse("2022-03-23T23:06:13.109Z"),
    PartnerTopicFriendlyDescription = "Example description",
    MessageForActivation = "Example message for activation",
};
ArmOperation<PartnerTopicResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, partnerTopicName, data);
PartnerTopicResource 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
PartnerTopicData 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": {
    "source": "ContosoCorp.Accounts.User1",
    "provisioningState": "Succeeded",
    "activationState": "NeverActivated",
    "partnerRegistrationImmutableId": "6f541064-031d-4cc8-9ec3-a3b4fc0f7185",
    "expirationTimeIfNotActivatedUtc": "2022-03-23T23:06:13.109Z",
    "partnerTopicFriendlyDescription": "Example description",
    "messageForActivation": "Example message for activation"
  },
  "location": "centraluseuap",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopicName1",
  "name": "examplePartnerTopicName1",
  "type": "Microsoft.EventGrid/partnerTopics"
}

Állapotkód:

201

{
  "properties": {
    "source": "ContosoCorp.Accounts.User1",
    "provisioningState": "Succeeded",
    "activationState": "NeverActivated",
    "partnerRegistrationImmutableId": "6f541064-031d-4cc8-9ec3-a3b4fc0f7185",
    "expirationTimeIfNotActivatedUtc": "2022-03-23T23:06:13.109Z",
    "partnerTopicFriendlyDescription": "Example description",
    "messageForActivation": "Example message for activation"
  },
  "location": "centraluseuap",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopicName1",
  "name": "examplePartnerTopicName1",
  "type": "Microsoft.EventGrid/partnerTopics"
}

Definíciók

Name	Description
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.
IdentityInfo	Az erőforrás identitásadatai.
IdentityType	A használt felügyelt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolít minden identitást.
InlineEventProperties	További információk minden beágyazott eseményről.
PartnerTopic	Event Grid partnertémakör.
PartnerTopicActivationState	A partnertéma aktiválási állapota.
PartnerTopicProvisioningState	A partnertéma kiépítési állapota.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserIdentityProperties	A felhasználói identitással kapcsolatos információk.

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.

IdentityInfo

Objektum

Az erőforrás identitásadatai.

Name	Típus	Description
principalId	string	Az erőforrás-identitás egyszerű azonosítója.
tenantId	string	Az erőforrás bérlőazonosítója.
type	IdentityType	A használt felügyelt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolít minden identitást.
userAssignedIdentities	<string,  UserIdentityProperties>	Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai arm-erőforrás-azonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Ez a tulajdonság jelenleg nincs használatban, és a jövőbeni használatra van fenntartva.

IdentityType

Enumerálás

A használt felügyelt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolít minden identitást.

Érték	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

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.

PartnerTopic

Objektum

Event Grid partnertémakör.

Name	Típus	Description
id	string	Az erőforrás teljes azonosítója.
identity	IdentityInfo	A partnertémakör-erőforrás identitásadatai.
location	string	Az erőforrás helye.
name	string	Az erőforrás neve.
properties.activationState	PartnerTopicActivationState	A partnertéma aktiválási állapota.
properties.eventTypeInfo	EventTypeInfo	Eseménytípus-információk a megfelelő eseménycsatornából.
properties.expirationTimeIfNotActivatedUtc	string (date-time)	A partnertéma lejárati ideje. Ha ez az időzítő lejár, amíg a partnertémakör még mindig nem aktiválódik, a partnertémakör és a kapcsolódó eseménycsatorna 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.partnerRegistrationImmutableId	string (uuid)	A megfelelő partnerregisztráció immutableId azonosítója.
properties.partnerTopicFriendlyDescription	string	A témakör rövid leírása. Ezt a közzétevő/partner beállíthatja az ügyfélpartner-témakör egyéni leírásának megjelenítéséhez. Ez hasznos lesz, ha eltávolítja a partnertéma létrehozásának eredetét az ügyfél számára.
properties.provisioningState	PartnerTopicProvisioningState	A partnertéma kiépítési állapota.
properties.source	string	A partnertémakörhöz társított forrás. Ez egy egyedi partnererőforrást jelöl.
systemData	systemData	Az Event Grid-erőforráshoz kapcsolódó rendszer metaadatai.
tags	object	Az erőforrás címkéi.
type	string	Az erőforrás típusa.

PartnerTopicActivationState

Enumerálás

A partnertéma aktiválási állapota.

Érték	Description
Activated
Deactivated
NeverActivated

PartnerTopicProvisioningState

Enumerálás

A partnertéma kiépítési állapota.

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

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.

UserIdentityProperties

Objektum

A felhasználói identitással kapcsolatos információk.

Name	Típus	Description
clientId	string	A felhasználó által hozzárendelt identitás ügyfélazonosítója.
principalId	string	A felhasználó által hozzárendelt identitás egyszerű azonosítója.