Namespace Topics - Get

Service:

Event Grid

API Version:

2025-02-15

Get a namespace topic.
Get properties of a namespace topic.

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

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-zA-Z0-9-]*$	Name of the namespace.
resourceGroupName	path	True	string	The name of the resource group within the user's subscription.
subscriptionId	path	True	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
topicName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-zA-Z0-9-]*$	Name of the namespace topic.
api-version	query	True	string	Version of the API to be used with the client request.

Responses

Name	Type	Description
200 OK	NamespaceTopic	OK
Other Status Codes	ErrorResponse	Error response returned if request was unsuccessful.

Examples

NamespaceTopics_Get

Sample request

HTTP

GET https://management.azure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e41/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/examplenamespace2/topics/examplenamespacetopic2?api-version=2025-02-15

Java

/**
 * Samples for NamespaceTopics Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/NamespaceTopics_Get.json
     */
    /**
     * Sample code: NamespaceTopics_Get.
     * 
     * @param manager Entry point to EventGridManager.
     */
    public static void namespaceTopicsGet(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.namespaceTopics().getWithResponse("examplerg", "examplenamespace2", "examplenamespacetopic2",
            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 namespace_topics_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="8f6b6269-84f2-4d09-9e31-1127efcd1e41",
    )

    response = client.namespace_topics.get(
        resource_group_name="examplerg",
        namespace_name="examplenamespace2",
        topic_name="examplenamespacetopic2",
    )
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/NamespaceTopics_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/NamespaceTopics_Get.json
func ExampleNamespaceTopicsClient_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.NewNamespaceTopicsClient().Get(ctx, "examplerg", "examplenamespace2", "examplenamespacetopic2", 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.NamespaceTopic = armeventgrid.NamespaceTopic{
	// 	Name: to.Ptr("examplenamespacetopic2"),
	// 	Type: to.Ptr("Microsoft.EventGrid/namespaces/topics"),
	// 	ID: to.Ptr("/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e41/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/examplenamespace2/topics/examplenamespacetopic2"),
	// 	Properties: &armeventgrid.NamespaceTopicProperties{
	// 		EventRetentionInDays: to.Ptr[int32](1),
	// 		InputSchema: to.Ptr(armeventgrid.EventInputSchemaCloudEventSchemaV10),
	// 		ProvisioningState: to.Ptr(armeventgrid.NamespaceTopicProvisioningStateSucceeded),
	// 		PublisherType: to.Ptr(armeventgrid.PublisherTypeCustom),
	// 	},
	// }
}

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 namespace topic.
 *
 * @summary Get properties of a namespace topic.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/NamespaceTopics_Get.json
 */
async function namespaceTopicsGet() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "8f6b6269-84f2-4d09-9e31-1127efcd1e41";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const namespaceName = "examplenamespace2";
  const topicName = "examplenamespacetopic2";
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.namespaceTopics.get(resourceGroupName, namespaceName, topicName);
  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/NamespaceTopics_Get.json
// this example is just showing the usage of "NamespaceTopics_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 EventGridNamespaceResource created on azure
// for more information of creating EventGridNamespaceResource, please refer to the document of EventGridNamespaceResource
string subscriptionId = "8f6b6269-84f2-4d09-9e31-1127efcd1e41";
string resourceGroupName = "examplerg";
string namespaceName = "examplenamespace2";
ResourceIdentifier eventGridNamespaceResourceId = EventGridNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
EventGridNamespaceResource eventGridNamespace = client.GetEventGridNamespaceResource(eventGridNamespaceResourceId);

// get the collection of this NamespaceTopicResource
NamespaceTopicCollection collection = eventGridNamespace.GetNamespaceTopics();

// invoke the operation
string topicName = "examplenamespacetopic2";
NullableResponse<NamespaceTopicResource> response = await collection.GetIfExistsAsync(topicName);
NamespaceTopicResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    NamespaceTopicData 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

Sample response

Status code:

200

{
  "properties": {
    "provisioningState": "Succeeded",
    "publisherType": "Custom",
    "inputSchema": "CloudEventSchemaV1_0",
    "eventRetentionInDays": 1
  },
  "id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e41/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/examplenamespace2/topics/examplenamespacetopic2",
  "name": "examplenamespacetopic2",
  "type": "Microsoft.EventGrid/namespaces/topics",
  "systemData": null
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
EventInputSchema	This determines the format that is expected for incoming events published to the topic.
NamespaceTopic	Namespace topic details.
NamespaceTopicProvisioningState	Provisioning state of the namespace topic.
PublisherType	Publisher type of the namespace topic.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

EventInputSchema

Enumeration

This determines the format that is expected for incoming events published to the topic.

Value	Description
CloudEventSchemaV1_0

NamespaceTopic

Object

Namespace topic details.

Name	Type	Default value	Description
id	string		Fully qualified identifier of the resource.
name	string		Name of the resource.
properties.eventRetentionInDays	integer (int32)		Event retention for the namespace topic expressed in days. The property default value is 1 day. Min event retention duration value is 1 day and max event retention duration value is 1 day.
properties.inputSchema	EventInputSchema	CloudEventSchemaV1_0	This determines the format that is expected for incoming events published to the topic.
properties.provisioningState	NamespaceTopicProvisioningState		Provisioning state of the namespace topic.
properties.publisherType	PublisherType		Publisher type of the namespace topic.
systemData	systemData		The system metadata relating to the Event Grid resource.
type	string		Type of the resource.

NamespaceTopicProvisioningState

Enumeration

Provisioning state of the namespace topic.

Value	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed
Deleted
DeleteFailed
CreateFailed
UpdatedFailed

PublisherType

Enumeration

Publisher type of the namespace topic.

Value	Description
Custom

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.