Partner Namespaces - Update

Servicio:

Event Grid

Versión de la API:

2022-06-15

Actualice un espacio de nombres de asociado.
Actualiza de forma asincrónica un espacio de nombres de asociado con los parámetros especificados.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
partnerNamespaceName	path	True	string	Nombre del espacio de nombres del asociado.
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción del usuario.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.disableLocalAuth	boolean	Este valor booleano se usa para habilitar o deshabilitar la autenticación local. El valor predeterminado es false. Cuando la propiedad se establece en true, solo se usará el token de AAD para autenticarse si el usuario puede publicar en el espacio de nombres del asociado.
properties.inboundIpRules	InboundIpRule[]	Esto se puede usar para restringir el tráfico de direcciones IP específicas en lugar de todas las direcciones IP. Nota: Solo se consideran si PublicNetworkAccess está habilitado.
properties.publicNetworkAccess	PublicNetworkAccess	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas mediante la configuración
tags	object	Etiquetas del espacio de nombres del asociado.

Respuestas

Nombre	Tipo	Description
200 OK		Aceptar
201 Created	PartnerNamespace	Solicitud de actualización del espacio de nombres del asociado aceptada.
Other Status Codes		Respuestas de error: *** 400 Solicitud incorrecta. 500 Internal Server Error.

Ejemplos

PartnerNamespaces_Update

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
ConnectionState	Información de ConnectionState.
createdByType	Tipo de identidad que creó el recurso.
InboundIpRule
IpActionType	Acción que se va a realizar en función de la coincidencia o ninguna coincidencia de IpMask.
PartnerNamespace	Espacio de nombres de asociado de EventGrid.
PartnerNamespaceProvisioningState	Estado de aprovisionamiento del espacio de nombres del asociado.
PartnerNamespaceUpdateParameters	Propiedades de la actualización del espacio de nombres del asociado.
PartnerTopicRoutingMode	Esto determina si los eventos publicados en este espacio de nombres de asociado deben usar el atributo de origen en la carga de eventos o usar el nombre del canal en el encabezado cuando coincidan con el tema del asociado. Si no se especifica ninguno, se usará el enrutamiento de atributos de origen para que coincida con el tema del asociado.
PersistedConnectionStatus	Estado de la conexión.
PrivateEndpoint	Información de PrivateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas mediante la configuración
ResourceProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

ConnectionState

Información de ConnectionState.

Nombre	Tipo	Description
actionsRequired	string	Acciones necesarias (si las hay).
description	string	Descripción del estado de conexión.
status	PersistedConnectionStatus	Estado de la conexión.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Nombre	Tipo	Description
action	IpActionType	Acción que se va a realizar en función de la coincidencia o ninguna coincidencia de IpMask.
ipMask	string	Dirección IP en notación CIDR, por ejemplo, 10.0.0.0/8.

IpActionType

Acción que se va a realizar en función de la coincidencia o ninguna coincidencia de IpMask.

Nombre	Tipo	Description
Allow	string

PartnerNamespace

Espacio de nombres de asociado de EventGrid.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador completo del recurso.
location	string		Ubicación del recurso.
name	string		Nombre del recurso.
properties.disableLocalAuth	boolean	False	Este valor booleano se usa para habilitar o deshabilitar la autenticación local. El valor predeterminado es false. Cuando la propiedad se establece en true, solo se usará el token de AAD para autenticarse si el usuario puede publicar en el espacio de nombres del asociado.
properties.endpoint	string		Punto de conexión para el espacio de nombres del asociado.
properties.inboundIpRules	InboundIpRule[]		Esto se puede usar para restringir el tráfico de direcciones IP específicas en lugar de todas las direcciones IP. Nota: Solo se consideran si PublicNetworkAccess está habilitado.
properties.partnerRegistrationFullyQualifiedId	string		Id. de ARM completo del registro de asociado que se debe asociar a este espacio de nombres de asociado. Esto toma el siguiente formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Esto determina si los eventos publicados en este espacio de nombres de asociado deben usar el atributo de origen en la carga de eventos o usar el nombre del canal en el encabezado cuando coincidan con el tema del asociado. Si no se especifica ninguno, se usará el enrutamiento de atributos de origen para que coincida con el tema del asociado.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		Estado de aprovisionamiento del espacio de nombres del asociado.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas mediante la configuración
systemData	systemData		Metadatos del sistema relacionados con el recurso espacio de nombres del asociado.
tags	object		Etiquetas del recurso.
type	string		Tipo de recurso.

PartnerNamespaceProvisioningState

Estado de aprovisionamiento del espacio de nombres del asociado.

Nombre	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerNamespaceUpdateParameters

Propiedades de la actualización del espacio de nombres del asociado.

Nombre	Tipo	Valor predeterminado	Description
properties.disableLocalAuth	boolean		Este valor booleano se usa para habilitar o deshabilitar la autenticación local. El valor predeterminado es false. Cuando la propiedad se establece en true, solo se usará el token de AAD para autenticarse si el usuario puede publicar en el espacio de nombres del asociado.
properties.inboundIpRules	InboundIpRule[]		Esto se puede usar para restringir el tráfico de direcciones IP específicas en lugar de todas las direcciones IP. Nota: Solo se consideran si PublicNetworkAccess está habilitado.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas mediante la configuración
tags	object		Etiquetas del espacio de nombres del asociado.

PartnerTopicRoutingMode

Esto determina si los eventos publicados en este espacio de nombres de asociado deben usar el atributo de origen en la carga de eventos o usar el nombre del canal en el encabezado cuando coincidan con el tema del asociado. Si no se especifica ninguno, se usará el enrutamiento de atributos de origen para que coincida con el tema del asociado.

Nombre	Tipo	Description
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

Estado de la conexión.

Nombre	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

Información de PrivateEndpoint.

Nombre	Tipo	Description
id	string	Identificador de ARM para punto de conexión privado.

PrivateEndpointConnection

Nombre	Tipo	Description
id	string	Identificador completo del recurso.
name	string	Nombre del recurso.
properties.groupIds	string[]	GroupIds del recurso del servicio Private Link.
properties.privateEndpoint	PrivateEndpoint	Recurso de punto de conexión privado para esta conexión.
properties.privateLinkServiceConnectionState	ConnectionState	Detalles sobre el estado de la conexión.
properties.provisioningState	ResourceProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.
type	string	Tipo de recurso.

PublicNetworkAccess

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas mediante la configuración

Nombre	Tipo	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Estado de aprovisionamiento de la conexión de punto de conexión privado.

Nombre	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.