Partner Namespaces - Create Or Update

Service:

Event Grid

API Version:

2022-06-15

建立合作夥伴命名空間。
以異步方式建立具有指定參數的新夥伴命名空間。

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

URI 參數

名稱	位於	必要	類型	Description
partnerNamespaceName	path	True	string	夥伴命名空間的名稱。
resourceGroupName	path	True	string	用戶訂用帳戶內的資源組名。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

要求本文

名稱	必要	類型	Description
location	True	string	資源的位置。
properties.disableLocalAuth		boolean	此布爾值是用來啟用或停用本機驗證。默認值為 false。 當 屬性設定為 true 時，只有 AAD 令牌會用來驗證是否允許使用者發佈至合作夥伴命名空間。
properties.inboundIpRules		InboundIpRule[]	這可以用來限制來自特定IP的流量，而不是所有IP。 注意：只有在啟用 PublicNetworkAccess 時，才會考慮這些專案。
properties.partnerRegistrationFullyQualifiedId		string	應該與此夥伴命名空間相關聯的夥伴註冊完整ARM標識碼。 這會採用下列格式：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}。
properties.partnerTopicRoutingMode		PartnerTopicRoutingMode	這會判斷發佈至此夥伴命名空間的事件是否應該在事件承載中使用來源屬性，或在與夥伴主題相符時，在標頭中使用通道名稱。 如果未指定任何專案，則會使用來源屬性路由來比對夥伴主題。
properties.publicNetworkAccess		PublicNetworkAccess	這會判斷是否允許透過公用網路流量。 默認會啟用它。 您可以藉由設定來進一步限制特定IP
tags		object	資源的標記。

回應

名稱	類型	Description
201 Created	PartnerNamespace	建立時間
Other Status Codes		錯誤回應： ≦ 400 不正確的要求。 500 內部伺服器錯誤。

範例

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

定義

名稱	Description
ConnectionState	ConnectionState 資訊。
createdByType	建立資源的身分識別類型。
InboundIpRule
IpActionType	根據相符專案或不符合 IpMask 執行的動作。
PartnerNamespace	EventGrid 合作夥伴命名空間。
PartnerNamespaceProvisioningState	布建夥伴命名空間的狀態。
PartnerTopicRoutingMode	這會判斷發佈至此夥伴命名空間的事件是否應該在事件承載中使用來源屬性，或在與夥伴主題相符時，在標頭中使用通道名稱。 如果未指定任何專案，則會使用來源屬性路由來比對夥伴主題。
PersistedConnectionStatus	線上的狀態。
PrivateEndpoint	PrivateEndpoint 資訊。
PrivateEndpointConnection
PublicNetworkAccess	這會判斷是否允許透過公用網路流量。 默認會啟用它。 您可以藉由設定來進一步限制特定IP
ResourceProvisioningState	私人端點聯機的布建狀態。
systemData	與建立和上次修改資源相關的元數據。

ConnectionState

ConnectionState 資訊。

名稱	類型	Description
actionsRequired	string	如有任何) ，則 (所需的動作。
description	string	線上狀態的描述。
status	PersistedConnectionStatus	線上的狀態。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

名稱	類型	Description
action	IpActionType	根據相符專案或不符合 IpMask 執行的動作。
ipMask	string	CIDR 表示法中的IP位址，例如10.0.0.0.0/8。

IpActionType

根據相符專案或不符合 IpMask 執行的動作。

名稱	類型	Description
Allow	string

PartnerNamespace

EventGrid 合作夥伴命名空間。

名稱	類型	預設值	Description
id	string		資源的完整標識碼。
location	string		資源的位置。
name	string		資源名稱。
properties.disableLocalAuth	boolean	False	此布爾值是用來啟用或停用本機驗證。默認值為 false。 當 屬性設定為 true 時，只有 AAD 令牌會用來驗證是否允許使用者發佈至合作夥伴命名空間。
properties.endpoint	string		夥伴命名空間的端點。
properties.inboundIpRules	InboundIpRule[]		這可以用來限制來自特定IP的流量，而不是所有IP。 注意：只有在啟用 PublicNetworkAccess 時，才會考慮這些專案。
properties.partnerRegistrationFullyQualifiedId	string		應該與此夥伴命名空間相關聯的夥伴註冊完整ARM標識碼。 這會採用下列格式：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}。
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	這會判斷發佈至此夥伴命名空間的事件是否應該在事件承載中使用來源屬性，或在與夥伴主題相符時，在標頭中使用通道名稱。 如果未指定任何專案，則會使用來源屬性路由來比對夥伴主題。
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		布建夥伴命名空間的狀態。
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	這會判斷是否允許透過公用網路流量。 默認會啟用它。 您可以藉由設定來進一步限制特定IP
systemData	systemData		與合作夥伴命名空間資源相關的系統元數據。
tags	object		資源的標記。
type	string		資源類型。

PartnerNamespaceProvisioningState

布建夥伴命名空間的狀態。

名稱	類型	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerTopicRoutingMode

這會判斷發佈至此夥伴命名空間的事件是否應該在事件承載中使用來源屬性，或在與夥伴主題相符時，在標頭中使用通道名稱。 如果未指定任何專案，則會使用來源屬性路由來比對夥伴主題。

名稱	類型	Description
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

線上的狀態。

名稱	類型	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint 資訊。

名稱	類型	Description
id	string	私人端點的ARM標識碼。

PrivateEndpointConnection

名稱	類型	Description
id	string	資源的完整標識碼。
name	string	資源名稱。
properties.groupIds	string[]	來自私人鏈接服務資源的 GroupId。
properties.privateEndpoint	PrivateEndpoint	此連線的私人端點資源。
properties.privateLinkServiceConnectionState	ConnectionState	線上狀態的詳細數據。
properties.provisioningState	ResourceProvisioningState	私人端點聯機的布建狀態。
type	string	資源類型。

PublicNetworkAccess

這會判斷是否允許透過公用網路流量。 默認會啟用它。 您可以藉由設定來進一步限制特定IP

名稱	類型	Description
Disabled	string
Enabled	string

ResourceProvisioningState

私人端點聯機的布建狀態。

名稱	類型	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。