Namespaces - Get

Referencia

Szolgáltatás:: Service Bus

API-verzió:: 2021-11-01

Lekéri a megadott névtér leírását.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
namespaceName	path	True	string	A névtér neve
resourceGroupName	path	True	string	Az Azure-előfizetés erőforráscsoportjának neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	SBNamespace	A névtér sikeresen visszaadott.
Other Status Codes	ErrorResponse	A ServiceBus hibaválasza leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

NameSpaceGet

Mintakérelem

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


import com.azure.core.util.Context;

/** Samples for Namespaces GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/
     * SBNameSpaceGet.json
     */
    /**
     * Sample code: NameSpaceGet.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void nameSpaceGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getNamespaces()
            .getByResourceGroupWithResponse("ArunMonocle", "sdk-Namespace-2924", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicebus import ServiceBusManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicebus
# USAGE
    python sb_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 = ServiceBusManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5f750a97-50d9-4e36-8081-c9ee4c0210d4",
    )

    response = client.namespaces.get(
        resource_group_name="ArunMonocle",
        namespace_name="sdk-Namespace-2924",
    )
    print(response)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceGet.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 armservicebus_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/servicebus/armservicebus"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceGet.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 := armservicebus.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNamespacesClient().Get(ctx, "ArunMonocle", "sdk-Namespace-2924", 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.SBNamespace = armservicebus.SBNamespace{
	// 	Name: to.Ptr("sdk-Namespace-2924"),
	// 	Type: to.Ptr("Microsoft.ServiceBus/Namespaces"),
	// 	ID: to.Ptr("/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924"),
	// 	Location: to.Ptr("South Central US"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("value1"),
	// 		"tag2": to.Ptr("value2"),
	// 	},
	// 	Properties: &armservicebus.SBNamespaceProperties{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-25T22:26:36.760Z"); return t}()),
	// 		DisableLocalAuth: to.Ptr(false),
	// 		MetricID: to.Ptr("5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924"),
	// 		PrivateEndpointConnections: []*armservicebus.PrivateEndpointConnection{
	// 			{
	// 				Name: to.Ptr("privateEndpointConnectionName"),
	// 				Type: to.Ptr("Microsoft.EventHub/Namespaces/PrivateEndpointConnections"),
	// 				ID: to.Ptr("/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample/privateEndpointConnections/privateEndpointConnectionName"),
	// 				Properties: &armservicebus.PrivateEndpointConnectionProperties{
	// 					PrivateEndpoint: &armservicebus.PrivateEndpoint{
	// 						ID: to.Ptr("/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.Network/privateEndpoints/NamespaceSample"),
	// 					},
	// 					PrivateLinkServiceConnectionState: &armservicebus.ConnectionState{
	// 						Description: to.Ptr("Auto-Approved"),
	// 						Status: to.Ptr(armservicebus.PrivateLinkConnectionStatusApproved),
	// 					},
	// 					ProvisioningState: to.Ptr(armservicebus.EndPointProvisioningStateSucceeded),
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ServiceBusEndpoint: to.Ptr("https://sdk-Namespace-2924.servicebus.windows-int.net:443/"),
	// 		UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-25T22:26:59.350Z"); return t}()),
	// 	},
	// 	SKU: &armservicebus.SBSKU{
	// 		Name: to.Ptr(armservicebus.SKUNameStandard),
	// 		Tier: to.Ptr(armservicebus.SKUTierStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ServiceBusManagementClient } = require("@azure/arm-servicebus");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a description for the specified namespace.
 *
 * @summary Gets a description for the specified namespace.
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceGet.json
 */
async function nameSpaceGet() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const resourceGroupName = "ArunMonocle";
  const namespaceName = "sdk-Namespace-2924";
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.namespaces.get(resourceGroupName, namespaceName);
  console.log(result);
}

nameSpaceGet().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:: 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/",
    "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"
          }
        }
      }
    ]
  }
}

Definíciók

Name	Description
ConnectionState	ConnectionState-adatok.
createdByType	Az erőforrást létrehozó identitás típusa.
EndPointProvisioningState	A privát végpontkapcsolat kiépítési állapota.
Error	A hibaobjektum.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Az erőforrás-kezelési hibaválasz.
keySource	A keySource for Encryption lehetséges értékének számbavétele
KeyVaultProperties	Tulajdonságok a keyVault tulajdonságainak konfigurálásához
ManagedServiceIdentityType	A felügyeltszolgáltatás-identitás típusa.
PrivateEndpoint	PrivateEndpoint-információk.
PrivateEndpointConnection	A PrivateEndpointConnection tulajdonságai.
PrivateLinkConnectionStatus	A kapcsolat állapota.
SBNamespace	Névtérerőforrás leírása.
SBSku	A névtér termékváltozata.
SkuName	A termékváltozat neve.
SkuTier	Az adott termékváltozat számlázási szintje.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserAssignedIdentity	Felismert szótárérték.

ConnectionState

ConnectionState-adatok.

