Partner Namespaces - Update

Dienst:

Event Grid

API-Version:

2022-06-15

Aktualisieren sie einen Partnernamespace.
Aktualisiert asynchron einen Partnernamespace mit den angegebenen Parametern.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
partnerNamespaceName	path	True	string	Name des Partnernamespaces.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe im Abonnement des Benutzers.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.disableLocalAuth	boolean	Dieser boolesche Wert wird verwendet, um die lokale Authentifizierung zu aktivieren oder zu deaktivieren. Der Standardwert ist false. Wenn die Eigenschaft auf true festgelegt ist, wird nur das AAD-Token zur Authentifizierung verwendet, wenn der Benutzer die Veröffentlichung im Partnernamespace zulassen kann.
properties.inboundIpRules	InboundIpRule[]	Dies kann verwendet werden, um den Datenverkehr von bestimmten IP-Adressen anstelle aller IP-Adressen einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist.
properties.publicNetworkAccess	PublicNetworkAccess	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie konfigurieren
tags	object	Tags des Partnernamespace.

Antworten

Name	Typ	Beschreibung
200 OK		OK
201 Created	PartnerNamespace	Aktualisierungsanforderung des Partnernamespaces wurde akzeptiert.
Other Status Codes		Fehlerantworten: *** 400 Ungültige Anforderung. 500 Interner Serverfehler.

Beispiele

PartnerNamespaces_Update

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

Statuscode:

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

Definitionen

Name	Beschreibung
ConnectionState	ConnectionState-Informationen.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
InboundIpRule
IpActionType	Aktion, die basierend auf der Übereinstimmung oder keine Übereinstimmung der IpMask ausgeführt werden soll.
PartnerNamespace	EventGrid-Partnernamespace.
PartnerNamespaceProvisioningState	Bereitstellungsstatus des Partnernamespaces.
PartnerNamespaceUpdateParameters	Eigenschaften des Partnernamespace-Updates.
PartnerTopicRoutingMode	Dadurch wird bestimmt, ob ereignisse, die in diesem Partnernamespace veröffentlicht werden, das quell-Attribut in der Ereignisnutzlast verwenden oder den Kanalnamen im Header verwenden sollen, wenn sie mit dem Partnerthema übereinstimmen. Wenn keine angegeben ist, wird das Quellattributerouting verwendet, um dem Partnerthema zu entsprechen.
PersistedConnectionStatus	Status der Verbindung.
PrivateEndpoint	PrivateEndpoint-Informationen.
PrivateEndpointConnection
PublicNetworkAccess	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie konfigurieren
ResourceProvisioningState	Bereitstellungsstatus der Verbindung mit privatem Endpunkt.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

ConnectionState

ConnectionState-Informationen.

Name	Typ	Beschreibung
actionsRequired	string	Aktionen erforderlich (falls vorhanden).
description	string	Beschreibung des Verbindungsstatus.
status	PersistedConnectionStatus	Status der Verbindung.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Name	Typ	Beschreibung
action	IpActionType	Aktion, die basierend auf der Übereinstimmung oder keine Übereinstimmung der IpMask ausgeführt werden soll.
ipMask	string	IP-Adresse in CIDR-Notation, z. B. 10.0.0.0/8.

IpActionType

Aktion, die basierend auf der Übereinstimmung oder keine Übereinstimmung der IpMask ausgeführt werden soll.

Name	Typ	Beschreibung
Allow	string

PartnerNamespace

EventGrid-Partnernamespace.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierter Bezeichner der Ressource.
location	string		Speicherort der Ressource.
name	string		Der Name der Ressource.
properties.disableLocalAuth	boolean	False	Dieser boolesche Wert wird verwendet, um die lokale Authentifizierung zu aktivieren oder zu deaktivieren. Der Standardwert ist false. Wenn die Eigenschaft auf true festgelegt ist, wird nur das AAD-Token zur Authentifizierung verwendet, wenn der Benutzer die Veröffentlichung im Partnernamespace zulassen kann.
properties.endpoint	string		Endpunkt für den Partnernamespace.
properties.inboundIpRules	InboundIpRule[]		Dies kann verwendet werden, um den Datenverkehr von bestimmten IP-Adressen anstelle aller IP-Adressen einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist.
properties.partnerRegistrationFullyQualifiedId	string		Die vollqualifizierte ARM-ID der Partnerregistrierung, die diesem Partnernamespace zugeordnet werden soll. Dies hat das folgende Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Dadurch wird bestimmt, ob ereignisse, die in diesem Partnernamespace veröffentlicht werden, das quell-Attribut in der Ereignisnutzlast verwenden oder den Kanalnamen im Header verwenden sollen, wenn sie mit dem Partnerthema übereinstimmen. Wenn keine angegeben ist, wird das Quellattributerouting verwendet, um dem Partnerthema zu entsprechen.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		Bereitstellungsstatus des Partnernamespaces.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie konfigurieren
systemData	systemData		Die Systemmetadaten im Zusammenhang mit der Partner-Namespaceressource.
tags	object		Tags der Ressource.
type	string		Der Typ der Ressource.

PartnerNamespaceProvisioningState

Bereitstellungsstatus des Partnernamespaces.

Name	Typ	Beschreibung
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerNamespaceUpdateParameters

Eigenschaften des Partnernamespace-Updates.

Name	Typ	Standardwert	Beschreibung
properties.disableLocalAuth	boolean		Dieser boolesche Wert wird verwendet, um die lokale Authentifizierung zu aktivieren oder zu deaktivieren. Der Standardwert ist false. Wenn die Eigenschaft auf true festgelegt ist, wird nur das AAD-Token zur Authentifizierung verwendet, wenn der Benutzer die Veröffentlichung im Partnernamespace zulassen kann.
properties.inboundIpRules	InboundIpRule[]		Dies kann verwendet werden, um den Datenverkehr von bestimmten IP-Adressen anstelle aller IP-Adressen einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie konfigurieren
tags	object		Tags des Partnernamespace.

PartnerTopicRoutingMode

Dadurch wird bestimmt, ob ereignisse, die in diesem Partnernamespace veröffentlicht werden, das quell-Attribut in der Ereignisnutzlast verwenden oder den Kanalnamen im Header verwenden sollen, wenn sie mit dem Partnerthema übereinstimmen. Wenn keine angegeben ist, wird das Quellattributerouting verwendet, um dem Partnerthema zu entsprechen.

Name	Typ	Beschreibung
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

Status der Verbindung.

Name	Typ	Beschreibung
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint-Informationen.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für private Endpunkte.

PrivateEndpointConnection

Name	Typ	Beschreibung
id	string	Vollqualifizierter Bezeichner der Ressource.
name	string	Der Name der Ressource.
properties.groupIds	string[]	GroupIds aus der Private Link-Dienstressource.
properties.privateEndpoint	PrivateEndpoint	Die Ressource "Privater Endpunkt" für diese Verbindung.
properties.privateLinkServiceConnectionState	ConnectionState	Details zum Status der Verbindung.
properties.provisioningState	ResourceProvisioningState	Bereitstellungsstatus der Verbindung mit privatem Endpunkt.
type	string	Der Typ der Ressource.

PublicNetworkAccess

Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie konfigurieren

Name	Typ	Beschreibung
Disabled	string
Enabled	string

ResourceProvisioningState

Bereitstellungsstatus der Verbindung mit privatem Endpunkt.

Name	Typ	Beschreibung
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.