Partner Namespaces - Update

Servizio:

Event Grid

Versione API:

2022-06-15

Aggiornare uno spazio dei nomi partner.
Aggiorna in modo asincrono uno spazio dei nomi partner con i parametri specificati.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
partnerNamespaceName	path	True	string	Nome dello spazio dei nomi partner.
resourceGroupName	path	True	string	Nome del gruppo di risorse all'interno della sottoscrizione dell'utente.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco una sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.disableLocalAuth	boolean	Questo valore booleano viene usato per abilitare o disabilitare l'autenticazione locale. Il valore predefinito è false. Quando la proprietà è impostata su true, verrà usato solo il token AAD per l'autenticazione se l'utente è autorizzato a pubblicare nello spazio dei nomi partner.
properties.inboundIpRules	InboundIpRule[]	Può essere usato per limitare il traffico da indirizzi IP specifici anziché da tutti gli INDIRIZZI IP. Nota: questi vengono considerati solo se PublicNetworkAccess è abilitato.
properties.publicNetworkAccess	PublicNetworkAccess	Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli indirizzi IP specifici configurando
tags	object	Tag dello spazio dei nomi partner.

Risposte

Nome	Tipo	Descrizione
200 OK		Va bene
201 Created	PartnerNamespace	Richiesta di aggiornamento dello spazio dei nomi partner accettata.
Other Status Codes		Risposte di errore: 400 Richiesta non valida. 500 Errore interno del server.

Esempio

PartnerNamespaces_Update

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

200

Codice di stato:

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

Definizioni

Nome	Descrizione
ConnectionState	Informazioni di ConnectionState.
createdByType	Tipo di identità che ha creato la risorsa.
InboundIpRule
IpActionType	Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask.
PartnerNamespace	Spazio dei nomi partner EventGrid.
PartnerNamespaceProvisioningState	Stato di provisioning dello spazio dei nomi partner.
PartnerNamespaceUpdateParameters	Proprietà dell'aggiornamento dello spazio dei nomi partner.
PartnerTopicRoutingMode	Ciò determina se gli eventi pubblicati in questo spazio dei nomi partner devono usare l'attributo di origine nel payload dell'evento o usare il nome del canale nell'intestazione quando corrispondono all'argomento del partner. Se non viene specificato alcun valore, verrà usato il routing degli attributi di origine per trovare la corrispondenza con l'argomento del partner.
PersistedConnectionStatus	Stato della connessione.
PrivateEndpoint	Informazioni privateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli indirizzi IP specifici configurando
ResourceProvisioningState	Stato di provisioning della connessione endpoint privato.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

ConnectionState

Object

Informazioni di ConnectionState.

Nome	Tipo	Descrizione
actionsRequired	string	Azioni necessarie (se presenti).
description	string	Descrizione dello stato della connessione.
status	PersistedConnectionStatus	Stato della connessione.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

InboundIpRule

Object

Nome	Tipo	Descrizione
action	IpActionType	Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask.
ipMask	string	Indirizzo IP nella notazione CIDR, ad esempio 10.0.0.0/8.

IpActionType

Enumerazione

Azione da eseguire in base alla corrispondenza o nessuna corrispondenza di IpMask.

Valore	Descrizione
Allow

PartnerNamespace

Object

Spazio dei nomi partner EventGrid.

Nome	Tipo	Valore predefinito	Descrizione
id	string		Identificatore completo della risorsa.
location	string		Posizione della risorsa.
name	string		Nome della risorsa.
properties.disableLocalAuth	boolean	False	Questo valore booleano viene usato per abilitare o disabilitare l'autenticazione locale. Il valore predefinito è false. Quando la proprietà è impostata su true, verrà usato solo il token AAD per l'autenticazione se l'utente è autorizzato a pubblicare nello spazio dei nomi partner.
properties.endpoint	string		Endpoint per lo spazio dei nomi partner.
properties.inboundIpRules	InboundIpRule[]		Può essere usato per limitare il traffico da indirizzi IP specifici anziché da tutti gli INDIRIZZI IP. Nota: questi vengono considerati solo se PublicNetworkAccess è abilitato.
properties.partnerRegistrationFullyQualifiedId	string		ID ARM completo della registrazione partner che deve essere associata a questo spazio dei nomi partner. Il formato seguente è :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Ciò determina se gli eventi pubblicati in questo spazio dei nomi partner devono usare l'attributo di origine nel payload dell'evento o usare il nome del canale nell'intestazione quando corrispondono all'argomento del partner. Se non viene specificato alcun valore, verrà usato il routing degli attributi di origine per trovare la corrispondenza con l'argomento del partner.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		Stato di provisioning dello spazio dei nomi partner.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli indirizzi IP specifici configurando
systemData	systemData		Metadati di sistema relativi alla risorsa spazio dei nomi partner.
tags	object		Tag della risorsa.
type	string		Tipo della risorsa.

PartnerNamespaceProvisioningState

Enumerazione

Stato di provisioning dello spazio dei nomi partner.

Valore	Descrizione
Canceled
Creating
Deleting
Failed
Succeeded
Updating

PartnerNamespaceUpdateParameters

Object

Proprietà dell'aggiornamento dello spazio dei nomi partner.

Nome	Tipo	Valore predefinito	Descrizione
properties.disableLocalAuth	boolean		Questo valore booleano viene usato per abilitare o disabilitare l'autenticazione locale. Il valore predefinito è false. Quando la proprietà è impostata su true, verrà usato solo il token AAD per l'autenticazione se l'utente è autorizzato a pubblicare nello spazio dei nomi partner.
properties.inboundIpRules	InboundIpRule[]		Può essere usato per limitare il traffico da indirizzi IP specifici anziché da tutti gli INDIRIZZI IP. Nota: questi vengono considerati solo se PublicNetworkAccess è abilitato.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli indirizzi IP specifici configurando
tags	object		Tag dello spazio dei nomi partner.

PartnerTopicRoutingMode

Enumerazione

Ciò determina se gli eventi pubblicati in questo spazio dei nomi partner devono usare l'attributo di origine nel payload dell'evento o usare il nome del canale nell'intestazione quando corrispondono all'argomento del partner. Se non viene specificato alcun valore, verrà usato il routing degli attributi di origine per trovare la corrispondenza con l'argomento del partner.

Valore	Descrizione
ChannelNameHeader
SourceEventAttribute

PersistedConnectionStatus

Enumerazione

Stato della connessione.

Valore	Descrizione
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Object

Informazioni privateEndpoint.

Nome	Tipo	Descrizione
id	string	Identificatore arm per endpoint privato.

PrivateEndpointConnection

Object

Nome	Tipo	Descrizione
id	string	Identificatore completo della risorsa.
name	string	Nome della risorsa.
properties.groupIds	string[]	GroupIds dalla risorsa del servizio di collegamento privato.
properties.privateEndpoint	PrivateEndpoint	Risorsa endpoint privato per questa connessione.
properties.privateLinkServiceConnectionState	ConnectionState	Dettagli sullo stato della connessione.
properties.provisioningState	ResourceProvisioningState	Stato di provisioning della connessione endpoint privato.
type	string	Tipo della risorsa.

PublicNetworkAccess

Enumerazione

Determina se il traffico è consentito in rete pubblica. Per impostazione predefinita, è abilitata. È possibile limitare ulteriormente gli indirizzi IP specifici configurando

Valore	Descrizione
Disabled
Enabled

ResourceProvisioningState

Enumerazione

Stato di provisioning della connessione endpoint privato.

Valore	Descrizione
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.