Partner Namespaces - Get

Odwołanie

Usługa:: Event Grid

Wersja interfejsu API:: 2022-06-15

Pobierz przestrzeń nazw partnera.
Pobieranie właściwości przestrzeni nazw partnera.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
partnerNamespaceName	path	True	string	Nazwa przestrzeni nazw partnera.
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji użytkownika.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta.

Odpowiedzi

Nazwa

Typ

Opis

200 OK

PartnerNamespace

OK

Other Status Codes

Odpowiedzi na błędy: ***

400 Nieprawidłowe żądanie.
500 Wewnętrzny błąd serwera.

Przykłady

PartnerNamespaces_Get

Przykładowe żądanie

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

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

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

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

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

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
ConnectionState	Informacje o parametrze ConnectionState.
createdByType	Typ tożsamości, która utworzyła zasób.
InboundIpRule
IpActionType	Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask.
PartnerNamespace	EventGrid, przestrzeń nazw partnera.
PartnerNamespaceProvisioningState	Stan aprowizacji przestrzeni nazw partnera.
PartnerTopicRoutingMode	Określa to, czy zdarzenia opublikowane w tej przestrzeni nazw partnera powinny używać atrybutu źródłowego w ładunku zdarzenia lub użyć nazwy kanału w nagłówku podczas dopasowywania do tematu partnera. Jeśli żaden z nich nie zostanie określony, routing atrybutów źródłowych będzie używany do dopasowania do tematu partnera.
PersistedConnectionStatus	Stan połączenia.
PrivateEndpoint	Informacje dotyczące prywatnego punktu końcowego.
PrivateEndpointConnection
PublicNetworkAccess	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując
ResourceProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ConnectionState

Objekt

Informacje o parametrze ConnectionState.

Nazwa	Typ	Opis
actionsRequired	string	Wymagane akcje (jeśli istnieją).
description	string	Opis stanu połączenia.
status	PersistedConnectionStatus	Stan połączenia.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

InboundIpRule

Objekt

Nazwa	Typ	Opis
action	IpActionType	Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask.
ipMask	string	Adres IP w notacji CIDR, np. 10.0.0.0/8.

IpActionType

Wyliczanie

Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask.

Wartość	Opis
Allow

PartnerNamespace

Objekt

EventGrid, przestrzeń nazw partnera.

Nazwa	Typ	Domyślna wartość	Opis
id	string		W pełni kwalifikowany identyfikator zasobu.
location	string		Lokalizacja zasobu.
name	string		Nazwa zasobu.
properties.disableLocalAuth	boolean	False	Ta wartość logiczna służy do włączania lub wyłączania uwierzytelniania lokalnego. Wartość domyślna to false. Gdy właściwość jest ustawiona na true, tylko token usługi AAD będzie używany do uwierzytelniania, jeśli użytkownik może publikować dane w przestrzeni nazw partnera.
properties.endpoint	string		Punkt końcowy dla przestrzeni nazw partnera.
properties.inboundIpRules	InboundIpRule[]		Może to służyć do ograniczania ruchu z określonych adresów IP zamiast wszystkich adresów IP. Uwaga: Są one traktowane tylko wtedy, gdy funkcja PublicNetworkAccess jest włączona.
properties.partnerRegistrationFullyQualifiedId	string		W pełni kwalifikowany identyfikator arm rejestracji partnera, który powinien być skojarzony z tą przestrzenią nazw partnera. Ma to następujący format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Określa to, czy zdarzenia opublikowane w tej przestrzeni nazw partnera powinny używać atrybutu źródłowego w ładunku zdarzenia lub użyć nazwy kanału w nagłówku podczas dopasowywania do tematu partnera. Jeśli żaden z nich nie zostanie określony, routing atrybutów źródłowych będzie używany do dopasowania do tematu partnera.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		Stan aprowizacji przestrzeni nazw partnera.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując
systemData	systemData		Metadane systemu odnoszące się do zasobu przestrzeni nazw partnera.
tags	object		Tagi zasobu.
type	string		Typ zasobu.

PartnerNamespaceProvisioningState

Wyliczanie

Stan aprowizacji przestrzeni nazw partnera.

Wartość	Opis
Canceled
Creating
Deleting
Failed
Succeeded
Updating

PartnerTopicRoutingMode

Wyliczanie

Określa to, czy zdarzenia opublikowane w tej przestrzeni nazw partnera powinny używać atrybutu źródłowego w ładunku zdarzenia lub użyć nazwy kanału w nagłówku podczas dopasowywania do tematu partnera. Jeśli żaden z nich nie zostanie określony, routing atrybutów źródłowych będzie używany do dopasowania do tematu partnera.

Wartość	Opis
ChannelNameHeader
SourceEventAttribute

PersistedConnectionStatus

Wyliczanie

Stan połączenia.

Wartość	Opis
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Objekt

Informacje dotyczące prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Identyfikator usługi ARM dla prywatnego punktu końcowego.

PrivateEndpointConnection

Objekt

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu.
name	string	Nazwa zasobu.
properties.groupIds	string[]	GroupIds z zasobu usługi łącza prywatnego.
properties.privateEndpoint	PrivateEndpoint	Zasób prywatnego punktu końcowego dla tego połączenia.
properties.privateLinkServiceConnectionState	ConnectionState	Szczegółowe informacje o stanie połączenia.
properties.provisioningState	ResourceProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
type	string	Typ zasobu.

PublicNetworkAccess

Wyliczanie

Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując

Wartość	Opis
Disabled
Enabled

ResourceProvisioningState

Wyliczanie

Stan aprowizacji połączenia prywatnego punktu końcowego.

Wartość	Opis
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.