Namespaces - Get

Service:

Relay

API Version:

2021-11-01

Retorna a descrição do namespace especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
namespaceName	path	True	string	O nome do namespace
resourceGroupName	path	True	string	Nome do grupo de recursos na assinatura do Azure.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão de API do cliente.

Respostas

Nome	Tipo	Description
200 OK	RelayNamespace	Descrição do namespace retornada com êxito.
Other Status Codes	ErrorResponse	Resposta de erro de retransmissão que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

RelayNameSpaceGet

Sample Request

HTTP

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

Python

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

Go

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

dotnet

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

Sample Response

Status code:

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"
  }
}

Definições

Nome	Description
ConnectionState	Detalhes sobre o estado da conexão.
createdByType	O tipo de identidade que criou o recurso.
EndPointProvisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	Os detalhes do erro.
ErrorResponse	Resposta de erro
PrivateEndpoint	O recurso de ponto de extremidade privado para esta Conexão.
PrivateEndpointConnection	Lista de conexões de ponto de extremidade privado.
PrivateLinkConnectionStatus	Status da conexão.
PublicNetworkAccess	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado
RelayNamespace	Descrição de um recurso de namespace.
Sku	SKU do namespace.
SkuName	Nome dessa SKU.
SkuTier	A camada desse SKU.
systemData	Metadados relativos à criação e à última modificação do recurso.

ConnectionState

Detalhes sobre o estado da conexão.

Nome	Tipo	Description
description	string	Descrição do estado da conexão.
status	PrivateLinkConnectionStatus	Status da conexão.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndPointProvisioningState

Estado de provisionamento da Conexão de Ponto de Extremidade Privado.

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

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

PrivateEndpoint

O recurso de ponto de extremidade privado para esta Conexão.

Nome	Tipo	Description
id	string	O identificador arm para o ponto de extremidade privado.

PrivateEndpointConnection

Lista de conexões de ponto de extremidade privado.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização geográfica em que o recurso reside
name	string	O nome do recurso
properties.privateEndpoint	PrivateEndpoint	O recurso de ponto de extremidade privado para esta Conexão.
properties.privateLinkServiceConnectionState	ConnectionState	Detalhes sobre o estado da conexão.
properties.provisioningState	EndPointProvisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.
systemData	systemData	Os metadados do sistema relacionados a esse recurso.
type	string	Tipo do recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Status da conexão.

Nome	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado

Nome	Tipo	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

RelayNamespace

Descrição de um recurso de namespace.

Nome	Tipo	Valor padrão	Description
id	string		ID do recurso.
location	string		Local do recurso.
name	string		Nome do recurso.
properties.createdAt	string		A hora em que o namespace foi criado.
properties.metricId	string		Identificador para métricas do Azure Insights.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de conexões de ponto de extremidade privado.
properties.provisioningState	string		Estado de provisionamento do Namespace.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.
properties.serviceBusEndpoint	string		Ponto de extremidade que você pode usar para executar operações do Barramento de Serviço.
properties.status	string		Status do Namespace.
properties.updatedAt	string		A hora em que o namespace foi atualizado.
sku	Sku		SKU do namespace.
systemData	systemData		Os metadados do sistema relacionados a esse recurso.
tags	object		Marcas de recurso.
type	string		Tipo de recurso.

Sku

SKU do namespace.

Nome	Tipo	Description
name	SkuName	Nome dessa SKU.
tier	SkuTier	A camada desse SKU.

SkuName

Nome dessa SKU.

Nome	Tipo	Description
Standard	string

SkuTier

A camada desse SKU.

Nome	Tipo	Description
Standard	string

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.