Queues - Get

Referentie

Service:: Service Bus

API-versie:: 2024-01-01

Retourneert een beschrijving voor de opgegeven wachtrij.

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

URI-parameters

Name	In	Vereist	Type	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	De naamruimtenaam
queueName	path	True	string minLength: 1	De naam van de wachtrij.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	Abonnementsreferenties waarmee een Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	SBQueue	De beschrijving van de wachtrij is geretourneerd.
Other Status Codes	ErrorResponse	ServiceBus-foutantwoord waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

QueueGet

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=2024-01-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/Queues/SBQueueGet.json
// this example is just showing the usage of "Queues_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceBusQueueResource created on azure
// for more information of creating ServiceBusQueueResource, please refer to the document of ServiceBusQueueResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ArunMonocle";
string namespaceName = "sdk-Namespace-3174";
string queueName = "sdk-Queues-5647";
ResourceIdentifier serviceBusQueueResourceId = ServiceBusQueueResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName, queueName);
ServiceBusQueueResource serviceBusQueue = client.GetServiceBusQueueResource(serviceBusQueueResourceId);

// invoke the operation
ServiceBusQueueResource result = await serviceBusQueue.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ServiceBusQueueData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Voorbeeldrespons

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

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
EntityStatus	Entiteitsstatus.
Error	Het foutobject.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorResponse	Het antwoord van het resourcebeheerfout.
MessageCountDetails	Details van het aantal berichten.
SBQueue	Beschrijving van wachtrijresource.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

EntityStatus

Inventarisatie

Entiteitsstatus.

Waarde	Description
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Object

Het foutobject.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorResponse

Object

Het antwoord van het resourcebeheerfout.

Name	Type	Description
error	Error	Het foutobject.

MessageCountDetails

Object

Details van het aantal berichten.

Name	Type	Description
activeMessageCount	integer (int64)	Aantal actieve berichten in de wachtrij, het onderwerp of het abonnement.
deadLetterMessageCount	integer (int64)	Aantal berichten dat niet is geschreven.
scheduledMessageCount	integer (int64)	Aantal geplande berichten.
transferDeadLetterMessageCount	integer (int64)	Aantal berichten dat is overgebracht naar dode brieven.
transferMessageCount	integer (int64)	Het aantal berichten dat wordt overgedragen naar een andere wachtrij, onderwerp of abonnement.

SBQueue

Object

Beschrijving van wachtrijresource.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.accessedAt	string (date-time)	De laatste keer dat een bericht is verzonden of de laatste keer dat er een ontvangstaanvraag voor deze wachtrij was.
properties.autoDeleteOnIdle	string (duration)	ISO 8061 timeSpan inactief interval waarna de wachtrij automatisch wordt verwijderd. De minimale duur is 5 minuten.
properties.countDetails	MessageCountDetails	Details van het aantal berichten.
properties.createdAt	string (date-time)	Het exacte tijdstip waarop het bericht is gemaakt.
properties.deadLetteringOnMessageExpiration	boolean	Een waarde die aangeeft of deze wachtrij ondersteuning voor dode letters heeft wanneer een bericht verloopt.
properties.defaultMessageTimeToLive	string (duration)	ISO 8601 standaardtijdspanne voor berichten naar livewaarde. Dit is de duur waarna het bericht verloopt, vanaf het moment dat het bericht naar Service Bus wordt verzonden. Dit is de standaardwaarde die wordt gebruikt wanneer TimeToLive niet is ingesteld voor een bericht zelf.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	ISO 8601 timeSpan structuur die de duur van de duplicaatdetectiegeschiedenis definieert. De standaardwaarde is 10 minuten.
properties.enableBatchedOperations	boolean	Waarde die aangeeft of batchbewerkingen aan de serverzijde zijn ingeschakeld.
properties.enableExpress	boolean	Een waarde die aangeeft of Express-entiteiten zijn ingeschakeld. Een snelle wachtrij bevat tijdelijk een bericht in het geheugen voordat u het naar permanente opslag schrijft.
properties.enablePartitioning	boolean	Een waarde die aangeeft of de wachtrij moet worden gepartitioneerd over meerdere berichtbrokers.
properties.forwardDeadLetteredMessagesTo	string	Wachtrij-/onderwerpnaam om het bericht over de dode letter door te sturen
properties.forwardTo	string	Wachtrij-/onderwerpnaam om de berichten door te sturen
properties.lockDuration	string (duration)	ISO 8601 tijdsduur van een peek-lock; Dat wil gezegd, de tijdsduur dat het bericht is vergrendeld voor andere ontvangers. De maximumwaarde voor LockDuration is 5 minuten; de standaardwaarde is 1 minuut.
properties.maxDeliveryCount	integer (int32)	Het maximale aantal leveringen. Na dit aantal leveringen wordt automatisch een bericht met een doodletter weergegeven. de standaardwaarde is 10.
properties.maxMessageSizeInKilobytes	integer (int64)	Maximale grootte (in kB) van de nettolading van het bericht die door de wachtrij kan worden geaccepteerd. Deze eigenschap wordt momenteel alleen gebruikt in Premium en de standaardwaarde is 1024.
properties.maxSizeInMegabytes	integer (int32)	De maximale grootte van de wachtrij in megabytes, de grootte van het geheugen dat voor de wachtrij is toegewezen. De standaardwaarde is 1024.
properties.messageCount	integer (int64)	Het aantal berichten in de wachtrij.
properties.requiresDuplicateDetection	boolean	Een waarde die aangeeft of voor deze wachtrij dubbele detectie is vereist.
properties.requiresSession	boolean	Een waarde die aangeeft of de wachtrij het concept van sessies ondersteunt.
properties.sizeInBytes	integer (int64)	De grootte van de wachtrij, in bytes.
properties.status	EntityStatus	Inventariseert de mogelijke waarden voor de status van een berichtenentiteit.
properties.updatedAt	string (date-time)	De exacte tijd waarop het bericht is bijgewerkt.
systemData	systemData	De systeemmetagegevens met betrekking tot deze resource.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.EventHub/Namespaces' of 'Microsoft.EventHub/Namespaces/EventHubs'

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	Het type identiteit dat de resource voor het laatst heeft gewijzigd.
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Delen via

Queues - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

QueueGet

Voorbeeldaanvraag

Voorbeeldrespons

Definities

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Aanvullende resources