Queues - Get

Reference

Služba:: Service Bus

Verze rozhraní API:: 2021-11-01

Vrátí popis zadané fronty.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
namespaceName	path	True	string	Název oboru názvů
queueName	path	True	string	Název fronty.
resourceGroupName	path	True	string	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 je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze klientského rozhraní API

Odpovědi

Name	Typ	Description
200 OK	SBQueue	Popis fronty se úspěšně vrátil.
Other Status Codes	ErrorResponse	Odpověď na chybu ServiceBus popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

QueueGet

Ukázkový požadavek

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


/**
 * Samples for Queues Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
     */
    /**
     * Sample code: QueueGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void queueGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getQueues().getWithResponse("ArunMonocle",
            "sdk-Namespace-3174", "sdk-Queues-5647", com.azure.core.util.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_queue_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.queues.get(
        resource_group_name="ArunMonocle",
        namespace_name="sdk-Namespace-3174",
        queue_name="sdk-Queues-5647",
    )
    print(response)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.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/Queues/SBQueueGet.json
func ExampleQueuesClient_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.NewQueuesClient().Get(ctx, "ArunMonocle", "sdk-Namespace-3174", "sdk-Queues-5647", 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.SBQueue = armservicebus.SBQueue{
	// 	Name: to.Ptr("sdk-Queues-5647"),
	// 	Type: to.Ptr("Microsoft.ServiceBus/Namespaces/Queues"),
	// 	ID: to.Ptr("/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647"),
	// 	Properties: &armservicebus.SBQueueProperties{
	// 		AccessedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
	// 		AutoDeleteOnIdle: to.Ptr("P10675199DT2H48M5.4775807S"),
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T18:07:32.459Z"); return t}()),
	// 		DefaultMessageTimeToLive: to.Ptr("P10675199DT2H48M5.4775807S"),
	// 		DuplicateDetectionHistoryTimeWindow: to.Ptr("PT10M"),
	// 		EnableExpress: to.Ptr(false),
	// 		EnablePartitioning: to.Ptr(true),
	// 		LockDuration: to.Ptr("PT1M"),
	// 		MaxDeliveryCount: to.Ptr[int32](10),
	// 		MaxMessageSizeInKilobytes: to.Ptr[int64](10240),
	// 		MaxSizeInMegabytes: to.Ptr[int32](163840),
	// 		MessageCount: to.Ptr[int64](0),
	// 		RequiresDuplicateDetection: to.Ptr(false),
	// 		RequiresSession: to.Ptr(false),
	// 		SizeInBytes: to.Ptr[int64](0),
	// 		Status: to.Ptr(armservicebus.EntityStatusActive),
	// 		UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T18:07:34.624Z"); return t}()),
	// 	},
	// }
}

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 Returns a description for the specified queue.
 *
 * @summary Returns a description for the specified queue.
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
 */
async function queueGet() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const resourceGroupName = "ArunMonocle";
  const namespaceName = "sdk-Namespace-3174";
  const queueName = "sdk-Queues-5647";
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.queues.get(resourceGroupName, namespaceName, queueName);
  console.log(result);
}

queueGet().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

Ukázková odpověď

Stavový kód:: 200

{
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647",
  "name": "sdk-Queues-5647",
  "type": "Microsoft.ServiceBus/Namespaces/Queues",
  "properties": {
    "lockDuration": "PT1M",
    "maxSizeInMegabytes": 163840,
    "maxMessageSizeInKilobytes": 10240,
    "requiresDuplicateDetection": false,
    "requiresSession": false,
    "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S",
    "duplicateDetectionHistoryTimeWindow": "PT10M",
    "maxDeliveryCount": 10,
    "sizeInBytes": 0,
    "messageCount": 0,
    "status": "Active",
    "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S",
    "enablePartitioning": true,
    "enableExpress": false,
    "createdAt": "2017-05-26T18:07:32.4592931Z",
    "updatedAt": "2017-05-26T18:07:34.6243761Z",
    "accessedAt": "0001-01-01T00:00:00Z"
  }
}

Definice

Name	Description
createdByType	Typ identity, která vytvořila prostředek.
EntityStatus	Stav entity.
Error	Objekt chyby.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu správy prostředků
MessageCountDetails	Podrobnosti o počtu zpráv.
SBQueue	Popis prostředku fronty.
systemData	Metadata týkající se vytvoření a poslední změny prostředku

createdByType

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

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EntityStatus

Stav entity.

