Partner Namespaces - Update

Tjänst:

Event Grid

API-version:

2022-06-15

Uppdatera ett partnernamnområde.
Asynkront uppdaterar ett partnernamnområde med de angivna parametrarna.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
partnerNamespaceName	path	True	string	Namnet på partnernamnområdet.
resourceGroupName	path	True	string	Namnet på resursgruppen i användarens prenumeration.
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar en Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran.

Begärandetext

Name	Typ	Description
properties.disableLocalAuth	boolean	Det här booleska värdet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är falskt. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till partnernamnområdet.
properties.inboundIpRules	InboundIpRule[]	Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa betraktas endast om PublicNetworkAccess är aktiverat.
properties.publicNetworkAccess	PublicNetworkAccess	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
tags	object	Taggar för partnernamnområdet.

Svar

Name	Typ	Description
200 OK		OK
201 Created	PartnerNamespace	Begäran om uppdatering av partnernamnområde har godkänts.
Other Status Codes		Felsvar: *** 400 Felaktig begäran. 500 Internt serverfel.

Exempel

PartnerNamespaces_Update

Exempelbegäran

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

Exempelsvar

Statuskod:

200

Statuskod:

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

Definitioner

Name	Description
ConnectionState	ConnectionState-information.
createdByType	Den typ av identitet som skapade resursen.
InboundIpRule
IpActionType	Åtgärd som ska utföras baserat på matchningen eller ingen matchning av IpMask.
PartnerNamespace	EventGrid-partnernamnområde.
PartnerNamespaceProvisioningState	Etableringstillstånd för partnernamnområdet.
PartnerNamespaceUpdateParameters	Egenskaper för uppdateringen av partnernamnområdet.
PartnerTopicRoutingMode	Detta avgör om händelser som publiceras i det här partnernamnområdet ska använda källattributet i händelsenyttolasten eller använda kanalnamnet i rubriken när de matchar partnerämnet. Om inget anges används källattributdirigering för att matcha partnerämnet.
PersistedConnectionStatus	Status för anslutningen.
PrivateEndpoint	PrivateEndpoint-information.
PrivateEndpointConnection
PublicNetworkAccess	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
ResourceProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
systemData	Metadata som rör skapande och senaste ändring av resursen.

ConnectionState

Objekt

ConnectionState-information.

Name	Typ	Description
actionsRequired	string	Åtgärder som krävs (om några).
description	string	Beskrivning av anslutningstillståndet.
status	PersistedConnectionStatus	Status för anslutningen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
Application
Key
ManagedIdentity
User

InboundIpRule

Objekt

Name	Typ	Description
action	IpActionType	Åtgärd som ska utföras baserat på matchningen eller ingen matchning av IpMask.
ipMask	string	IP-adress i CIDR-notation, t.ex. 10.0.0.0/8.

IpActionType

Uppräkning

Åtgärd som ska utföras baserat på matchningen eller ingen matchning av IpMask.

Värde	Description
Allow

PartnerNamespace

Objekt

EventGrid-partnernamnområde.

Name	Typ	Standardvärde	Description
id	string		Fullständigt kvalificerad identifierare för resursen.
location	string		Resursens plats.
name	string		Namnet på resursen.
properties.disableLocalAuth	boolean	False	Det här booleska värdet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är falskt. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till partnernamnområdet.
properties.endpoint	string		Slutpunkt för partnernamnområdet.
properties.inboundIpRules	InboundIpRule[]		Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa betraktas endast om PublicNetworkAccess är aktiverat.
properties.partnerRegistrationFullyQualifiedId	string		Det fullständigt kvalificerade ARM-ID:t för partnerregistreringen som ska associeras med det här partnernamnområdet. Detta har följande format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Detta avgör om händelser som publiceras i det här partnernamnområdet ska använda källattributet i händelsenyttolasten eller använda kanalnamnet i rubriken när de matchar partnerämnet. Om inget anges används källattributdirigering för att matcha partnerämnet.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		Etableringstillstånd för partnernamnområdet.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
systemData	systemData		Systemmetadata som rör resursen partnernamnområde.
tags	object		Taggar för resursen.
type	string		Typ av resurs.

PartnerNamespaceProvisioningState

Uppräkning

Etableringstillstånd för partnernamnområdet.

Värde	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

PartnerNamespaceUpdateParameters

Objekt

Egenskaper för uppdateringen av partnernamnområdet.

Name	Typ	Standardvärde	Description
properties.disableLocalAuth	boolean		Det här booleska värdet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är falskt. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till partnernamnområdet.
properties.inboundIpRules	InboundIpRule[]		Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa betraktas endast om PublicNetworkAccess är aktiverat.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
tags	object		Taggar för partnernamnområdet.

PartnerTopicRoutingMode

Uppräkning

Detta avgör om händelser som publiceras i det här partnernamnområdet ska använda källattributet i händelsenyttolasten eller använda kanalnamnet i rubriken när de matchar partnerämnet. Om inget anges används källattributdirigering för att matcha partnerämnet.

Värde	Description
ChannelNameHeader
SourceEventAttribute

PersistedConnectionStatus

Uppräkning

Status för anslutningen.

Värde	Description
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Objekt

PrivateEndpoint-information.

Name	Typ	Description
id	string	ARM-identifieraren för privat slutpunkt.

PrivateEndpointConnection

Objekt

Name	Typ	Description
id	string	Fullständigt kvalificerad identifierare för resursen.
name	string	Namnet på resursen.
properties.groupIds	string[]	GroupIds från private link-tjänstresursen.
properties.privateEndpoint	PrivateEndpoint	Den privata slutpunktsresursen för den här anslutningen.
properties.privateLinkServiceConnectionState	ConnectionState	Information om anslutningens tillstånd.
properties.provisioningState	ResourceProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
type	string	Typ av resurs.

PublicNetworkAccess

Uppräkning

Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera

Värde	Description
Disabled
Enabled

ResourceProvisioningState

Uppräkning

Etableringstillstånd för den privata slutpunktsanslutningen.

Värde	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.