Namespaces - List

Riferimento

Service:: Relay

API Version:: 2021-11-01

Elenchi tutti gli spazi dei nomi disponibili all'interno della sottoscrizione indipendentemente dai resourceGroup.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Relay/namespaces?api-version=2021-11-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione API client.

Risposte

Nome	Tipo	Descrizione
200 OK	RelayNamespaceListResult	Spazi dei nomi restituiti correttamente
Other Status Codes	ErrorResponse	Risposta di errore di inoltro che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

RelayNameSpaceListBySubscription

Sample Request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.Relay/namespaces?api-version=2021-11-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.relay import RelayAPI

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-relay
# USAGE
    python relay_name_space_list_by_subscription.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 = RelayAPI(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.namespaces.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/examples/NameSpaces/RelayNameSpaceListBySubscription.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 armrelay_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/examples/NameSpaces/RelayNameSpaceListBySubscription.json
func ExampleNamespacesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrelay.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewNamespacesClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.NamespaceListResult = armrelay.NamespaceListResult{
		// 	Value: []*armrelay.Namespace{
		// 		{
		// 			Name: to.Ptr("example-RelayRelayNamespace-01"),
		// 			Type: to.Ptr("Microsoft.Relay/Namespaces"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG1-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01"),
		// 			Location: to.Ptr("West US"),
		// 			Tags: map[string]*string{
		// 				"tag1": to.Ptr("value1"),
		// 				"tag2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armrelay.NamespaceProperties{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-01-23T20:34:49.413Z"); return t}()),
		// 				MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-RelayRelayNamespace-01"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				ServiceBusEndpoint: to.Ptr("https://example-RelayRelayNamespace-01.servicebus.windows.net:443/"),
		// 				UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-01-23T20:34:59.413Z"); return t}()),
		// 			},
		// 			SKU: &armrelay.SKU{
		// 				Name: to.Ptr(armrelay.SKUNameStandard),
		// 				Tier: to.Ptr(armrelay.SKUTierStandard),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("example-RelayRelayNamespace-02"),
		// 			Type: to.Ptr("Microsoft.Relay/Namespaces"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG1-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-02"),
		// 			Location: to.Ptr("West US"),
		// 			Tags: map[string]*string{
		// 				"tag1": to.Ptr("value1"),
		// 				"tag2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armrelay.NamespaceProperties{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-01-23T20:34:39.413Z"); return t}()),
		// 				MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-RelayRelayNamespace-02"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				ServiceBusEndpoint: to.Ptr("https://example-RelayRelayNamespace-02.servicebus.windows.net:443/"),
		// 				UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-01-23T20:34:49.413Z"); return t}()),
		// 			},
		// 			SKU: &armrelay.SKU{
		// 				Name: to.Ptr(armrelay.SKUNameStandard),
		// 				Tier: to.Ptr(armrelay.SKUTierStandard),
		// 			},
		// 	}},
		// }
	}
}

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.Relay;
using Azure.ResourceManager.Relay.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/examples/NameSpaces/RelayNameSpaceListBySubscription.json
// this example is just showing the usage of "Namespaces_List" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (RelayNamespaceResource item in subscriptionResource.GetRelayNamespacesAsync())
{
    // the variable item 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
    RelayNamespaceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG1-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01",
      "name": "example-RelayRelayNamespace-01",
      "type": "Microsoft.Relay/Namespaces",
      "location": "West US",
      "sku": {
        "name": "Standard",
        "tier": "Standard"
      },
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-RelayRelayNamespace-01",
        "createdAt": "2017-01-23T20:34:49.4131724Z",
        "serviceBusEndpoint": "https://example-RelayRelayNamespace-01.servicebus.windows.net:443/",
        "updatedAt": "2017-01-23T20:34:59.4131724Z"
      }
    },
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG1-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-02",
      "name": "example-RelayRelayNamespace-02",
      "type": "Microsoft.Relay/Namespaces",
      "location": "West US",
      "sku": {
        "name": "Standard",
        "tier": "Standard"
      },
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-RelayRelayNamespace-02",
        "createdAt": "2017-01-23T20:34:39.4131724Z",
        "serviceBusEndpoint": "https://example-RelayRelayNamespace-02.servicebus.windows.net:443/",
        "updatedAt": "2017-01-23T20:34:49.4131724Z"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
