Partner Namespaces - Get

Serviço:

Event Grid

Versão da API:

2022-06-15

Obtenha um namespace de parceiro.
Obter propriedades de um namespace de parceiro.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
partnerNamespaceName	path	True	string	Nome do namespace do parceiro.
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura do usuário.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Respostas

Nome	Tipo	Description
200 OK	PartnerNamespace	OK
Other Status Codes		Respostas de erro: *** 400 Solicitação Inválida. 500 Erro interno do servidor.

Exemplos

PartnerNamespaces_Get

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1?api-version=2022-06-15

Java

import com.azure.core.util.Context;

/** Samples for PartnerNamespaces GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_Get.json
     */
    /**
     * Sample code: PartnerNamespaces_Get.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void partnerNamespacesGet(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager
            .partnerNamespaces()
            .getByResourceGroupWithResponse("examplerg", "examplePartnerNamespaceName1", Context.NONE);
    }
}

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_get.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.get(
        resource_group_name="examplerg",
        partner_namespace_name="examplePartnerNamespaceName1",
    )
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_Get.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/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_Get.json
func ExamplePartnerNamespacesClient_Get() {
	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)
	}
	res, err := clientFactory.NewPartnerNamespacesClient().Get(ctx, "examplerg", "examplePartnerNamespaceName1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PartnerNamespace = armeventgrid.PartnerNamespace{
	// 	Name: to.Ptr("examplePartnerNamespaceName1"),
	// 	Type: to.Ptr("Microsoft.EventGrid/partnerNamespaces"),
	// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1"),
	// 	Location: to.Ptr("Central US EUAP"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key2": to.Ptr("value2"),
	// 		"key3": to.Ptr("value3"),
	// 	},
	// 	Properties: &armeventgrid.PartnerNamespaceProperties{
	// 		Endpoint: to.Ptr("https://examplePartnerNamespaceName1.centraluseuap-1.eventgrid.azure.net/api/events"),
	// 		PartnerRegistrationFullyQualifiedID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1"),
	// 		ProvisioningState: to.Ptr(armeventgrid.PartnerNamespaceProvisioningStateSucceeded),
	// 	},
	// }
}

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 Get properties of a partner namespace.
 *
 * @summary Get properties of a partner namespace.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_Get.json
 */
async function partnerNamespacesGet() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const partnerNamespaceName = "examplePartnerNamespaceName1";
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.partnerNamespaces.get(resourceGroupName, partnerNamespaceName);
  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.Resources;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/PartnerNamespaces_Get.json
// this example is just showing the usage of "PartnerNamespaces_Get" 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 = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this PartnerNamespaceResource
PartnerNamespaceCollection collection = resourceGroupResource.GetPartnerNamespaces();

// invoke the operation
string partnerNamespaceName = "examplePartnerNamespaceName1";
bool result = await collection.ExistsAsync(partnerNamespaceName);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

{
  "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",
    "key2": "value2",
    "key3": "value3"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1",
  "name": "examplePartnerNamespaceName1",
  "type": "Microsoft.EventGrid/partnerNamespaces"
}

Definições

Nome	Description
ConnectionState	Informações de ConnectionState.
createdByType	O tipo de identidade que criou o recurso.
InboundIpRule
IpActionType	Ação a ser executada com base na correspondência ou nenhuma correspondência do IpMask.
PartnerNamespace	Namespace do Parceiro eventGrid.
PartnerNamespaceProvisioningState	Estado de provisionamento do namespace do parceiro.
PartnerTopicRoutingMode	Isso determina se os eventos publicados nesse namespace de parceiro devem usar o atributo de origem no conteúdo do evento ou usar o nome do canal no cabeçalho ao corresponder ao tópico do parceiro. Se nenhum for especificado, o roteamento de atributo de origem será usado para corresponder ao tópico do parceiro.
PersistedConnectionStatus	Status da conexão.
PrivateEndpoint	Informações de PrivateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando
ResourceProvisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.
systemData	Metadados relativos à criação e à última modificação do recurso.

ConnectionState

Informações de ConnectionState.

Nome	Tipo	Description
actionsRequired	string	Ações necessárias (se houver).
description	string	Descrição do estado da conexão.
status	PersistedConnectionStatus	Status da conexão.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Nome	Tipo	Description
action	IpActionType	Ação a ser executada com base na correspondência ou nenhuma correspondência do IpMask.
ipMask	string	Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8.

IpActionType

Ação a ser executada com base na correspondência ou nenhuma correspondência do IpMask.

Nome	Tipo	Description
Allow	string

PartnerNamespace

Namespace do Parceiro eventGrid.

Nome	Tipo	Valor padrão	Description
id	string		Identificador totalmente qualificado do recurso.
location	string		Local do recurso.
name	string		Nome do recurso.
properties.disableLocalAuth	boolean	False	Esse booliano é usado para habilitar ou desabilitar a autenticação local. O valor padrão é false. Quando a propriedade for definida como true, somente o token do AAD será usado para autenticar se o usuário tiver permissão para publicar no namespace do parceiro.
properties.endpoint	string		Ponto de extremidade para o namespace do parceiro.
properties.inboundIpRules	InboundIpRule[]		Isso pode ser usado para restringir o tráfego de IPs específicos em vez de todos os IPs. Observação: elas serão consideradas somente se PublicNetworkAccess estiver habilitado.
properties.partnerRegistrationFullyQualifiedId	string		A ID do ARM totalmente qualificada do registro do parceiro que deve ser associada a esse namespace de parceiro. Isso usa o seguinte formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Isso determina se os eventos publicados nesse namespace de parceiro devem usar o atributo de origem no conteúdo do evento ou usar o nome do canal no cabeçalho ao corresponder ao tópico do parceiro. Se nenhum for especificado, o roteamento de atributo de origem será usado para corresponder ao tópico do parceiro.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		Estado de provisionamento do namespace do parceiro.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando
systemData	systemData		Os metadados do sistema relacionados ao recurso namespace do parceiro.
tags	object		Marcas do recurso.
type	string		Tipo do recurso.

PartnerNamespaceProvisioningState

Estado de provisionamento do namespace do parceiro.

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

PartnerTopicRoutingMode

Isso determina se os eventos publicados nesse namespace de parceiro devem usar o atributo de origem no conteúdo do evento ou usar o nome do canal no cabeçalho ao corresponder ao tópico do parceiro. Se nenhum for especificado, o roteamento de atributo de origem será usado para corresponder ao tópico do parceiro.

Nome	Tipo	Description
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

Status da conexão.

Nome	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

Informações de PrivateEndpoint.

Nome	Tipo	Description
id	string	O identificador arm para o ponto de extremidade privado.

PrivateEndpointConnection

Nome	Tipo	Description
id	string	Identificador totalmente qualificado do recurso.
name	string	Nome do recurso.
properties.groupIds	string[]	GroupIds do recurso de serviço de link privado.
properties.privateEndpoint	PrivateEndpoint	O recurso de ponto de extremidade privado para esta Conexão.
properties.privateLinkServiceConnectionState	ConnectionState	Detalhes sobre o estado da conexão.
properties.provisioningState	ResourceProvisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.
type	string	Tipo do recurso.

PublicNetworkAccess

Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando

Nome	Tipo	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Estado de provisionamento da Conexão de Ponto de Extremidade Privado.

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

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.