你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Partner Namespaces - Update

服务:

Event Grid

API 版本:

2022-06-15

更新合作伙伴命名空间。
使用指定的参数异步更新合作伙伴命名空间。

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

URI 参数

名称	在	必需	类型	说明
partnerNamespaceName	path	True	string	合作伙伴命名空间的名称。
resourceGroupName	path	True	string	用户订阅中资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。

请求正文

名称	类型	说明
properties.disableLocalAuth	boolean	此布尔值用于启用或禁用本地身份验证。默认值为 false。 当 属性设置为 true 时，如果用户被允许发布到合作伙伴命名空间，则仅使用 AAD 令牌进行身份验证。
properties.inboundIpRules	InboundIpRule[]	这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意：仅当启用了 PublicNetworkAccess 时，才会考虑这些内容。
properties.publicNetworkAccess	PublicNetworkAccess	这确定是否允许通过公用网络进行流量。 默认情况下，它处于启用状态。 可以通过配置来进一步限制为特定 IP
tags	object	合作伙伴命名空间的标记。

响应

名称	类型	说明
200 OK		确定
201 Created	PartnerNamespace	已接受合作伙伴命名空间更新请求。
Other Status Codes		错误响应：*** 400 错误请求。 500 内部服务器错误。

示例

PartnerNamespaces_Update

示例请求

HTTP

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

{
  "tags": {
    "tag1": "value1"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.eventgrid.models.PartnerNamespace;
import java.util.HashMap;
import java.util.Map;

/** Samples for PartnerNamespaces Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_Update.json
     */
    /**
     * Sample code: PartnerNamespaces_Update.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void partnerNamespacesUpdate(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        PartnerNamespace resource =
            manager
                .partnerNamespaces()
                .getByResourceGroupWithResponse("examplerg", "examplePartnerNamespaceName1", Context.NONE)
                .getValue();
        resource.update().withTags(mapOf("tag1", "value1")).apply();
    }

    @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_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_update(
        resource_group_name="examplerg",
        partner_namespace_name="examplePartnerNamespaceName1",
        partner_namespace_update_parameters={"tags": {"tag1": "value1"}},
    ).result()
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_Update.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_Update.json
func ExamplePartnerNamespacesClient_BeginUpdate() {
	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().BeginUpdate(ctx, "examplerg", "examplePartnerNamespaceName1", armeventgrid.PartnerNamespaceUpdateParameters{
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
		},
	}, 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 updates a partner namespace with the specified parameters.
 *
 * @summary Asynchronously updates a partner namespace with the specified parameters.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_Update.json
 */
async function partnerNamespacesUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const partnerNamespaceName = "examplePartnerNamespaceName1";
  const partnerNamespaceUpdateParameters = {
    tags: { tag1: "value1" },
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.partnerNamespaces.beginUpdateAndWait(
    resourceGroupName,
    partnerNamespaceName,
    partnerNamespaceUpdateParameters
  );
  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.EventGrid.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_Update.json
// this example is just showing the usage of "PartnerNamespaces_Update" 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);

// invoke the operation
PartnerNamespacePatch patch = new PartnerNamespacePatch()
{
    Tags =
    {
    ["tag1"] = "value1",
    },
};
await partnerNamespace.UpdateAsync(WaitUntil.Completed, patch);

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

状态代码:

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": "Central US EUAP",
  "tags": {
    "key1": "value1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1",
  "name": "examplePartnerNamespaceName1",
  "type": "Microsoft.EventGrid/partnerNamespaces"
}

定义

名称	说明
ConnectionState	ConnectionState 信息。
createdByType	创建资源的标识类型。
InboundIpRule
IpActionType	要根据 IpMask 的匹配项或不匹配执行的操作。
PartnerNamespace	EventGrid 合作伙伴命名空间。
PartnerNamespaceProvisioningState	合作伙伴命名空间的预配状态。
PartnerNamespaceUpdateParameters	合作伙伴命名空间更新的属性。
PartnerTopicRoutingMode	这将确定发布到此合作伙伴命名空间的事件是否应在事件有效负载中使用源属性，或者在与合作伙伴主题匹配时使用标头中的通道名称。 如果未指定源属性路由，则将使用源属性路由来匹配合作伙伴主题。
PersistedConnectionStatus	连接状态。
PrivateEndpoint	PrivateEndpoint 信息。
PrivateEndpointConnection
PublicNetworkAccess	这确定是否允许通过公用网络进行流量。 默认情况下，它处于启用状态。 可以通过配置来进一步限制为特定 IP
ResourceProvisioningState	专用终结点连接的预配状态。
systemData	与资源的创建和上次修改相关的元数据。

ConnectionState

ConnectionState 信息。

名称	类型	说明
actionsRequired	string	如果有任何) ， (所需的操作。
description	string	连接状态的说明。
status	PersistedConnectionStatus	连接状态。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

名称	类型	说明
action	IpActionType	要根据 IpMask 的匹配项或不匹配执行的操作。
ipMask	string	采用 CIDR 表示法的 IP 地址，例如 10.0.0.0/8。

IpActionType

要根据 IpMask 的匹配项或不匹配执行的操作。

名称	类型	说明
Allow	string

PartnerNamespace

EventGrid 合作伙伴命名空间。

名称	类型	默认值	说明
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 ID。 采用以下格式：/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

合作伙伴命名空间的预配状态。

名称	类型	说明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerNamespaceUpdateParameters

合作伙伴命名空间更新的属性。

名称	类型	默认值	说明
properties.disableLocalAuth	boolean		此布尔值用于启用或禁用本地身份验证。默认值为 false。 当 属性设置为 true 时，如果用户被允许发布到合作伙伴命名空间，则仅使用 AAD 令牌进行身份验证。
properties.inboundIpRules	InboundIpRule[]		这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意：仅当启用了 PublicNetworkAccess 时，才会考虑这些内容。
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	这确定是否允许通过公用网络进行流量。 默认情况下，它处于启用状态。 可以通过配置来进一步限制为特定 IP
tags	object		合作伙伴命名空间的标记。

PartnerTopicRoutingMode

这将确定发布到此合作伙伴命名空间的事件是否应在事件有效负载中使用源属性，或者在与合作伙伴主题匹配时使用标头中的通道名称。 如果未指定源属性路由，则将使用源属性路由来匹配合作伙伴主题。

名称	类型	说明
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

连接状态。

名称	类型	说明
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint 信息。

名称	类型	说明
id	string	专用终结点的 ARM 标识符。

PrivateEndpointConnection

名称	类型	说明
id	string	资源的完全限定标识符。
name	string	资源的名称。
properties.groupIds	string[]	专用链接服务资源的 GroupIds。
properties.privateEndpoint	PrivateEndpoint	此连接的专用终结点资源。
properties.privateLinkServiceConnectionState	ConnectionState	有关连接状态的详细信息。
properties.provisioningState	ResourceProvisioningState	专用终结点连接的预配状态。
type	string	资源的类型。

PublicNetworkAccess

这确定是否允许通过公用网络进行流量。 默认情况下，它处于启用状态。 可以通过配置来进一步限制为特定 IP

名称	类型	说明
Disabled	string
Enabled	string

ResourceProvisioningState

专用终结点连接的预配状态。

名称	类型	说明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。