Partner Namespaces - Create Or Update

Service:

Event Grid

API Version:

2022-06-15

Utwórz przestrzeń nazw partnera.
Asynchronicznie tworzy nową przestrzeń nazw partnera z określonymi parametrami.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
partnerNamespaceName	path	True	string	Nazwa przestrzeni nazw partnera.
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji użytkownika.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja zasobu.
properties.disableLocalAuth		boolean	Ta wartość logiczna służy do włączania lub wyłączania uwierzytelniania lokalnego. Wartość domyślna to false. Jeśli właściwość jest ustawiona na wartość true, tylko token usługi AAD będzie używany do uwierzytelniania, jeśli użytkownik może publikować dane w przestrzeni nazw partnera.
properties.inboundIpRules		InboundIpRule[]	Może to służyć do ograniczania ruchu z określonych adresów IP zamiast wszystkich adresów IP. Uwaga: są one brane pod uwagę tylko wtedy, gdy funkcja PublicNetworkAccess jest włączona.
properties.partnerRegistrationFullyQualifiedId		string	W pełni kwalifikowany identyfikator arm rejestracji partnera, który powinien być skojarzony z tą przestrzenią nazw partnera. Ma to następujący format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode		PartnerTopicRoutingMode	Określa to, czy zdarzenia opublikowane w tej przestrzeni nazw partnera powinny używać atrybutu źródłowego w ładunku zdarzenia lub użyć nazwy kanału w nagłówku podczas dopasowywania do tematu partnera. Jeśli żaden z nich nie zostanie określony, routing atrybutów źródłowych będzie używany do dopasowania do tematu partnera.
properties.publicNetworkAccess		PublicNetworkAccess	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest ona włączona. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując
tags		object	Tagi zasobu.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	PartnerNamespace	Utworzone
Other Status Codes		Odpowiedzi na błędy: *** 400 Nieprawidłowe żądanie. 500 Wewnętrzny błąd serwera.

Przykłady

PartnerNamespaces_CreateOrUpdate

Sample Request

HTTP

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

{
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1"
  }
}

Java

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

/** Samples for PartnerNamespaces CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_CreateOrUpdate.json
     */
    /**
     * Sample code: PartnerNamespaces_CreateOrUpdate.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void partnerNamespacesCreateOrUpdate(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager
            .partnerNamespaces()
            .define("examplePartnerNamespaceName1")
            .withRegion("westus")
            .withExistingResourceGroup("examplerg")
            .withTags(mapOf("tag1", "value1", "tag2", "value2"))
            .withPartnerRegistrationFullyQualifiedId(
                "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1")
            .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_namespaces_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_namespaces.begin_create_or_update(
        resource_group_name="examplerg",
        partner_namespace_name="examplePartnerNamespaceName1",
        partner_namespace_info={
            "location": "westus",
            "properties": {
                "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1"
            },
            "tags": {"tag1": "value1", "tag2": "value2"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_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/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_CreateOrUpdate.json
func ExamplePartnerNamespacesClient_BeginCreateOrUpdate() {
	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.NewPartnerNamespacesClient().BeginCreateOrUpdate(ctx, "examplerg", "examplePartnerNamespaceName1", armeventgrid.PartnerNamespace{
		Location: to.Ptr("westus"),
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
		Properties: &armeventgrid.PartnerNamespaceProperties{
			PartnerRegistrationFullyQualifiedID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1"),
		},
	}, 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

JavaScript

const { EventGridManagementClient } = require("@azure/arm-eventgrid");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Asynchronously creates a new partner namespace with the specified parameters.
 *
 * @summary Asynchronously creates a new partner namespace with the specified parameters.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_CreateOrUpdate.json
 */
async function partnerNamespacesCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const partnerNamespaceName = "examplePartnerNamespaceName1";
  const partnerNamespaceInfo = {
    location: "westus",
    partnerRegistrationFullyQualifiedId:
      "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1",
    tags: { tag1: "value1", tag2: "value2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.partnerNamespaces.beginCreateOrUpdateAndWait(
    resourceGroupName,
    partnerNamespaceName,
    partnerNamespaceInfo
  );
  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/PartnerNamespaces_CreateOrUpdate.json
// this example is just showing the usage of "PartnerNamespaces_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 PartnerNamespaceResource
PartnerNamespaceCollection collection = resourceGroupResource.GetPartnerNamespaces();

// invoke the operation
string partnerNamespaceName = "examplePartnerNamespaceName1";
PartnerNamespaceData data = new PartnerNamespaceData(new AzureLocation("westus"))
{
    PartnerRegistrationFullyQualifiedId = new ResourceIdentifier("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1"),
    Tags =
    {
    ["tag1"] = "value1",
    ["tag2"] = "value2",
    },
};
ArmOperation<PartnerNamespaceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, partnerNamespaceName, data);
PartnerNamespaceResource 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
PartnerNamespaceData 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:

201

