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. Идентификатор подписки входит в состав 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

Object

Сведения о ConnectionState.

Имя	Тип	Описание
actionsRequired	string	Необходимые действия (если таковые есть).
description	string	Описание состояния подключения.
status	PersistedConnectionStatus	Состояние подключения.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

InboundIpRule

Object

Имя	Тип	Описание
action	IpActionType	Действие для выполнения на основе совпадения или отсутствия соответствия IpMask.
ipMask	string	IP-адрес в нотации CIDR, например 10.0.0.0/8.

IpActionType

Перечисление

Действие для выполнения на основе совпадения или отсутствия соответствия IpMask.

Значение	Описание
Allow

PartnerNamespace

Object

Пространство имен партнера EventGrid.

Имя	Тип	Default value	Описание
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

Перечисление

Состояние подготовки пространства имен партнера.

Значение	Описание
Canceled
Creating
Deleting
Failed
Succeeded
Updating

PartnerNamespaceUpdateParameters

Object

Свойства обновления пространства имен партнера.

Имя	Тип	Default value	Описание
properties.disableLocalAuth	boolean		Этот логический код используется для включения или отключения локальной проверки подлинности. Значение по умолчанию — false. Если для свойства задано значение true, для проверки подлинности будет использоваться только маркер AAD, если пользователю разрешено публиковать в пространстве имен партнера.
properties.inboundIpRules	InboundIpRule[]		Это можно использовать для ограничения трафика с определенных IP-адресов вместо всех IP-адресов. Примечание. Они считаются только в том случае, если включена функция PublicNetworkAccess.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена. Вы можете дополнительно ограничить определенные IP-адреса, настроив
tags	object		Теги пространства имен партнера.

PartnerTopicRoutingMode

Перечисление

Это определяет, должны ли события, опубликованные в этом пространстве имен партнера, использовать исходный атрибут в полезных данных события или использовать имя канала в заголовке при сопоставлении с разделом партнера. Если ни один из них не указан, маршрутизация атрибутов источника будет использоваться для сопоставления раздела партнера.

Значение	Описание
ChannelNameHeader
SourceEventAttribute

PersistedConnectionStatus

Перечисление

Состояние подключения.

Значение	Описание
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Object

Сведения о PrivateEndpoint.

Имя	Тип	Описание
id	string	Идентификатор ARM для частной конечной точки.

PrivateEndpointConnection

Object

Имя	Тип	Описание
id	string	Полный идентификатор ресурса.
name	string	Имя ресурса.
properties.groupIds	string[]	GroupIds из ресурса службы приватного канала.
properties.privateEndpoint	PrivateEndpoint	Ресурс частной конечной точки для этого подключения.
properties.privateLinkServiceConnectionState	ConnectionState	Сведения о состоянии подключения.
properties.provisioningState	ResourceProvisioningState	Состояние подготовки подключения к частной конечной точке.
type	string	Тип ресурса.

PublicNetworkAccess

Перечисление

Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена. Вы можете дополнительно ограничить определенные IP-адреса, настроив

Значение	Описание
Disabled
Enabled

ResourceProvisioningState

Перечисление

Состояние подготовки подключения к частной конечной точке.

Значение	Описание
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.