Partner Destinations - List By Resource Group

Servicio:: Event Grid

Versión de la API:: 2025-04-01-preview

Enumera los destinos de asociados en un grupo de recursos.
Enumere todos los destinos de asociados en un grupo de recursos.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations?api-version=2025-04-01-preview

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations?api-version=2025-04-01-preview&$filter={$filter}&$top={$top}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
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 de cada llamada de servicio.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.
$filter	query		string	Consulta que se usa para filtrar los resultados de búsqueda mediante la sintaxis de OData. El filtrado solo se permite en la propiedad "name" y con un número limitado de operaciones de OData. Estas operaciones son: la función "contains" así como las siguientes operaciones lógicas: no y, o eq (para igual) y ne (para no igual). No se admiten operaciones aritméticas. A continuación se muestra un ejemplo de filtro válido: $filter=contains(namE, 'PATTERN') y name ne 'PATTERN-1'. A continuación no se muestra un ejemplo de filtro válido: $filter=location eq 'westus'.
$top	query		integer (int32)	Número de resultados que se van a devolver por página para la operación de lista. El intervalo válido para el parámetro superior es de 1 a 100. Si no se especifica, el número predeterminado de resultados que se devolverá es de 20 elementos por página.

Respuestas

Nombre	Tipo	Description
200 OK	PartnerDestinationsListResult	De acuerdo
Other Status Codes	ErrorResponse	Respuesta de error devuelta si la solicitud no se realizó correctamente.

Ejemplos

PartnerDestinations_ListByResourceGroup

GET https://management.azure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerDestinations?api-version=2025-04-01-preview

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.EventGrid;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2025-04-01-preview/examples/PartnerDestinations_ListByResourceGroup.json
// this example is just showing the usage of "PartnerDestinations_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "8f6b6269-84f2-4d09-9e31-1127efcd1e40";
string resourceGroupName = "examplerg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this PartnerDestinationResource
PartnerDestinationCollection collection = resourceGroupResource.GetPartnerDestinations();

// invoke the operation and iterate over the result
await foreach (PartnerDestinationResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    PartnerDestinationData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

{
  "value": [
    {
      "properties": {
        "endpointServiceContext": "ContosoCorp.Accounts.User1",
        "provisioningState": "Succeeded",
        "activationState": "NeverActivated",
        "expirationTimeIfNotActivatedUtc": "2021-10-21T22:50:25.410433Z",
        "endpointBaseUrl": "https://somepartnerhostname",
        "messageForActivation": "Some message to the approver"
      },
      "location": "centraluseuap",
      "tags": null,
      "id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerDestinations/examplePartnerDestinationName1",
      "name": "examplePartnerDestinationName1",
      "type": "Microsoft.EventGrid/partnerDestinations"
    }
  ]
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
PartnerDestination	Destino del asociado de Event Grid.
PartnerDestinationActivationState	Estado de activación del destino del asociado.
PartnerDestinationProvisioningState	Estado de aprovisionamiento del destino del asociado.
PartnerDestinationsListResult	Resultado de la operación Enumerar destinos de asociados.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

PartnerDestination

Object

Destino del asociado de Event Grid.

Nombre	Tipo	Description
id	string	Identificador completo del recurso.
location	string	Ubicación del recurso.
name	string	Nombre del recurso.
properties.activationState	PartnerDestinationActivationState	Estado de activación del destino del asociado.
properties.endpointBaseUrl	string (uri)	Dirección URL base del punto de conexión del destino del asociado
properties.endpointServiceContext	string	Contexto de punto de conexión asociado a este destino de asociado.
properties.expirationTimeIfNotActivatedUtc	string (date-time)	Hora de expiración del destino del asociado. Si este temporizador expira y el destino del asociado nunca se ha activado, se eliminan el destino del asociado y el canal correspondiente.
properties.messageForActivation	string	Contexto o mensaje útil que se puede usar durante el proceso de aprobación.
properties.partnerRegistrationImmutableId	string (uuid)	Identificador inmutable del registro de asociado correspondiente.
properties.provisioningState	PartnerDestinationProvisioningState	Estado de aprovisionamiento del destino del asociado.
systemData	systemData	Metadatos del sistema relacionados con el recurso de Event Grid.
tags	object	Etiquetas del recurso.
type	string	Tipo del recurso.

PartnerDestinationActivationState

Enumeración

Estado de activación del destino del asociado.

Valor	Description
Activated
NeverActivated

PartnerDestinationProvisioningState

Enumeración

Estado de aprovisionamiento del destino del asociado.

Valor	Description
Canceled
Creating
Deleting
Failed
IdleDueToMirroredChannelResourceDeletion
Succeeded
Updating

PartnerDestinationsListResult

Object

Resultado de la operación Enumerar destinos de asociados.

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente de destinos de asociados.
value	PartnerDestination[]	Colección de destinos de asociados.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.

Compartir a través de

Partner Destinations - List By Resource Group

Parámetros de identificador URI

Respuestas

Ejemplos

PartnerDestinations_ListByResourceGroup

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PartnerDestination

PartnerDestinationActivationState

PartnerDestinationProvisioningState

PartnerDestinationsListResult

systemData