Namespaces - Get

Başvuru

Hizmet:: Relay

API Sürümü:: 2021-11-01

Belirtilen ad alanının açıklamasını döndürür.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
namespaceName	path	True	string	Ad alanı adı
resourceGroupName	path	True	string	Azure aboneliğindeki Kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	RelayNamespace	Ad alanı açıklaması başarıyla döndürüldü.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan geçiş hatası yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

RelayNameSpaceGet

Örnek isteği

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01?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_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 = RelayAPI(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.namespaces.get(
        resource_group_name="RG-eg",
        namespace_name="example-RelayRelayNamespace-01",
    )
    print(response)


# x-ms-original-file: specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/examples/NameSpaces/RelayNameSpaceGet.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/RelayNameSpaceGet.json
func ExampleNamespacesClient_Get() {
	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)
	}
	res, err := clientFactory.NewNamespacesClient().Get(ctx, "RG-eg", "example-RelayRelayNamespace-01", 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.Namespace = armrelay.Namespace{
	// 	Name: to.Ptr("example-RelayRelayNamespace-01"),
	// 	Type: to.Ptr("Microsoft.Relay/Namespaces"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-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:38:12.460Z"); 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:38:34.533Z"); 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/RelayNameSpaceGet.json
// this example is just showing the usage of "Namespaces_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 = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "RG-eg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this RelayNamespaceResource
RelayNamespaceCollection collection = resourceGroupResource.GetRelayNamespaces();

// invoke the operation
string namespaceName = "example-RelayRelayNamespace-01";
NullableResponse<RelayNamespaceResource> response = await collection.GetIfExistsAsync(namespaceName);
RelayNamespaceResource 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
    RelayNamespaceData 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

Örnek yanıt

Durum kodu:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-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:38:12.46Z",
    "serviceBusEndpoint": "https://example-RelayRelayNamespace-01.servicebus.windows.net:443/",
    "updatedAt": "2017-01-23T20:38:34.533Z"
  }
}

Tanımlar

Name	Description
ConnectionState	Bağlantının durumuyla ilgili ayrıntılar.
createdByType	Kaynağı oluşturan kimliğin türü.
EndPointProvisioningState	Özel Uç Nokta Bağlantısının sağlama durumu.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
PrivateEndpoint	Bu Bağlantı için Özel Uç Nokta kaynağı.
PrivateEndpointConnection	Özel uç nokta bağlantılarının listesi.
PrivateLinkConnectionStatus	Bağlantının durumu.
PublicNetworkAccess	Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir
RelayNamespace	Ad alanı kaynağının açıklaması.
Sku	Ad alanının SKU'su.
SkuName	Bu SKU'nun adı.
SkuTier	Bu SKU'nun katmanı.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

ConnectionState

Bağlantının durumuyla ilgili ayrıntılar.

Name	Tür	Description
description	string	Bağlantı durumunun açıklaması.
status	PrivateLinkConnectionStatus	Bağlantının durumu.

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndPointProvisioningState

Özel Uç Nokta Bağlantısının sağlama durumu.

Name	Tür	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

PrivateEndpoint

Bu Bağlantı için Özel Uç Nokta kaynağı.

Name	Tür	Description
id	string	Özel Uç Nokta için ARM tanımlayıcısı.

PrivateEndpointConnection

Özel uç nokta bağlantılarının listesi.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Kaynağın bulunduğu coğrafi konum
name	string	Kaynağın adı
properties.privateEndpoint	PrivateEndpoint	Bu Bağlantı için Özel Uç Nokta kaynağı.
properties.privateLinkServiceConnectionState	ConnectionState	Bağlantının durumuyla ilgili ayrıntılar.
properties.provisioningState	EndPointProvisioningState	Özel Uç Nokta Bağlantısının sağlama durumu.
systemData	systemData	Bu kaynakla ilgili sistem meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.EventHub/Namespaces" veya "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Bağlantının durumu.

Name	Tür	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir

Name	Tür	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

RelayNamespace

Ad alanı kaynağının açıklaması.

Name	Tür	Default value	Description
id	string		Kaynak Kimliği.
location	string		Kaynak konumu.
name	string		Kaynak adı.
properties.createdAt	string		Ad alanının oluşturulduğu saat.
properties.metricId	string		Azure Insights ölçümleri için tanımlayıcı.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Özel uç nokta bağlantılarının listesi.
properties.provisioningState	string		Ad Alanının sağlama durumu.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir.
properties.serviceBusEndpoint	string		Service Bus işlemlerini gerçekleştirmek için kullanabileceğiniz uç nokta.
properties.status	string		Ad Alanının durumu.
properties.updatedAt	string		Ad alanının güncelleştirilildiği saat.
sku	Sku		Ad alanının SKU'su.
systemData	systemData		Bu kaynakla ilgili sistem meta verileri.
tags	object		Kaynak etiketleri.
type	string		Kaynak türü.

Sku

Ad alanının SKU'su.

Name	Tür	Description
name	SkuName	Bu SKU'nun adı.
tier	SkuTier	Bu SKU'nun katmanı.

SkuName

Bu SKU'nun adı.

Name	Tür	Description
Standard	string

SkuTier

Bu SKU'nun katmanı.

Name	Tür	Description
Standard	string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

Aracılığıyla paylaş

Namespaces - Get

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

RelayNameSpaceGet

Örnek isteği

Örnek yanıt

Tanımlar

ConnectionState

createdByType

EndPointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

RelayNamespace

Sku

SkuName

SkuTier

systemData

Ek kaynaklar