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 매개 변수

Name	In(다음 안에)	필수	형식	Description
partnerNamespaceName	path	True	string	파트너 네임스페이스의 이름입니다.
resourceGroupName	path	True	string	사용자의 구독 내에서 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다.

요청 본문

Name	형식	Description
properties.disableLocalAuth	boolean	이 부울은 로컬 인증을 사용하거나 사용하지 않도록 설정하는 데 사용됩니다. 기본값은 false입니다. 속성이 true로 설정되면 사용자가 파트너 네임스페이스에 게시할 수 있는 경우 AAD 토큰만 인증하는 데 사용됩니다.
properties.inboundIpRules	InboundIpRule[]	모든 IP 대신 특정 IP의 트래픽을 제한하는 데 사용할 수 있습니다. 참고: PublicNetworkAccess를 사용하는 경우에만 고려됩니다.
properties.publicNetworkAccess	PublicNetworkAccess	이렇게 하면 공용 네트워크를 통해 트래픽이 허용되는지 여부가 결정됩니다. 기본적으로 사용하도록 설정됩니다. 구성하여 특정 IP로 더 제한할 수 있습니다.
tags	object	파트너 네임스페이스의 태그입니다.

응답

Name	형식	Description
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"
}

정의

Name	Description
ConnectionState	ConnectionState 정보입니다.
createdByType	리소스를 만든 ID의 형식입니다.
InboundIpRule
IpActionType	IpMask의 일치 또는 일치 여부에 따라 수행할 작업입니다.
PartnerNamespace	EventGrid 파트너 네임스페이스.
PartnerNamespaceProvisioningState	파트너 네임스페이스의 프로비전 상태입니다.
PartnerNamespaceUpdateParameters	파트너 네임스페이스 업데이트의 속성입니다.
PartnerTopicRoutingMode	이 파트너 네임스페이스에 게시된 이벤트가 이벤트 페이로드에서 원본 특성을 사용하거나 파트너 토픽과 일치할 때 헤더의 채널 이름을 사용해야 하는지 여부를 결정합니다. 지정하지 않으면 원본 특성 라우팅이 파트너 토픽과 일치하는 데 사용됩니다.
PersistedConnectionStatus	연결의 상태입니다.
PrivateEndpoint	PrivateEndpoint 정보입니다.
PrivateEndpointConnection
PublicNetworkAccess	이렇게 하면 공용 네트워크를 통해 트래픽이 허용되는지 여부가 결정됩니다. 기본적으로 사용하도록 설정됩니다. 구성하여 특정 IP로 더 제한할 수 있습니다.
ResourceProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

ConnectionState

ConnectionState 정보입니다.

Name	형식	Description
actionsRequired	string	필요한 작업(있는 경우).
description	string	연결 상태에 대한 설명입니다.
status	PersistedConnectionStatus	연결의 상태입니다.

createdByType

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Name	형식	Description
action	IpActionType	IpMask의 일치 또는 일치 여부에 따라 수행할 작업입니다.
ipMask	string	CIDR 표기법의 IP 주소(예: 10.0.0.0/8).

IpActionType

IpMask의 일치 또는 일치 여부에 따라 수행할 작업입니다.

Name	형식	Description
Allow	string

PartnerNamespace

EventGrid 파트너 네임스페이스.

Name	형식	Default value	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 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

파트너 네임스페이스의 프로비전 상태입니다.

Name	형식	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerNamespaceUpdateParameters

파트너 네임스페이스 업데이트의 속성입니다.

Name	형식	Default value	Description
properties.disableLocalAuth	boolean		이 부울은 로컬 인증을 사용하거나 사용하지 않도록 설정하는 데 사용됩니다. 기본값은 false입니다. 속성이 true로 설정되면 사용자가 파트너 네임스페이스에 게시할 수 있는 경우 AAD 토큰만 인증하는 데 사용됩니다.
properties.inboundIpRules	InboundIpRule[]		모든 IP 대신 특정 IP의 트래픽을 제한하는 데 사용할 수 있습니다. 참고: PublicNetworkAccess를 사용하는 경우에만 고려됩니다.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	이렇게 하면 공용 네트워크를 통해 트래픽이 허용되는지 여부가 결정됩니다. 기본적으로 사용하도록 설정됩니다. 구성하여 특정 IP로 더 제한할 수 있습니다.
tags	object		파트너 네임스페이스의 태그입니다.

PartnerTopicRoutingMode

이 파트너 네임스페이스에 게시된 이벤트가 이벤트 페이로드에서 원본 특성을 사용하거나 파트너 토픽과 일치할 때 헤더의 채널 이름을 사용해야 하는지 여부를 결정합니다. 지정하지 않으면 원본 특성 라우팅이 파트너 토픽과 일치하는 데 사용됩니다.

Name	형식	Description
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

연결의 상태입니다.

Name	형식	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint 정보입니다.

Name	형식	Description
id	string	프라이빗 엔드포인트에 대한 ARM 식별자입니다.

PrivateEndpointConnection

Name	형식	Description
id	string	리소스의 정규화된 식별자입니다.
name	string	리소스의 이름입니다.
properties.groupIds	string[]	프라이빗 링크 서비스 리소스의 GroupId입니다.
properties.privateEndpoint	PrivateEndpoint	이 연결에 대한 프라이빗 엔드포인트 리소스입니다.
properties.privateLinkServiceConnectionState	ConnectionState	연결 상태에 대한 세부 정보입니다.
properties.provisioningState	ResourceProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.
type	string	리소스 유형입니다.

PublicNetworkAccess

이렇게 하면 공용 네트워크를 통해 트래픽이 허용되는지 여부가 결정됩니다. 기본적으로 사용하도록 설정됩니다. 구성하여 특정 IP로 더 제한할 수 있습니다.

Name	형식	Description
Disabled	string
Enabled	string

ResourceProvisioningState

프라이빗 엔드포인트 연결의 프로비전 상태입니다.

Name	형식	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.