Queues - Get

Referens

Service:: Service Bus

API Version:: 2021-11-01

Returnerar en beskrivning för den angivna kön.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
namespaceName	path	True	string	Namnområdesnamnet
queueName	path	True	string	Könamnet.
resourceGroupName	path	True	string	Namnet på resursgruppen i Azure-prenumerationen.
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar en Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	SBQueue	Köbeskrivningen returnerades.
Other Status Codes	ErrorResponse	ServiceBus-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

QueueGet

Sample Request

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


import com.azure.core.util.Context;

/** 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", 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

Sample Response

Status code:: 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"
  }
}

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
EntityStatus	Entitetsstatus.
Error	Felobjektet.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorResponse	Svar på resurshanteringsfel.
MessageCountDetails	Information om antal meddelanden.
SBQueue	Beskrivning av köresurs.
systemData	Metadata som rör skapande och senaste ändring av resursen.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EntityStatus

Entitetsstatus.

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

Error

Felobjektet.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorResponse[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorResponse

Svar på resurshanteringsfel.

Name	Typ	Description
error	Error	Felobjektet.

MessageCountDetails

Information om antal meddelanden.

Name	Typ	Description
activeMessageCount	integer	Antal aktiva meddelanden i kön, ämnet eller prenumerationen.
deadLetterMessageCount	integer	Antal meddelanden som är obeställbara.
scheduledMessageCount	integer	Antal schemalagda meddelanden.
transferDeadLetterMessageCount	integer	Antal meddelanden som överförts till döda brev.
transferMessageCount	integer	Antal meddelanden som överförs till en annan kö, ett ämne eller en annan prenumeration.

SBQueue

Beskrivning av köresurs.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.accessedAt	string	Senaste gången ett meddelande skickades, eller den senaste gången det fanns en mottagningsbegäran till den här kön.
properties.autoDeleteOnIdle	string	ISO 8061 timeSpan inaktivt intervall efter vilket kön tas bort automatiskt. Minimilängden är 5 minuter.
properties.countDetails	MessageCountDetails	Information om antal meddelanden.
properties.createdAt	string	Den exakta tiden då meddelandet skapades.
properties.deadLetteringOnMessageExpiration	boolean	Ett värde som anger om den här kön har stöd för obeställbara meddelanden när ett meddelande upphör att gälla.
properties.defaultMessageTimeToLive	string	ISO 8601 standardmeddelandets tidsintervall till live-värde. Det här är den varaktighet efter vilken meddelandet upphör att gälla, med början när meddelandet skickas till Service Bus. Detta är standardvärdet som används när TimeToLive inte har angetts för själva meddelandet.
properties.duplicateDetectionHistoryTimeWindow	string	ISO 8601 timeSpan-struktur som definierar varaktigheten för dubblettidentifieringshistoriken. Standardvärdet är 10 minuter.
properties.enableBatchedOperations	boolean	Värde som anger om batchåtgärder på serversidan är aktiverade.
properties.enableExpress	boolean	Ett värde som anger om expressentiteter är aktiverade. En expresskö innehåller ett meddelande i minnet tillfälligt innan det skrivs till beständig lagring.
properties.enablePartitioning	boolean	Ett värde som anger om kön ska partitioneras över flera meddelandeköer.
properties.forwardDeadLetteredMessagesTo	string	Kö-/ämnesnamn för att vidarebefordra obeställbara meddelanden
properties.forwardTo	string	Kö-/ämnesnamn för att vidarebefordra meddelanden
properties.lockDuration	string	ISO 8601 tidsintervall för ett peek-lock; dvs. hur lång tid meddelandet är låst för andra mottagare. Det maximala värdet för LockDuration är 5 minuter. standardvärdet är 1 minut.
properties.maxDeliveryCount	integer	Det maximala leveransantalet. Ett meddelande tas automatiskt bort efter det här antalet leveranser. standardvärdet är 10.
properties.maxMessageSizeInKilobytes	integer	Maximal storlek (i kB) för meddelandenyttolasten som kan accepteras av kön. Den här egenskapen används endast i Premium i dag och standardvärdet är 1024.
properties.maxSizeInMegabytes	integer	Den maximala storleken på kön i megabyte, vilket är storleken på det minne som allokerats för kön. Standardvärdet är 1024.
properties.messageCount	integer	Antalet meddelanden i kön.
properties.requiresDuplicateDetection	boolean	Ett värde som anger om den här kön kräver dubblettidentifiering.
properties.requiresSession	boolean	Ett värde som anger om kön stöder begreppet sessioner.
properties.sizeInBytes	integer	Storleken på kön i byte.
properties.status	EntityStatus	Räknar upp möjliga värden för status för en meddelandeentitet.
properties.updatedAt	string	Den exakta tiden då meddelandet uppdaterades.
systemData	systemData	Systemmetadata som är relaterade till den här resursen.
type	string	Resurstypen. Till exempel "Microsoft.EventHub/Namespaces" eller "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Den typ av identitet som senast ändrade resursen.
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Queues - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

QueueGet

Sample Request

Sample Response

Definitioner

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Ytterligare resurser