ConnectionState	Dettagli sullo stato della connessione.
createdByType	Tipo di identità che ha creato la risorsa.
EndPointProvisioningState	Stato di provisioning della connessione endpoint privato.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
PrivateEndpoint	Risorsa endpoint privato per questa connessione.
PrivateEndpointConnection	Elenco delle connessioni endpoint private.
PrivateLinkConnectionStatus	Stato della connessione.
PublicNetworkAccess	Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata
RelayNamespace	Risultato dell'operazione dello spazio dei nomi elenco.
RelayNamespaceListResult	Risposta dall'operazione dello spazio dei nomi elenco.
Sku	SKU dello spazio dei nomi.
SkuName	Nome di questo SKU.
SkuTier	Livello di questo SKU.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

ConnectionState

Dettagli sullo stato della connessione.

Nome	Tipo	Descrizione
description	string	Descrizione dello stato della connessione.
status	PrivateLinkConnectionStatus	Stato della connessione.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

EndPointProvisioningState

Stato di provisioning della connessione endpoint privato.

Nome	Tipo	Descrizione
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

PrivateEndpoint

Risorsa endpoint privato per questa connessione.

Nome	Tipo	Descrizione
id	string	Identificatore arm per endpoint privato.

PrivateEndpointConnection

Elenco delle connessioni endpoint private.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Posizione geografica in cui vive la risorsa
name	string	nome della risorsa.
properties.privateEndpoint	PrivateEndpoint	Risorsa endpoint privato per questa connessione.
properties.privateLinkServiceConnectionState	ConnectionState	Dettagli sullo stato della connessione.
properties.provisioningState	EndPointProvisioningState	Stato di provisioning della connessione endpoint privato.
systemData	systemData	Metadati di sistema relativi a questa risorsa.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Stato della connessione.

Nome	Tipo	Descrizione
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata

Nome	Tipo	Descrizione
Disabled	string
Enabled	string
SecuredByPerimeter	string

RelayNamespace

Risultato dell'operazione dello spazio dei nomi elenco.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID risorsa.
location	string		Percorso della risorsa.
name	string		Nome risorsa.
properties.createdAt	string		Ora in cui è stato creato lo spazio dei nomi.
properties.metricId	string		Identificatore per le metriche di Azure Insights.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Elenco delle connessioni endpoint private.
properties.provisioningState	string		Stato di provisioning dello spazio dei nomi.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Ciò determina se il traffico è consentito tramite rete pubblica. Per impostazione predefinita, è abilitata.
properties.serviceBusEndpoint	string		Endpoint che è possibile usare per eseguire operazioni del bus di servizio.
properties.status	string		Stato dello spazio dei nomi.
properties.updatedAt	string		Ora in cui lo spazio dei nomi è stato aggiornato.
sku	Sku		SKU dello spazio dei nomi.
systemData	systemData		Metadati di sistema relativi a questa risorsa.
tags	object		Tag di risorse.
type	string		Tipo di risorsa.

RelayNamespaceListResult

Risposta dall'operazione dello spazio dei nomi elenco.

Nome	Tipo	Descrizione
nextLink	string	Collegamento al set successivo di risultati. Non vuoto se il valore contiene un elenco incompleto di spazi dei nomi.
value	RelayNamespace[]	Risultato dell'operazione dello spazio dei nomi elenco.

Sku

SKU dello spazio dei nomi.

Nome	Tipo	Descrizione
name	SkuName	Nome di questo SKU.
tier	SkuTier	Livello di questo SKU.

SkuName

Nome di questo SKU.

Nome	Tipo	Descrizione
Standard	string

SkuTier

Livello di questo SKU.

Nome	Tipo	Descrizione
Standard	string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.

Namespaces - List

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Scopes

Esempio

RelayNameSpaceListBySubscription

Sample Request

Sample Response

Definizioni

ConnectionState

createdByType

EndPointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

RelayNamespace

RelayNamespaceListResult

Sku

SkuName

SkuTier

systemData

Risorse aggiuntive