Namespaces - Get

Služba:

Relay

Verze rozhraní API:

2024-01-01

Vrátí popis zadaného oboru názvů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	Název oboru názvů
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků v rámci předplatného Azure
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	RelayNamespace	Popis oboru názvů se úspěšně vrátil.
Other Status Codes	ErrorResponse	Odpověď na chybu služby Relay popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

RelayNameSpaceGet

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
ConnectionState	Podrobnosti o stavu připojení
createdByType	Typ identity, která prostředek vytvořila.
EndPointProvisioningState	Stav zřizování připojení privátního koncového bodu
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
PrivateEndpoint	Prostředek privátního koncového bodu pro toto připojení.
PrivateEndpointConnection	Seznam připojení privátních koncových bodů
PrivateLinkConnectionStatus	Stav připojení.
PublicNetworkAccess	To určuje, jestli je provoz povolený přes veřejnou síť. Ve výchozím nastavení je povolená.
RelayNamespace	Popis prostředku oboru názvů
Sku	Skladová položka oboru názvů.
SkuName	Název této skladové položky.
SkuTier	Úroveň této skladové položky.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

ConnectionState

Objekt

Podrobnosti o stavu připojení

Name	Typ	Description
description	string	Popis stavu připojení
status	PrivateLinkConnectionStatus	Stav připojení.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
Application
Key
ManagedIdentity
User

EndPointProvisioningState

Výčet

Stav zřizování připojení privátního koncového bodu

Hodnota	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

PrivateEndpoint

Objekt

Prostředek privátního koncového bodu pro toto připojení.

Name	Typ	Description
id	string	Identifikátor ARM pro privátní koncový bod.

PrivateEndpointConnection

Objekt

Seznam připojení privátních koncových bodů

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.privateEndpoint	PrivateEndpoint	Prostředek privátního koncového bodu pro toto připojení.
properties.privateLinkServiceConnectionState	ConnectionState	Podrobnosti o stavu připojení
properties.provisioningState	EndPointProvisioningState	Stav zřizování připojení privátního koncového bodu
systemData	systemData	Systémová meta data týkající se tohoto prostředku.
type	string	Typ prostředku. Například Microsoft.EventHub/Namespaces nebo Microsoft.EventHub/Namespaces

PrivateLinkConnectionStatus

Výčet

Stav připojení.

Hodnota	Description
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Výčet

To určuje, jestli je provoz povolený přes veřejnou síť. Ve výchozím nastavení je povolená.

Hodnota	Description
Disabled
Enabled
SecuredByPerimeter

RelayNamespace

Objekt

Popis prostředku oboru názvů

Name	Typ	Default value	Description
id	string		ID prostředku.
location	string		Umístění prostředku
name	string		Název prostředku
properties.createdAt	string (date-time)		Čas vytvoření oboru názvů.
properties.metricId	string		Identifikátor metrik Azure Insights
properties.privateEndpointConnections	PrivateEndpointConnection[]		Seznam připojení privátních koncových bodů
properties.provisioningState	string		Stav zřizování oboru názvů
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	To určuje, jestli je provoz povolený přes veřejnou síť. Ve výchozím nastavení je povolená.
properties.serviceBusEndpoint	string		Koncový bod, který můžete použít k provádění operací služby Service Bus.
properties.status	string		Stav oboru názvů
properties.updatedAt	string (date-time)		Čas aktualizace oboru názvů.
sku	Sku		Skladová položka oboru názvů.
systemData	systemData		Systémová meta data týkající se tohoto prostředku.
tags	object		Značky prostředků
type	string		Typ zdroje.

Sku

Objekt

Skladová položka oboru názvů.

Name	Typ	Description
name	SkuName	Název této skladové položky.
tier	SkuTier	Úroveň této skladové položky.

SkuName

Výčet

Název této skladové položky.

Hodnota	Description
Standard

SkuTier

Výčet

Úroveň této skladové položky.

Hodnota	Description
Standard

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.