{
  "properties": {
    "provisioningState": "Succeeded",
    "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1",
    "endpoint": "https://examplePartnerNamespaceName1.centraluseuap-1.eventgrid.azure.net/api/events"
  },
  "location": "westus",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1",
  "name": "examplePartnerNamespaceName1",
  "type": "Microsoft.EventGrid/partnerNamespaces"
}

Definicje

Nazwa	Opis
ConnectionState	Informacje o stanie połączenia.
createdByType	Typ tożsamości, która utworzyła zasób.
InboundIpRule
IpActionType	Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask.
PartnerNamespace	EventGrid Partner Namespace.EventGrid Partner Namespace (Przestrzeń nazw partnera usługi EventGrid).
PartnerNamespaceProvisioningState	Stan aprowizacji przestrzeni nazw partnera.
PartnerTopicRoutingMode	Określa to, czy zdarzenia opublikowane w tej przestrzeni nazw partnera powinny używać atrybutu źródłowego w ładunku zdarzenia lub użyć nazwy kanału w nagłówku podczas dopasowywania do tematu partnera. Jeśli żaden z nich nie zostanie określony, routing atrybutów źródłowych będzie używany do dopasowania do tematu partnera.
PersistedConnectionStatus	Stan połączenia.
PrivateEndpoint	Informacje dotyczące prywatnego punktu końcowego.
PrivateEndpointConnection
PublicNetworkAccess	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest ona włączona. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując
ResourceProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ConnectionState

Informacje o stanie połączenia.

Nazwa	Typ	Opis
actionsRequired	string	Wymagane akcje (jeśli istnieją).
description	string	Opis stanu połączenia.
status	PersistedConnectionStatus	Stan połączenia.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Nazwa	Typ	Opis
action	IpActionType	Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask.
ipMask	string	Adres IP w notacji CIDR, np. 10.0.0.0/8.

IpActionType

Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask.

Nazwa	Typ	Opis
Allow	string

PartnerNamespace

EventGrid Partner Namespace.EventGrid Partner Namespace (Przestrzeń nazw partnera usługi EventGrid).

Nazwa	Typ	Wartość domyślna	Opis
id	string		W pełni kwalifikowany identyfikator zasobu.
location	string		Lokalizacja zasobu.
name	string		Nazwa zasobu.
properties.disableLocalAuth	boolean	False	Ta wartość logiczna służy do włączania lub wyłączania uwierzytelniania lokalnego. Wartość domyślna to false. Jeśli właściwość jest ustawiona na wartość true, tylko token usługi AAD będzie używany do uwierzytelniania, jeśli użytkownik może publikować dane w przestrzeni nazw partnera.
properties.endpoint	string		Punkt końcowy dla przestrzeni nazw partnera.
properties.inboundIpRules	InboundIpRule[]		Może to służyć do ograniczania ruchu z określonych adresów IP zamiast wszystkich adresów IP. Uwaga: są one brane pod uwagę tylko wtedy, gdy funkcja PublicNetworkAccess jest włączona.
properties.partnerRegistrationFullyQualifiedId	string		W pełni kwalifikowany identyfikator arm rejestracji partnera, który powinien być skojarzony z tą przestrzenią nazw partnera. Ma to następujący format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Określa to, czy zdarzenia opublikowane w tej przestrzeni nazw partnera powinny używać atrybutu źródłowego w ładunku zdarzenia lub użyć nazwy kanału w nagłówku podczas dopasowywania do tematu partnera. Jeśli żaden z nich nie zostanie określony, routing atrybutów źródłowych będzie używany do dopasowania do tematu partnera.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		Stan aprowizacji przestrzeni nazw partnera.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest ona włączona. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując
systemData	systemData		Metadane systemowe odnoszące się do zasobu przestrzeni nazw partnera.
tags	object		Tagi zasobu.
type	string		Typ zasobu.

PartnerNamespaceProvisioningState

Stan aprowizacji przestrzeni nazw partnera.

Nazwa	Typ	Opis
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerTopicRoutingMode

Określa to, czy zdarzenia opublikowane w tej przestrzeni nazw partnera powinny używać atrybutu źródłowego w ładunku zdarzenia lub użyć nazwy kanału w nagłówku podczas dopasowywania do tematu partnera. Jeśli żaden z nich nie zostanie określony, routing atrybutów źródłowych będzie używany do dopasowania do tematu partnera.

Nazwa	Typ	Opis
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

Stan połączenia.

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

Informacje dotyczące prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Identyfikator usługi ARM dla prywatnego punktu końcowego.

PrivateEndpointConnection

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu.
name	string	Nazwa zasobu.
properties.groupIds	string[]	GroupIds z zasobu usługi łącza prywatnego.
properties.privateEndpoint	PrivateEndpoint	Zasób prywatnego punktu końcowego dla tego połączenia.
properties.privateLinkServiceConnectionState	ConnectionState	Szczegółowe informacje o stanie połączenia.
properties.provisioningState	ResourceProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
type	string	Typ zasobu.

PublicNetworkAccess

Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest ona włączona. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując

Nazwa	Typ	Opis
Disabled	string
Enabled	string

ResourceProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.