Name	Typ	Description
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

Error

Objekt chyby.

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

ErrorAdditionalInfo

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

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

ErrorResponse

Odpověď na chybu správy prostředků

Name	Typ	Description
error	Error	Objekt chyby.

MessageCountDetails

Podrobnosti o počtu zpráv.

Name	Typ	Description
activeMessageCount	integer	Počet aktivních zpráv ve frontě, tématu nebo odběru
deadLetterMessageCount	integer	Počet nedoručených zpráv
scheduledMessageCount	integer	Počet naplánovaných zpráv
transferDeadLetterMessageCount	integer	Počet zpráv přenesených na nedosaděná písmena
transferMessageCount	integer	Počet zpráv přenesených do jiné fronty, tématu nebo odběru

SBQueue

Popis prostředku fronty.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Geografické umístění, ve kterém se nachází prostředek
name	string	Název prostředku
properties.accessedAt	string	Čas posledního odeslání zprávy nebo posledního odeslání žádosti o přijetí do této fronty
properties.autoDeleteOnIdle	string	Iso 8061 timeSpan nečinný interval, po kterém se fronta automaticky odstraní. Minimální doba trvání je 5 minut.
properties.countDetails	MessageCountDetails	Podrobnosti o počtu zpráv.
properties.createdAt	string	Přesný čas vytvoření zprávy
properties.deadLetteringOnMessageExpiration	boolean	Hodnota, která označuje, jestli má tato fronta podporu nedoručených zpráv, když vyprší platnost zprávy.
properties.defaultMessageTimeToLive	string	Výchozí časový rozsah zpráv ISO 8601 na živou hodnotu. Toto je doba, po jejímž uplynutí vyprší platnost zprávy, počínaje odesláním zprávy do služby Service Bus. Toto je výchozí hodnota použitá v případě, že TimeToLive není nastaven na samotnou zprávu.
properties.duplicateDetectionHistoryTimeWindow	string	Iso 8601 timeSpan struktura, která definuje dobu trvání historie detekce duplicit. Výchozí hodnota je 10 minut.
properties.enableBatchedOperations	boolean	Hodnota označující, jestli jsou povolené dávkové operace na straně serveru.
properties.enableExpress	boolean	Hodnota, která označuje, jestli jsou povolené expresní entity. Expresní fronta před zápisem do trvalého úložiště dočasně uchovává zprávu v paměti.
properties.enablePartitioning	boolean	Hodnota, která označuje, jestli má být fronta rozdělena mezi více zprostředkovatelů zpráv.
properties.forwardDeadLetteredMessagesTo	string	Název fronty nebo tématu pro přeposlání nedoručených zpráv
properties.forwardTo	string	Název fronty nebo tématu pro přeposílání zpráv
properties.lockDuration	string	Doba trvání časového rozsahu ISO 8601 peek-lock; to znamená dobu, po kterou je zpráva uzamčena pro ostatní příjemce. Maximální hodnota pro LockDuration je 5 minut; výchozí hodnota je 1 minuta.
properties.maxDeliveryCount	integer	Maximální počet doručení. Po tomto počtu doručení se zpráva automaticky vymačká. výchozí hodnota je 10.
properties.maxMessageSizeInKilobytes	integer	Maximální velikost (v kB) datové části zprávy, kterou může fronta přijmout. Tato vlastnost se dnes používá jenom v Premium a výchozí hodnota je 1024.
properties.maxSizeInMegabytes	integer	Maximální velikost fronty v megabajtech, což je velikost paměti přidělené frontě. Výchozí hodnota je 1024.
properties.messageCount	integer	Počet zpráv ve frontě.
properties.requiresDuplicateDetection	boolean	Hodnota označující, jestli tato fronta vyžaduje detekci duplicit.
properties.requiresSession	boolean	Hodnota, která označuje, jestli fronta podporuje koncept relací.
properties.sizeInBytes	integer	Velikost fronty v bajtech.
properties.status	EntityStatus	Vytvoří výčet možných hodnot pro stav entity zasílání zpráv.
properties.updatedAt	string	Přesný čas, kdy byla zpráva aktualizována.
systemData	systemData	Systémová metadata týkající se tohoto prostředku.
type	string	Typ prostředku. Například Microsoft.EventHub/Namespaces nebo Microsoft.EventHub/Namespaces

systemData

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

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

Sdílet prostřednictvím

Queues - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

QueueGet

Ukázkový požadavek

Ukázková odpověď

Definice

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Další materiály