Partner Namespaces - Update

Service:

Event Grid

API Version:

2022-06-15

Mettre à jour un espace de noms partenaire.
Met à jour de manière asynchrone un espace de noms partenaire avec les paramètres spécifiés.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
partnerNamespaceName	path	True	string	Nom de l’espace de noms du partenaire.
resourceGroupName	path	True	string	Nom du groupe de ressources dans l’abonnement de l’utilisateur.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

Corps de la demande

Nom	Type	Description
properties.disableLocalAuth	boolean	Cette valeur booléenne est utilisée pour activer ou désactiver l’authentification locale. La valeur par défaut est false. Lorsque la propriété a la valeur true, seul le jeton AAD est utilisé pour s’authentifier si l’utilisateur est autorisé à publier dans l’espace de noms du partenaire.
properties.inboundIpRules	InboundIpRule[]	Cela peut être utilisé pour limiter le trafic à partir d’adresses IP spécifiques au lieu de toutes les adresses IP. Remarque : Elles sont prises en compte uniquement si PublicNetworkAccess est activé.
properties.publicNetworkAccess	PublicNetworkAccess	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant
tags	object	Balises de l’espace de noms partenaire.

Réponses

Nom	Type	Description
200 OK		Ok
201 Created	PartnerNamespace	Demande de mise à jour de l’espace de noms partenaire acceptée.
Other Status Codes		Réponses d’erreur : *** 400 Requête incorrecte. 500 Erreur interne du serveur.

Exemples

PartnerNamespaces_Update

Sample Request

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

Sample Response

Status code:

200

Status code:

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

Définitions

Nom	Description
ConnectionState	Informations ConnectionState.
createdByType	Type d’identité qui a créé la ressource.
InboundIpRule
IpActionType	Action à effectuer en fonction de la correspondance ou de l’absence de correspondance de l’IpMask.
PartnerNamespace	Espace de noms de partenaire EventGrid.
PartnerNamespaceProvisioningState	État d’approvisionnement de l’espace de noms partenaire.
PartnerNamespaceUpdateParameters	Propriétés de la mise à jour de l’espace de noms partenaire.
PartnerTopicRoutingMode	Cela détermine si les événements publiés dans cet espace de noms partenaire doivent utiliser l’attribut source dans la charge utile de l’événement ou utiliser le nom du canal dans l’en-tête lors de la correspondance avec la rubrique partenaire. Si aucun n’est spécifié, le routage d’attribut source sera utilisé pour correspondre à la rubrique partenaire.
PersistedConnectionStatus	État de la connexion.
PrivateEndpoint	Informations PrivateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant
ResourceProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

ConnectionState

Informations ConnectionState.

Nom	Type	Description
actionsRequired	string	Actions requises (le cas échéant).
description	string	Description de l’état de la connexion.
status	PersistedConnectionStatus	État de la connexion.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Nom	Type	Description
action	IpActionType	Action à effectuer en fonction de la correspondance ou de l’absence de correspondance de l’IpMask.
ipMask	string	Adresse IP dans la notation CIDR, par exemple, 10.0.0.0/8.

IpActionType

Action à effectuer en fonction de la correspondance ou de l’absence de correspondance de l’IpMask.

Nom	Type	Description
Allow	string

PartnerNamespace

Espace de noms de partenaire EventGrid.

Nom	Type	Valeur par défaut	Description
id	string		Identificateur complet de la ressource.
location	string		Emplacement de la ressource.
name	string		Nom de la ressource.
properties.disableLocalAuth	boolean	False	Cette valeur booléenne est utilisée pour activer ou désactiver l’authentification locale. La valeur par défaut est false. Lorsque la propriété a la valeur true, seul le jeton AAD est utilisé pour s’authentifier si l’utilisateur est autorisé à publier dans l’espace de noms du partenaire.
properties.endpoint	string		Point de terminaison de l’espace de noms partenaire.
properties.inboundIpRules	InboundIpRule[]		Cela peut être utilisé pour limiter le trafic à partir d’adresses IP spécifiques au lieu de toutes les adresses IP. Remarque : Elles sont prises en compte uniquement si PublicNetworkAccess est activé.
properties.partnerRegistrationFullyQualifiedId	string		ID ARM complet de l’inscription du partenaire qui doit être associé à cet espace de noms partenaire. Cette opération prend le format suivant : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Cela détermine si les événements publiés dans cet espace de noms partenaire doivent utiliser l’attribut source dans la charge utile de l’événement ou utiliser le nom du canal dans l’en-tête lors de la correspondance avec la rubrique partenaire. Si aucun n’est spécifié, le routage d’attribut source sera utilisé pour correspondre à la rubrique partenaire.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		État d’approvisionnement de l’espace de noms partenaire.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant
systemData	systemData		Métadonnées système relatives à la ressource Espace de noms partenaire.
tags	object		Balises de la ressource.
type	string		Type de la ressource.

PartnerNamespaceProvisioningState

État d’approvisionnement de l’espace de noms partenaire.

Nom	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerNamespaceUpdateParameters

Propriétés de la mise à jour de l’espace de noms partenaire.

Nom	Type	Valeur par défaut	Description
properties.disableLocalAuth	boolean		Cette valeur booléenne est utilisée pour activer ou désactiver l’authentification locale. La valeur par défaut est false. Lorsque la propriété a la valeur true, seul le jeton AAD est utilisé pour s’authentifier si l’utilisateur est autorisé à publier dans l’espace de noms du partenaire.
properties.inboundIpRules	InboundIpRule[]		Cela peut être utilisé pour limiter le trafic à partir d’adresses IP spécifiques au lieu de toutes les adresses IP. Remarque : Elles sont prises en compte uniquement si PublicNetworkAccess est activé.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant
tags	object		Balises de l’espace de noms partenaire.

PartnerTopicRoutingMode

Cela détermine si les événements publiés dans cet espace de noms partenaire doivent utiliser l’attribut source dans la charge utile de l’événement ou utiliser le nom du canal dans l’en-tête lors de la correspondance avec la rubrique partenaire. Si aucun n’est spécifié, le routage d’attribut source sera utilisé pour correspondre à la rubrique partenaire.

Nom	Type	Description
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

État de la connexion.

Nom	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

Informations PrivateEndpoint.

Nom	Type	Description
id	string	Identificateur ARM pour le point de terminaison privé.

PrivateEndpointConnection

Nom	Type	Description
id	string	Identificateur complet de la ressource.
name	string	Nom de la ressource.
properties.groupIds	string[]	GroupIds de la ressource de service private link.
properties.privateEndpoint	PrivateEndpoint	Ressource de point de terminaison privé pour cette connexion.
properties.privateLinkServiceConnectionState	ConnectionState	Détails sur l’état de la connexion.
properties.provisioningState	ResourceProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
type	string	Type de la ressource.

PublicNetworkAccess

Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant

Nom	Type	Description
Disabled	string
Enabled	string

ResourceProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

Nom	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.