Name	Típus	Description
description	string	A kapcsolat állapotának leírása.
status	PrivateLinkConnectionStatus	A kapcsolat állapota.

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndPointProvisioningState

A privát végpontkapcsolat kiépítési állapota.

Name	Típus	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

Error

A hibaobjektum.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorResponse

Az erőforrás-kezelési hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

keySource

A keySource for Encryption lehetséges értékének számbavétele

Name	Típus	Description
Microsoft.KeyVault	string

KeyVaultProperties

Tulajdonságok a keyVault tulajdonságainak konfigurálásához

Name	Típus	Description
identity.userAssignedIdentity	string	A titkosításhoz kiválasztott felhasználói identitás ARM-azonosítója
keyName	string	A KeyVault kulcsának neve
keyVaultUri	string	A KeyVault URI-ja
keyVersion	string	A KeyVault verziója

ManagedServiceIdentityType

A felügyeltszolgáltatás-identitás típusa.

Name	Típus	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

PrivateEndpoint-információk.

Name	Típus	Description
id	string	A privát végpont ARM-azonosítója.

PrivateEndpointConnection

A PrivateEndpointConnection tulajdonságai.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.privateEndpoint	PrivateEndpoint	A kapcsolat privát végpontjának erőforrása.
properties.privateLinkServiceConnectionState	ConnectionState	A kapcsolat állapotának részletei.
properties.provisioningState	EndPointProvisioningState	A privát végpontkapcsolat kiépítési állapota.
systemData	systemData	Az erőforráshoz kapcsolódó rendszer metaadatai.
type	string	Az erőforrás típusa. Például "Microsoft.EventHub/Namespaces" vagy "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

A kapcsolat állapota.

Name	Típus	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

SBNamespace

Névtérerőforrás leírása.

Name	Típus	Alapértelmezett érték	Description
id	string		Erőforrás-azonosító
identity.principalId	string		ObjectId a KeyVaultból
identity.tenantId	string		TenantId a KeyVaultból
identity.type	ManagedServiceIdentityType		A felügyeltszolgáltatás-identitás típusa.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		A felhasználó által hozzárendelt identitások tulajdonságai
location	string		Az erőforrás földrajzi helye
name	string		Erőforrás neve
properties.alternateName	string		A névtér alternatív neve
properties.createdAt	string		A névtér létrehozásának időpontja
properties.disableLocalAuth	boolean		Ez a tulajdonság letiltja a Service Bus-névtér SAS-hitelesítését.
properties.encryption.keySource	keySource	Microsoft.KeyVault	A keySource for Encryption lehetséges értékének számbavétele
properties.encryption.keyVaultProperties	KeyVaultProperties[]		A KeyVault tulajdonságai
properties.encryption.requireInfrastructureEncryption	boolean		Infrastruktúra-titkosítás engedélyezése (dupla titkosítás)
properties.metricId	string		Az Azure Insights-metrikák azonosítója
properties.privateEndpointConnections	PrivateEndpointConnection[]		Privát végpontkapcsolatok listája.
properties.provisioningState	string		A névtér kiépítési állapota.
properties.serviceBusEndpoint	string		A Service Bus-műveletek végrehajtásához használható végpont.
properties.status	string		A névtér állapota.
properties.updatedAt	string		A névtér frissítésének időpontja.
properties.zoneRedundant	boolean		A tulajdonság engedélyezése prémium szintű Service Bus-névteret hoz létre a támogatott rendelkezésre állási zónákban.
sku	SBSku		A termékváltozat tulajdonságai
systemData	systemData		Az erőforráshoz kapcsolódó rendszer metaadatai.
tags	object		Erőforráscímkék
type	string		Erőforrás típusa

SBSku

A névtér termékváltozata.

Name	Típus	Description
capacity	integer	A szint megadott üzenetkezelési egységei. Prémium szinten a kapacitás 1,2 és 4.
name	SkuName	A termékváltozat neve.
tier	SkuTier	Az adott termékváltozat számlázási szintje.

SkuName

A termékváltozat neve.

Name	Típus	Description
Basic	string
Premium	string
Standard	string

SkuTier

Az adott termékváltozat számlázási szintje.

Name	Típus	Description
Basic	string
Premium	string
Standard	string

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrást legutóbb módosító identitás típusa.
lastModifiedBy	string	Az az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UserAssignedIdentity

Felismert szótárérték.

Name	Típus	Description
clientId	string	A felhasználó által hozzárendelt identitás ügyfélazonosítója
principalId	string	A felhasználó által hozzárendelt identitás egyszerű azonosítója

Megosztás a következőn keresztül:

Namespaces - Get

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

NameSpaceGet

Mintakérelem

Mintaválasz

Definíciók

ConnectionState

createdByType

EndPointProvisioningState

Error

ErrorAdditionalInfo

ErrorResponse

keySource

KeyVaultProperties

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

SBNamespace

SBSku

SkuName

SkuTier

systemData

UserAssignedIdentity

További források