Partner Namespaces - Update

Serviço:

Event Grid

Versão da API:

2022-06-15

Atualizar um espaço de nomes de parceiros.
Atualiza de forma assíncrona um espaço de nomes de parceiros com os parâmetros especificados.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
partnerNamespaceName	path	True	string	Nome do espaço de nomes do parceiro.
resourceGroupName	path	True	string	O nome do grupo de recursos na subscrição do utilizador.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente uma subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.

Corpo do Pedido

Name	Tipo	Description
properties.disableLocalAuth	boolean	Este valor booleano é utilizado para ativar ou desativar a autenticação local. O valor predefinido é falso. Quando a propriedade está definida como verdadeira, apenas o token do AAD será utilizado para autenticar se o utilizador tiver permissão para publicar no espaço de nomes de parceiros.
properties.inboundIpRules	InboundIpRule[]	Isto pode ser utilizado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: estes são considerados apenas se PublicNetworkAccess estiver ativado.
properties.publicNetworkAccess	PublicNetworkAccess	Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Pode restringir ainda mais a IPs específicos ao configurar
tags	object	Etiquetas do Espaço de Nomes de Parceiros.

Respostas

Name	Tipo	Description
200 OK		OK
201 Created	PartnerNamespace	Pedido de atualização do espaço de nomes de parceiros aceite.
Other Status Codes		Respostas de Erro: *** 400 Pedido Incorreto. Erro de Servidor Interno 500.

Exemplos

PartnerNamespaces_Update

Pedido de amostra

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

Resposta da amostra

Código de estado:

200

Código de estado:

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

Definições

Name	Description
ConnectionState	Informações de ConnectionState.
createdByType	O tipo de identidade que criou o recurso.
InboundIpRule
IpActionType	Ação a executar com base na correspondência ou sem correspondência do IpMask.
PartnerNamespace	Espaço de Nomes de Parceiros do EventGrid.
PartnerNamespaceProvisioningState	Estado de aprovisionamento do espaço de nomes de parceiros.
PartnerNamespaceUpdateParameters	Propriedades da atualização espaço de nomes de parceiros.
PartnerTopicRoutingMode	Isto determina se os eventos publicados neste espaço de nomes de parceiros devem utilizar o atributo de origem no payload do evento ou utilizar o nome do canal no cabeçalho ao corresponder ao tópico do parceiro. Se não for especificado nenhum, o encaminhamento de atributos de origem será utilizado para corresponder ao tópico do parceiro.
PersistedConnectionStatus	Estado da ligação.
PrivateEndpoint	Informações do PrivateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Pode restringir ainda mais a IPs específicos ao configurar
ResourceProvisioningState	Estado de aprovisionamento da Ligação de Ponto Final Privado.
systemData	Metadados relativos à criação e última modificação do recurso.

ConnectionState

Informações de ConnectionState.

Name	Tipo	Description
actionsRequired	string	Ações necessárias (se existirem).
description	string	Descrição do estado da ligação.
status	PersistedConnectionStatus	Estado da ligação.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Name	Tipo	Description
action	IpActionType	Ação a executar com base na correspondência ou sem correspondência do IpMask.
ipMask	string	Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8.

IpActionType

Ação a executar com base na correspondência ou sem correspondência do IpMask.

Name	Tipo	Description
Allow	string

PartnerNamespace

Espaço de Nomes de Parceiros do EventGrid.

Name	Tipo	Default value	Description
id	string		Identificador completamente qualificado do recurso.
location	string		Localização do recurso.
name	string		Nome do recurso.
properties.disableLocalAuth	boolean	False	Este valor booleano é utilizado para ativar ou desativar a autenticação local. O valor predefinido é falso. Quando a propriedade está definida como verdadeira, apenas o token do AAD será utilizado para autenticar se o utilizador tiver permissão para publicar no espaço de nomes de parceiros.
properties.endpoint	string		Ponto final para o espaço de nomes de parceiros.
properties.inboundIpRules	InboundIpRule[]		Isto pode ser utilizado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: estes são considerados apenas se PublicNetworkAccess estiver ativado.
properties.partnerRegistrationFullyQualifiedId	string		O ID arm completamente qualificado do registo de parceiros que deve ser associado a este espaço de nomes de parceiros. Este procedimento utiliza o seguinte formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Isto determina se os eventos publicados neste espaço de nomes de parceiros devem utilizar o atributo de origem no payload do evento ou utilizar o nome do canal no cabeçalho ao corresponder ao tópico do parceiro. Se não for especificado nenhum, o encaminhamento de atributos de origem será utilizado para corresponder ao tópico do parceiro.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		Estado de aprovisionamento do espaço de nomes de parceiros.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Pode restringir ainda mais a IPs específicos ao configurar
systemData	systemData		Os metadados do sistema relacionados com o recurso espaço de nomes de parceiros.
tags	object		Etiquetas do recurso.
type	string		Tipo de recurso.

PartnerNamespaceProvisioningState

Estado de aprovisionamento do espaço de nomes de parceiros.

Name	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerNamespaceUpdateParameters

Propriedades da atualização espaço de nomes de parceiros.

Name	Tipo	Default value	Description
properties.disableLocalAuth	boolean		Este valor booleano é utilizado para ativar ou desativar a autenticação local. O valor predefinido é falso. Quando a propriedade está definida como verdadeira, apenas o token do AAD será utilizado para autenticar se o utilizador tiver permissão para publicar no espaço de nomes de parceiros.
properties.inboundIpRules	InboundIpRule[]		Isto pode ser utilizado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: estes são considerados apenas se PublicNetworkAccess estiver ativado.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Pode restringir ainda mais a IPs específicos ao configurar
tags	object		Etiquetas do Espaço de Nomes de Parceiros.

PartnerTopicRoutingMode

Isto determina se os eventos publicados neste espaço de nomes de parceiros devem utilizar o atributo de origem no payload do evento ou utilizar o nome do canal no cabeçalho ao corresponder ao tópico do parceiro. Se não for especificado nenhum, o encaminhamento de atributos de origem será utilizado para corresponder ao tópico do parceiro.

Name	Tipo	Description
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

Estado da ligação.

Name	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

Informações do PrivateEndpoint.

Name	Tipo	Description
id	string	O identificador do ARM para o Ponto Final Privado.

PrivateEndpointConnection

Name	Tipo	Description
id	string	Identificador completamente qualificado do recurso.
name	string	Nome do recurso.
properties.groupIds	string[]	GroupIds do recurso do serviço de ligação privada.
properties.privateEndpoint	PrivateEndpoint	O recurso ponto final privado para esta Ligação.
properties.privateLinkServiceConnectionState	ConnectionState	Detalhes sobre o estado da ligação.
properties.provisioningState	ResourceProvisioningState	Estado de aprovisionamento da Ligação de Ponto Final Privado.
type	string	Tipo de recurso.

PublicNetworkAccess

Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Pode restringir ainda mais a IPs específicos ao configurar

Name	Tipo	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Estado de aprovisionamento da Ligação de Ponto Final Privado.

Name	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.