Partner Namespaces - Get

Szolgáltatás:

Event Grid

API-verzió:

2025-02-15

Partnernévtér lekérése.
Partnernévtér tulajdonságainak lekérése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
partnerNamespaceName	path	True	string	A partnernévtér neve.
resourceGroupName	path	True	string	A felhasználó előfizetésében lévő erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója.

Válaszok

Name	Típus	Description
200 OK	PartnerNamespace	OKÉ
Other Status Codes	ErrorResponse	Sikertelen kérés esetén visszaadott hibaválasz.

Példák

PartnerNamespaces_Get

Mintakérelem

HTTP

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

Java

/**
 * Samples for PartnerNamespaces GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-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",
            com.azure.core.util.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/2025-02-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/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-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");
require("dotenv/config");

/**
 * 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/2025-02-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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.EventGrid.Models;
using Azure.ResourceManager.EventGrid;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-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 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
PartnerNamespaceResource result = await partnerNamespace.GetAsync();

// the variable result 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
PartnerNamespaceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
ConnectionState	ConnectionState-információk.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
InboundIpRule
IpActionType	Az IpMask egyezése vagy nem egyezése alapján végrehajtandó művelet.
PartnerNamespace	EventGrid partnernévtér.
PartnerNamespaceProvisioningState	A partnernévtér kiépítési állapota.
PartnerTopicRoutingMode	Ez határozza meg, hogy a partnernévtérben közzétett események a forrásattribútumot használják-e az esemény hasznos adataiban, vagy a fejlécben lévő csatornanevet használják-e a partnertémakörrel való egyeztetéskor. Ha nincs megadva, a forrásattribútum útválasztása a partnertémakörnek megfelelő lesz.
PersistedConnectionStatus	A kapcsolat állapota.
PrivateEndpoint	PrivateEndpoint-információk.
PrivateEndpointConnection
PublicNetworkAccess	Ez határozza meg, hogy a forgalom engedélyezett-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van. A meghatározott IP-címekre további korlátozást végezhet a konfigurálással
ResourceProvisioningState	A privát végpontkapcsolat kiépítési állapota.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
TlsVersion	A közzétevő minimális TLS-verziója, amely közzétehető ezen a tartományban

ConnectionState

Objektum

ConnectionState-információk.

Name	Típus	Description
actionsRequired	string	Szükséges műveletek (ha vannak ilyenek).
description	string	A kapcsolat állapotának leírása.
status	PersistedConnectionStatus	A kapcsolat állapota.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

InboundIpRule

Objektum

Name	Típus	Description
action	IpActionType	Az IpMask egyezése vagy nem egyezése alapján végrehajtandó művelet.
ipMask	string	IP-cím CIDR-jelölésben, pl. 10.0.0.0/8.

IpActionType

Enumerálás

Az IpMask egyezése vagy nem egyezése alapján végrehajtandó művelet.

Érték	Description
Allow

PartnerNamespace

Objektum

EventGrid partnernévtér.

Name	Típus	Alapértelmezett érték	Description
id	string		Az erőforrás teljes azonosítója.
location	string		Az erőforrás helye.
name	string		Az erőforrás neve.
properties.disableLocalAuth	boolean	False	Ez a logikai érték a helyi hitelesítés engedélyezésére vagy letiltására szolgál. Az alapértelmezett érték hamis. Ha a tulajdonság értéke igaz, a rendszer csak az AAD-jogkivonatot használja a hitelesítéshez, ha a felhasználó közzéteheti a partnernévtérben.
properties.endpoint	string		A partnernévtér végpontja.
properties.inboundIpRules	InboundIpRule[]		Ez az összes IP-cím helyett az adott IP-címekről érkező forgalom korlátozására használható. Megjegyzés: Ezek csak akkor tekinthetők meg, ha a PublicNetworkAccess engedélyezve van.
properties.minimumTlsVersionAllowed	TlsVersion		A közzétevő minimális TLS-verziója, amely közzétehető ebben a partnernévtérben
properties.partnerRegistrationFullyQualifiedId	string		A partnerregisztráció teljes ARM-azonosítója, amelyet ehhez a partnernévtérhez kell társítani. Ez a következő formátumot használja: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Ez határozza meg, hogy a partnernévtérben közzétett események a forrásattribútumot használják-e az esemény hasznos adataiban, vagy a fejlécben lévő csatornanevet használják-e a partnertémakörrel való egyeztetéskor. Ha nincs megadva, a forrásattribútum útválasztása a partnertémakörnek megfelelő lesz.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Privát végpontkapcsolatok listája.
properties.provisioningState	PartnerNamespaceProvisioningState		A partnernévtér kiépítési állapota.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Ez határozza meg, hogy a forgalom engedélyezett-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van. A meghatározott IP-címekre további korlátozást végezhet a konfigurálással
systemData	systemData		Az Event Grid-erőforráshoz kapcsolódó rendszer metaadatai.
tags	object		Az erőforrás címkéi.
type	string		Az erőforrás típusa.

PartnerNamespaceProvisioningState

Enumerálás

A partnernévtér kiépítési állapota.

Érték	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

PartnerTopicRoutingMode

Enumerálás

Ez határozza meg, hogy a partnernévtérben közzétett események a forrásattribútumot használják-e az esemény hasznos adataiban, vagy a fejlécben lévő csatornanevet használják-e a partnertémakörrel való egyeztetéskor. Ha nincs megadva, a forrásattribútum útválasztása a partnertémakörnek megfelelő lesz.

Érték	Description
ChannelNameHeader
SourceEventAttribute

PersistedConnectionStatus

Enumerálás

A kapcsolat állapota.

Érték	Description
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Objektum

PrivateEndpoint-információk.

Name	Típus	Description
id	string	A privát végpont ARM-azonosítója.

PrivateEndpointConnection

Objektum

Name	Típus	Description
id	string	Az erőforrás teljes azonosítója.
name	string	Az erőforrás neve.
properties.groupIds	string[]	GroupIds a privát kapcsolat szolgáltatás erőforrásából.
properties.privateEndpoint	PrivateEndpoint	A kapcsolat privát végpont-erőforrása.
properties.privateLinkServiceConnectionState	ConnectionState	A kapcsolat állapotának részletei.
properties.provisioningState	ResourceProvisioningState	A privát végpontkapcsolat kiépítési állapota.
type	string	Az erőforrás típusa.

PublicNetworkAccess

Enumerálás

Ez határozza meg, hogy a forgalom engedélyezett-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van. A meghatározott IP-címekre további korlátozást végezhet a konfigurálással

Érték	Description
Disabled
Enabled

ResourceProvisioningState

Enumerálás

A privát végpontkapcsolat kiépítési állapota.

Érték	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

TlsVersion

Enumerálás

A közzétevő minimális TLS-verziója, amely közzétehető ezen a tartományban

Érték	Description
1.0
1.1
1.2