Namespaces - Get

Serviço:

Relay

Versão da API:

2024-01-01

Retorna a descrição do namespace especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	O nome do namespace
resourceGroupName	path	True	string minLength: 1 maxLength: 90	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 da 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 descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

RelayNameSpaceGet

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01?api-version=2024-01-01

Resposta de exemplo

Código de status:

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	O detalhe 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 dessa SKU.
systemData	Metadados relativos à criação e última modificação do recurso.

ConnectionState

Objeto

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

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

EndPointProvisioningState

Enumeração

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

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ErrorAdditionalInfo

Objeto

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

Objeto

O detalhe 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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

PrivateEndpoint

Objeto

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

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

PrivateEndpointConnection

Objeto

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 onde 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	O tipo do recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Enumeração

Status da conexão.

Valor	Description
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Enumeração

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

Valor	Description
Disabled
Enabled
SecuredByPerimeter

RelayNamespace

Objeto

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 (date-time)		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 (date-time)		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

Objeto

SKU do namespace.

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

SkuName

Enumeração

Nome dessa SKU.

Valor	Description
Standard

SkuTier

Enumeração

A camada dessa SKU.

Valor	Description
Standard

systemData

Objeto

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

Nome	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.