Partner Namespaces - Update

Service:

Event Grid

API-versie:

2022-06-15

Een partnernaamruimte bijwerken.
Een partnernaamruimte wordt asynchroon bijgewerkt met de opgegeven parameters.

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

URI-parameters

Name	In	Vereist	Type	Description
partnerNamespaceName	path	True	string	Naam van de partnernaamruimte.
resourceGroupName	path	True	string	De naam van de resourcegroep in het abonnement van de gebruiker.
subscriptionId	path	True	string	Abonnementsreferenties waarmee een Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.

Aanvraagbody

Name	Type	Description
properties.disableLocalAuth	boolean	Deze booleaanse waarde wordt gebruikt om lokale verificatie in of uit te schakelen. De standaardwaarde is false. Wanneer de eigenschap is ingesteld op true, wordt alleen het AAD-token gebruikt om te verifiëren of de gebruiker mag publiceren naar de partnernaamruimte.
properties.inboundIpRules	InboundIpRule[]	Dit kan worden gebruikt om verkeer van specifieke IP-adressen te beperken in plaats van alle IP-adressen. Opmerking: deze worden alleen in aanmerking genomen als PublicNetworkAccess is ingeschakeld.
properties.publicNetworkAccess	PublicNetworkAccess	Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Standaard is dit ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door
tags	object	Tags van de partnernaamruimte.

Antwoorden

Name	Type	Description
200 OK		OK
201 Created	PartnerNamespace	Aanvraag voor bijwerken van partnernaamruimte geaccepteerd.
Other Status Codes		Foutreacties: *** 400 Ongeldige aanvraag. 500 Interne serverfout.

Voorbeelden

PartnerNamespaces_Update

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
ConnectionState	ConnectionState-informatie.
createdByType	Het type identiteit waarmee de resource is gemaakt.
InboundIpRule
IpActionType	Actie die moet worden uitgevoerd op basis van de overeenkomst of geen overeenkomst van het Ip-masker.
PartnerNamespace	EventGrid-partnernaamruimte.
PartnerNamespaceProvisioningState	Inrichtingsstatus van de partnernaamruimte.
PartnerNamespaceUpdateParameters	Eigenschappen van de update van de partnernaamruimte.
PartnerTopicRoutingMode	Hiermee bepaalt u of gebeurtenissen die naar deze partnernaamruimte zijn gepubliceerd, het bronkenmerk in de nettolading van de gebeurtenis moeten gebruiken of de kanaalnaam in de header moeten gebruiken bij het overeenkomen met het partneronderwerp. Als er geen is opgegeven, wordt routering van bronkenmerk gebruikt om overeen te komen met het partneronderwerp.
PersistedConnectionStatus	Status van de verbinding.
PrivateEndpoint	PrivateEndpoint-informatie.
PrivateEndpointConnection
PublicNetworkAccess	Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Standaard is dit ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door
ResourceProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

ConnectionState

ConnectionState-informatie.

Name	Type	Description
actionsRequired	string	Acties vereist (indien aanwezig).
description	string	Beschrijving van de verbindingsstatus.
status	PersistedConnectionStatus	Status van de verbinding.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Name	Type	Description
action	IpActionType	Actie die moet worden uitgevoerd op basis van de overeenkomst of geen overeenkomst van het Ip-masker.
ipMask	string	IP-adres in CIDR-notatie, bijvoorbeeld 10.0.0.0/8.

IpActionType

Actie die moet worden uitgevoerd op basis van de overeenkomst of geen overeenkomst van het Ip-masker.

Name	Type	Description
Allow	string

PartnerNamespace

EventGrid-partnernaamruimte.

Name	Type	Default value	Description
id	string		Volledig gekwalificeerde id van de resource.
location	string		Locatie van de resource.
name	string		De naam van de resource.
properties.disableLocalAuth	boolean	False	Deze booleaanse waarde wordt gebruikt om lokale verificatie in of uit te schakelen. De standaardwaarde is false. Wanneer de eigenschap is ingesteld op true, wordt alleen het AAD-token gebruikt om te verifiëren of de gebruiker mag publiceren naar de partnernaamruimte.
properties.endpoint	string		Eindpunt voor de partnernaamruimte.
properties.inboundIpRules	InboundIpRule[]		Dit kan worden gebruikt om verkeer van specifieke IP-adressen te beperken in plaats van alle IP-adressen. Opmerking: deze worden alleen in aanmerking genomen als PublicNetworkAccess is ingeschakeld.
properties.partnerRegistrationFullyQualifiedId	string		De volledig gekwalificeerde ARM-id van de partnerregistratie die moet worden gekoppeld aan deze partnernaamruimte. Dit heeft de volgende indeling: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Hiermee bepaalt u of gebeurtenissen die naar deze partnernaamruimte zijn gepubliceerd, het bronkenmerk in de nettolading van de gebeurtenis moeten gebruiken of de kanaalnaam in de header moeten gebruiken bij het overeenkomen met het partneronderwerp. Als er geen is opgegeven, wordt routering van bronkenmerk gebruikt om overeen te komen met het partneronderwerp.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		Inrichtingsstatus van de partnernaamruimte.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Standaard is dit ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door
systemData	systemData		De systeemmetagegevens met betrekking tot partnernaamruimteresource.
tags	object		Tags van de resource.
type	string		Type van de resource.

PartnerNamespaceProvisioningState

Inrichtingsstatus van de partnernaamruimte.

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

PartnerNamespaceUpdateParameters

Eigenschappen van de update van de partnernaamruimte.

Name	Type	Default value	Description
properties.disableLocalAuth	boolean		Deze booleaanse waarde wordt gebruikt om lokale verificatie in of uit te schakelen. De standaardwaarde is false. Wanneer de eigenschap is ingesteld op true, wordt alleen het AAD-token gebruikt om te verifiëren of de gebruiker mag publiceren naar de partnernaamruimte.
properties.inboundIpRules	InboundIpRule[]		Dit kan worden gebruikt om verkeer van specifieke IP-adressen te beperken in plaats van alle IP-adressen. Opmerking: deze worden alleen in aanmerking genomen als PublicNetworkAccess is ingeschakeld.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Standaard is dit ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door
tags	object		Tags van de partnernaamruimte.

PartnerTopicRoutingMode

Hiermee bepaalt u of gebeurtenissen die naar deze partnernaamruimte zijn gepubliceerd, het bronkenmerk in de nettolading van de gebeurtenis moeten gebruiken of de kanaalnaam in de header moeten gebruiken bij het overeenkomen met het partneronderwerp. Als er geen is opgegeven, wordt routering van bronkenmerk gebruikt om overeen te komen met het partneronderwerp.

Name	Type	Description
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

Status van de verbinding.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint-informatie.

Name	Type	Description
id	string	De ARM-id voor het privé-eindpunt.

PrivateEndpointConnection

Name	Type	Description
id	string	Volledig gekwalificeerde id van de resource.
name	string	De naam van de resource.
properties.groupIds	string[]	GroupIds van de private link-serviceresource.
properties.privateEndpoint	PrivateEndpoint	De privé-eindpuntresource voor deze verbinding.
properties.privateLinkServiceConnectionState	ConnectionState	Details over de status van de verbinding.
properties.provisioningState	ResourceProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
type	string	Type van de resource.

PublicNetworkAccess

Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Standaard is dit ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door

Name	Type	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Inrichtingsstatus van de privé-eindpuntverbinding.

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

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.