Partner Namespaces - Get

リファレンス

サービス:: Event Grid

API バージョン:: 2022-06-15

パートナー名前空間を取得します。
パートナー名前空間のプロパティを取得します。

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

URI パラメーター

名前	/	必須	型	説明
partnerNamespaceName	path	True	string	パートナー名前空間の名前。
resourceGroupName	path	True	string	ユーザーのサブスクリプション内のリソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント要求で使用される API のバージョン。

応答

名前

型

説明

200 OK

PartnerNamespace

OK

Other Status Codes

エラー応答: ***

400 無効な要求です。
500 内部サーバーエラー :

例

PartnerNamespaces_Get

要求のサンプル

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://video2.skills-academy.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

応答のサンプル

状態コード:: 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"
}

定義

名前	説明
ConnectionState	ConnectionState 情報。
createdByType	リソースを作成した ID の種類。
InboundIpRule
IpActionType	IpMask の一致または一致に基づいて実行するアクション。
PartnerNamespace	EventGrid パートナー名前空間。
PartnerNamespaceProvisioningState	パートナー名前空間のプロビジョニング状態。
PartnerTopicRoutingMode	これにより、このパートナー名前空間に発行されたイベントで、イベントペイロードで source 属性を使用するか、パートナートピックと照合するときにヘッダーのチャネル名を使用するかを決定します。何も指定しない場合は、ソース属性ルーティングがパートナートピックと一致するために使用されます。
PersistedConnectionStatus	接続の状態。
PrivateEndpoint	PrivateEndpoint 情報。
PrivateEndpointConnection
PublicNetworkAccess	これにより、トラフィックがパブリックネットワーク経由で許可されるかどうかが決まります。既定では有効になっています。を構成することで、特定の IP にさらに制限できます。
ResourceProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。
systemData	リソースの作成と最後の変更に関連するメタデータ。

ConnectionState

ConnectionState 情報。

名前	型	説明
actionsRequired	string	必要なアクション (ある場合)。
description	string	接続状態の説明。
status	PersistedConnectionStatus	接続の状態。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

名前	型	説明
action	IpActionType	IpMask の一致または一致に基づいて実行するアクション。
ipMask	string	CIDR 表記の IP アドレス (例: 10.0.0.0/8)。

IpActionType

IpMask の一致または一致に基づいて実行するアクション。

名前	型	説明
Allow	string

PartnerNamespace

EventGrid パートナー名前空間。

名前	型	規定値	説明
id	string		リソースの完全修飾識別子。
location	string		リソースの場所。
name	string		リソースの名前。
properties.disableLocalAuth	boolean	False	このブール値は、ローカル認証を有効または無効にするために使用されます。既定値は false です。プロパティが true に設定されている場合、ユーザーがパートナー名前空間への発行を許可されている場合は、AAD トークンのみが認証に使用されます。
properties.endpoint	string		パートナー名前空間のエンドポイント。
properties.inboundIpRules	InboundIpRule[]		これは、すべての IP ではなく、特定の IP からのトラフィックを制限するために使用できます。注: これらは、PublicNetworkAccess が有効になっている場合にのみ考慮されます。
properties.partnerRegistrationFullyQualifiedId	string		このパートナー名前空間に関連付ける必要があるパートナー登録の完全修飾 ARM ID。これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName} の形式になります。
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	これにより、このパートナー名前空間に発行されたイベントで、イベントペイロードで source 属性を使用するか、パートナートピックと照合するときにヘッダーのチャネル名を使用するかを決定します。何も指定しない場合は、ソース属性ルーティングがパートナートピックと一致するために使用されます。
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	PartnerNamespaceProvisioningState		パートナー名前空間のプロビジョニング状態。
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	これにより、トラフィックがパブリックネットワーク経由で許可されるかどうかが決まります。既定では有効になっています。を構成することで、特定の IP にさらに制限できます。
systemData	systemData		パートナー名前空間リソースに関連するシステムメタデータ。
tags	object		リソースのタグ。
type	string		リソースの種類。

PartnerNamespaceProvisioningState

パートナー名前空間のプロビジョニング状態。

名前	型	説明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

PartnerTopicRoutingMode

これにより、このパートナー名前空間に発行されたイベントで、イベントペイロードで source 属性を使用するか、パートナートピックと照合するときにヘッダーのチャネル名を使用するかを決定します。何も指定しない場合は、ソース属性ルーティングがパートナートピックと一致するために使用されます。

名前	型	説明
ChannelNameHeader	string
SourceEventAttribute	string

PersistedConnectionStatus

接続の状態。

名前	型	説明
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint 情報。

名前	型	説明
id	string	プライベートエンドポイントの ARM 識別子。

PrivateEndpointConnection

名前	型	説明
id	string	リソースの完全修飾識別子。
name	string	リソースの名前。
properties.groupIds	string[]	プライベートリンクサービスリソースの GroupIds。
properties.privateEndpoint	PrivateEndpoint	この接続のプライベートエンドポイントリソース。
properties.privateLinkServiceConnectionState	ConnectionState	接続の状態の詳細。
properties.provisioningState	ResourceProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。
type	string	リソースの種類。

PublicNetworkAccess

これにより、トラフィックがパブリックネットワーク経由で許可されるかどうかが決まります。既定では有効になっています。を構成することで、特定の IP にさらに制限できます。

名前	型	説明
Disabled	string
Enabled	string

ResourceProvisioningState

プライベートエンドポイント接続のプロビジョニング状態。

名前	型	説明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。