Namespaces - Get

Dienst:: Service Bus

API-Version:: 2024-01-01

Ruft eine Beschreibung für den angegebenen Namespace ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
namespaceName	path	True	string minLength: 6 maxLength: 50	Der Namespacename
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	SBNamespace	Der Namespace wurde erfolgreich zurückgegeben.
Other Status Codes	ErrorResponse	ServiceBus-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

NameSpaceGet

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924?api-version=2024-01-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924",
  "name": "sdk-Namespace-2924",
  "type": "Microsoft.ServiceBus/Namespaces",
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924",
    "createdAt": "2017-05-25T22:26:36.76Z",
    "updatedAt": "2017-05-25T22:26:59.35Z",
    "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/",
    "minimumTlsVersion": "1.2",
    "disableLocalAuth": false,
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample/privateEndpointConnections/privateEndpointConnectionName",
        "name": "privateEndpointConnectionName",
        "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.Network/privateEndpoints/NamespaceSample"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-Approved"
          }
        }
      }
    ]
  }
}

Definitionen

Name	Beschreibung
ConnectionState	Details zum Status der Verbindung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
EndPointProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
Error	Das Fehlerobjekt.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Die Fehlerantwort für die Ressourcenverwaltung.
keySource	Listet den möglichen Wert von keySource für Verschlüsselung auf.
KeyVaultProperties	Eigenschaften von KeyVault
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität.
PrivateEndpoint	Die Private Endpoint-Ressource für diese Verbindung.
PrivateEndpointConnection	Liste der privaten Endpunktverbindungen.
PrivateLinkConnectionStatus	Status der Verbindung.
PublicNetworkAccess	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
SBNamespace	Beschreibung einer Namespaceressource.
SBSku	Eigenschaften der SKU
SkuName	Name dieser SKU.
SkuTier	Die Abrechnungsebene dieser speziellen SKU.
systemData	Die Systemmetadaten, die sich auf diese Ressource beziehen.
TlsVersion	Die mindeste TLS-Version für den Cluster, die unterstützt werden soll, z. B. "1.2"
UserAssignedIdentity	Erkannter Wörterbuchwert.

ConnectionState

Objekt

Details zum Status der Verbindung.

Name	Typ	Beschreibung
description	string	Beschreibung des Verbindungszustands.
status	PrivateLinkConnectionStatus	Status der Verbindung.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

EndPointProvisioningState

Enumeration

Bereitstellungsstatus der privaten Endpunktverbindung.

Wert	Beschreibung
Creating
Updating
Deleting
Succeeded
Canceled
Failed

Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Objekt

Die Fehlerantwort für die Ressourcenverwaltung.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

keySource

Enumeration

Listet den möglichen Wert von keySource für Verschlüsselung auf.

Wert	Beschreibung
Microsoft.KeyVault

KeyVaultProperties

Objekt

Eigenschaften von KeyVault

Name	Typ	Beschreibung
identity.userAssignedIdentity	string	ARM-ID der Benutzeridentität, die für die Verschlüsselung ausgewählt ist
keyName	string	Name des Schlüssels von KeyVault
keyVaultUri	string	URI von KeyVault
keyVersion	string	Version von KeyVault

ManagedServiceIdentityType

Enumeration

Typ der verwalteten Dienstidentität.

Wert	Beschreibung
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

PrivateEndpoint

Objekt

Die Private Endpoint-Ressource für diese Verbindung.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für private Endpunkte.

PrivateEndpointConnection

Objekt

Liste der privaten Endpunktverbindungen.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.privateEndpoint	PrivateEndpoint	Die Private Endpoint-Ressource für diese Verbindung.
properties.privateLinkServiceConnectionState	ConnectionState	Details zum Status der Verbindung.
properties.provisioningState	EndPointProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
systemData	systemData	Die Systemmetadaten, die sich auf diese Ressource beziehen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.EventHub/Namespaces" oder "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Enumeration

Status der Verbindung.

Wert	Beschreibung
Pending
Approved
Rejected
Disconnected

PublicNetworkAccess

Enumeration

Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.

Wert	Beschreibung
Enabled
Disabled
SecuredByPerimeter

SBNamespace

Objekt

Beschreibung einer Namespaceressource.

