Partner Registrations - Create Or Update

Service:

Event Grid

API Version:

2022-06-15

Create a partner registration.
Creates a new partner registration with the specified parameters.

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

URI Parameters

Name	In	Required	Type	Description
partnerRegistrationName	path	True	string	Name of the partner registration.
resourceGroupName	path	True	string	The name of the resource group within the user's subscription.
subscriptionId	path	True	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Version of the API to be used with the client request.

Request Body

Name	Required	Type	Description
location	True	string	Location of the resource.
properties.partnerRegistrationImmutableId		string	The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version
tags		object	Tags of the resource.

Responses

Name	Type	Description
200 OK	PartnerRegistration	OK
202 Accepted	PartnerRegistration	Accepted
Other Status Codes		*** Error Responses: *** 400 Bad Request. 404 Not Found. 500 Internal Server Error.

Examples

PartnerRegistrations_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/examplePartnerRegistrationName1?api-version=2022-06-15

{
  "location": "global",
  "tags": {
    "key1": "value1",
    "key2": "Value2",
    "key3": "Value3"
  }
}

Java

import java.util.HashMap;
import java.util.Map;

/** Samples for PartnerRegistrations CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerRegistrations_CreateOrUpdate.json
     */
    /**
     * Sample code: PartnerRegistrations_CreateOrUpdate.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void partnerRegistrationsCreateOrUpdate(
        com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager
            .partnerRegistrations()
            .define("examplePartnerRegistrationName1")
            .withRegion("global")
            .withExistingResourceGroup("examplerg")
            .withTags(mapOf("key1", "value1", "key2", "Value2", "key3", "Value3"))
            .create();
    }

    @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

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_registrations_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_registrations.begin_create_or_update(
        resource_group_name="examplerg",
        partner_registration_name="examplePartnerRegistrationName1",
        partner_registration_info={
            "location": "global",
            "tags": {"key1": "value1", "key2": "Value2", "key3": "Value3"},
        },
    ).result()
    print(response)


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

	"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/tree/main/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerRegistrations_CreateOrUpdate.json
func ExamplePartnerRegistrationsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armeventgrid.NewPartnerRegistrationsClient("5b4b650e-28b9-4790-b3ab-ddbd88d727c4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"examplerg",
		"examplePartnerRegistrationName1",
		armeventgrid.PartnerRegistration{
			Location: to.Ptr("global"),
			Tags: map[string]*string{
				"key1": to.Ptr("value1"),
				"key2": to.Ptr("Value2"),
				"key3": to.Ptr("Value3"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

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");

/**
 * This sample demonstrates how to Creates a new partner registration with the specified parameters.
 *
 * @summary Creates a new partner registration with the specified parameters.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerRegistrations_CreateOrUpdate.json
 */
async function partnerRegistrationsCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const partnerRegistrationName = "examplePartnerRegistrationName1";
  const partnerRegistrationInfo = {
    location: "global",
    tags: { key1: "value1", key2: "Value2", key3: "Value3" },
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.partnerRegistrations.beginCreateOrUpdateAndWait(
    resourceGroupName,
    partnerRegistrationName,
    partnerRegistrationInfo
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.EventGrid;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerRegistrations_CreateOrUpdate.json
// this example is just showing the usage of "PartnerRegistrations_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 PartnerRegistrationResource
PartnerRegistrationCollection collection = resourceGroupResource.GetPartnerRegistrations();

// invoke the operation
string partnerRegistrationName = "examplePartnerRegistrationName1";
PartnerRegistrationData data = new PartnerRegistrationData(new AzureLocation("global"))
{
    Tags =
    {
    ["key1"] = "value1",
    ["key2"] = "Value2",
    ["key3"] = "Value3",
    },
};
ArmOperation<PartnerRegistrationResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, partnerRegistrationName, data);
PartnerRegistrationResource 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
PartnerRegistrationData 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

Sample Response

Status code:

200

{
  "properties": {
    "provisioningState": "Succeeded",
    "partnerRegistrationImmutableId": "6a1e637f-1495-4938-bf46-ff468b9a75d2"
  },
  "location": "global",
  "tags": {
    "key1": "value1",
    "key2": "Value2",
    "key3": "Value3"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/examplePartnerRegistrationName1",
  "name": "examplePartnerRegistrationName1",
  "type": "Microsoft.EventGrid/partnerRegistrations"
}

Status code:

202

{
  "properties": {
    "provisioningState": "Succeeded",
    "partnerRegistrationImmutableId": "6a1e637f-1495-4938-bf46-ff468b9a75d2"
  },
  "location": "global",
  "tags": {
    "key1": "value1",
    "key2": "Value2",
    "key3": "Value3"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/examplePartnerRegistrationName1",
  "name": "examplePartnerRegistrationName1",
  "type": "Microsoft.EventGrid/partnerRegistrations"
}

Definitions

createdByType	The type of identity that created the resource.
PartnerRegistration	Information about a partner registration.
PartnerRegistrationProvisioningState	Provisioning state of the partner registration.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

PartnerRegistration

Information about a partner registration.

Name	Type	Description
id	string	Fully qualified identifier of the resource.
location	string	Location of the resource.
name	string	Name of the resource.
properties.partnerRegistrationImmutableId	string	The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version
properties.provisioningState	PartnerRegistrationProvisioningState	Provisioning state of the partner registration.
systemData	systemData	The system metadata relating to Partner Registration resource.
tags	object	Tags of the resource.
type	string	Type of the resource.

PartnerRegistrationProvisioningState

Provisioning state of the partner registration.

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

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.