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. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API для использования с клиентским запросом.

Ответы

Имя	Тип	Описание
200 OK	PartnerNamespace	ОК
Other Status Codes		Ответы на ошибки: *** 400 — Bad Request (недопустимый запрос). 500 Внутренняя ошибка сервера.

Примеры

PartnerNamespaces_Get

Образец запроса

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

Пример ответа

Код состояния:

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	Сведения о подключенииСостояние.
createdByType	Тип удостоверения, создавшего ресурс.
InboundIpRule
IpActionType	Действие для выполнения на основе соответствия или отсутствия совпадения IpMask.
PartnerNamespace	Пространство имен партнера EventGrid.
PartnerNamespaceProvisioningState	Состояние подготовки пространства имен партнера.
PartnerTopicRoutingMode	Это определяет, должны ли события, опубликованные в этом пространстве имен партнера, использовать атрибут source в полезных данных события или использовать имя канала в заголовке при сопоставлении с партнерским разделом. Если ни один из них не указан, маршрутизация исходных атрибутов будет использоваться для соответствия партнерскому разделу.
PersistedConnectionStatus	Состояние подключения.
PrivateEndpoint	Сведения о PrivateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. Вы можете дополнительно ограничить определенные IP-адреса, настроив
ResourceProvisioningState	Состояние подготовки подключения к частной конечной точке.
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.

ConnectionState

Сведения о подключенииСостояние.

Имя	Тип	Описание
actionsRequired	string	Необходимые действия (если таковые есть).
description	string	Описание состояния подключения.
status	PersistedConnectionStatus	Состояние подключения.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

InboundIpRule

Имя	Тип	Описание
action	IpActionType	Действие для выполнения на основе соответствия или отсутствия совпадения IpMask.
ipMask	string	IP-адрес в нотации CIDR, например 10.0.0.0/8.

IpActionType

Действие для выполнения на основе соответствия или отсутствия совпадения IpMask.

Имя	Тип	Описание
Allow	string

PartnerNamespace

Пространство имен партнера EventGrid.

Имя	Тип	Default value	Описание
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 регистрации партнера, который должен быть связан с этим пространством имен партнера. Этот формат имеет следующий формат: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{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	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое в последний раз изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, изменяющего ресурс в последний раз.