Name	Typ	Standardwert	Beschreibung
id	string		Ressourcen-ID
identity.principalId	string		ObjectId aus keyVault
identity.tenantId	string		TenantId aus keyVault
identity.type	ManagedServiceIdentityType		Typ der verwalteten Dienstidentität.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		Eigenschaften für vom Benutzer zugewiesene Identitäten
location	string		Der geografische Standort, an dem sich die Ressource befindet
name	string		Ressourcenname
properties.alternateName	string		Alternativer Name für Namespace
properties.createdAt	string (date-time)		Der Zeitpunkt, zu dem der Namespace erstellt wurde
properties.disableLocalAuth	boolean		Diese Eigenschaft deaktiviert die SAS-Authentifizierung für den Service Bus-Namespace.
properties.encryption.keySource	keySource	Microsoft.KeyVault	Listet den möglichen Wert von keySource für Verschlüsselung auf.
properties.encryption.keyVaultProperties	KeyVaultProperties[]		Eigenschaften von KeyVault
properties.encryption.requireInfrastructureEncryption	boolean		Aktivieren der Infrastrukturverschlüsselung (Doppelte Verschlüsselung)
properties.metricId	string		Bezeichner für Azure Insights-Metriken
properties.minimumTlsVersion	TlsVersion		Die mindeste TLS-Version für den Cluster, die unterstützt werden soll, z. B. "1.2"
properties.premiumMessagingPartitions	integer (int32)		Die Anzahl der Partitionen eines Service Bus-Namespaces. Diese Eigenschaft gilt nur für Premium-SKU-Namespaces. Der Standardwert ist 1 und mögliche Werte sind 1, 2 und 4.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste der privaten Endpunktverbindungen.
properties.provisioningState	string		Bereitstellungsstatus des Namespace.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert.
properties.serviceBusEndpoint	string		Endpunkt, den Sie zum Ausführen von ServiceBus-Vorgängen verwenden können.
properties.status	string		Status des Namespace.
properties.updatedAt	string (date-time)		Der Zeitpunkt, zu dem der Namespace aktualisiert wurde.
properties.zoneRedundant	boolean		Diese Eigenschaft gibt an, ob die Zonenredundanz für Namespaces in Regionen aktiviert wurde, die Verfügbarkeitszonen unterstützen.
sku	SBSku		Eigenschaften der SKU
systemData	systemData		Die Systemmetadaten, die sich auf diese Ressource beziehen.
tags	object		Ressourcentags
type	string		Ressourcentyp

SBSku

Objekt

Eigenschaften der SKU

Name	Typ	Beschreibung
capacity	integer (int32)	Messaging-Einheiten für Ihren Servicebus Premium-Namespace. Gültige Kapazitäten sind {1, 2, 4, 8, 16} Vielfache Ihrer Eigenschaften.premiumMessagingPartitions-Einstellung. Wenn "properties.premiumMessagingPartitions" beispielsweise 1 ist, sind mögliche Kapazitätswerte 1, 2, 4, 8 und 16. Wenn properties.premiumMessagingPartitions 4 ist, sind mögliche Kapazitätswerte 4, 8, 16, 32 und 64.
name	SkuName	Name dieser SKU.
tier	SkuTier	Die Abrechnungsebene dieser speziellen SKU.

SkuName

Enumeration

Name dieser SKU.

Wert	Beschreibung
Basic
Standard
Premium

SkuTier

Enumeration

Die Abrechnungsebene dieser speziellen SKU.

Wert	Beschreibung
Basic
Standard
Premium

systemData

Objekt

Die Systemmetadaten, die sich auf diese Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Identitätstyp, der die Ressource zuletzt geändert hat.
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TlsVersion

Enumeration

Die mindeste TLS-Version für den Cluster, die unterstützt werden soll, z. B. "1.2"

Wert	Beschreibung
1.0
1.1
1.2

UserAssignedIdentity

Objekt

Erkannter Wörterbuchwert.

Name	Typ	Beschreibung
clientId	string	Client-ID der vom Benutzer zugewiesenen Identität
principalId	string	Prinzipal-ID der vom Benutzer zugewiesenen Identität

Freigeben über

Namespaces - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

NameSpaceGet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ConnectionState

createdByType

EndPointProvisioningState

Error

ErrorAdditionalInfo

ErrorResponse

keySource

KeyVaultProperties

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

SBNamespace

SBSku

SkuName

SkuTier

systemData

TlsVersion

UserAssignedIdentity