Queues - Get

Referensi

Service:: Service Bus

API Version:: 2021-11-01

Mengembalikan deskripsi untuk antrean yang ditentukan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
namespaceName	path	True	string	Nama namespace
queueName	path	True	string	Nama antrean.
resourceGroupName	path	True	string	Nama grup Sumber Daya dalam langganan Azure.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API klien.

Respons

Nama	Jenis	Deskripsi
200 OK	SBQueue	Deskripsi antrean berhasil dikembalikan.
Other Status Codes	ErrorResponse	Respons kesalahan ServiceBus yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
EntityStatus	Status entitas.
Error	Objek kesalahan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorResponse	Respons kesalahan manajemen sumber daya.
MessageCountDetails	Detail Jumlah Pesan.
SBQueue	Deskripsi Sumber Daya Antrean.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

EntityStatus

Status entitas.

Nama	Jenis	Deskripsi
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

Error

Objek kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorResponse[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorResponse

Respons kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

MessageCountDetails

Detail Jumlah Pesan.

Nama	Jenis	Deskripsi
activeMessageCount	integer	Jumlah pesan aktif dalam antrean, topik, atau langganan.
deadLetterMessageCount	integer	Jumlah pesan yang dihentikan hurufnya.
scheduledMessageCount	integer	Jumlah pesan terjadwal.
transferDeadLetterMessageCount	integer	Jumlah pesan yang ditransfer ke surat mati.
transferMessageCount	integer	Jumlah pesan yang ditransfer ke antrean, topik, atau langganan lain.

SBQueue

Deskripsi Sumber Daya Antrean.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya.
properties.accessedAt	string	Terakhir kali pesan dikirim, atau terakhir kali ada permintaan terima ke antrean ini.
properties.autoDeleteOnIdle	string	Interval diam rentang waktu ISO 8061 setelah antrean dihapus secara otomatis. Durasi minimum adalah 5 menit.
properties.countDetails	MessageCountDetails	Detail Jumlah Pesan.
properties.createdAt	string	Waktu yang tepat pesan dibuat.
properties.deadLetteringOnMessageExpiration	boolean	Nilai yang menunjukkan apakah antrean ini memiliki dukungan surat mati saat pesan kedaluwarsa.
properties.defaultMessageTimeToLive	string	Rentang waktu pesan default ISO 8601 untuk nilai langsung. Ini adalah durasi setelah pesan kedaluwarsa, dimulai dari saat pesan dikirim ke Azure Service Bus. Ini adalah nilai default yang digunakan ketika TimeToLive tidak diatur pada pesan itu sendiri.
properties.duplicateDetectionHistoryTimeWindow	string	Struktur rentang waktu ISO 8601 yang menentukan durasi riwayat deteksi duplikat. Nilai defaultnya adalah 10 menit.
properties.enableBatchedOperations	boolean	Nilai yang menunjukkan apakah operasi batch sisi server diaktifkan.
properties.enableExpress	boolean	Nilai yang menunjukkan apakah Entitas Ekspres diaktifkan. Antrean ekspres menyimpan pesan dalam memori untuk sementara sebelum menulisnya ke penyimpanan persisten.
properties.enablePartitioning	boolean	Nilai yang menunjukkan apakah antrean akan dipartisi di beberapa broker pesan.
properties.forwardDeadLetteredMessagesTo	string	Nama Antrean/Topik untuk meneruskan pesan Surat Mati
properties.forwardTo	string	Nama Antrean/Topik untuk meneruskan pesan
properties.lockDuration	string	Durasi rentang waktu ISO 8601 dari kunci intip; artinya, jumlah waktu pesan dikunci untuk penerima lain. Nilai maksimum untuk LockDuration adalah 5 menit; nilai defaultnya adalah 1 menit.
properties.maxDeliveryCount	integer	Jumlah pengiriman maksimum. Pesan secara otomatis mengalami deadletter setelah jumlah pengiriman ini. nilai default adalah 10.
properties.maxMessageSizeInKilobytes	integer	Ukuran maksimum (dalam KB) payload pesan yang dapat diterima oleh antrean. Properti ini hanya digunakan dalam Premium hari ini dan defaultnya adalah 1024.
properties.maxSizeInMegabytes	integer	Ukuran maksimum antrean dalam megabyte, yang merupakan ukuran memori yang dialokasikan untuk antrean. Defaultnya adalah 1024.
properties.messageCount	integer	Jumlah pesan dalam antrean.
properties.requiresDuplicateDetection	boolean	Nilai yang menunjukkan apakah antrean ini memerlukan deteksi duplikat.
properties.requiresSession	boolean	Nilai yang menunjukkan apakah antrean mendukung konsep sesi.
properties.sizeInBytes	integer	Ukuran antrean, dalam byte.
properties.status	EntityStatus	Menghitung nilai yang mungkin untuk status entitas olahpesan.
properties.updatedAt	string	Waktu yang tepat pesan diperbarui.
systemData	systemData	Data meta sistem yang berkaitan dengan sumber daya ini.
type	string	Jenis sumber daya. Misalnya "Microsoft.EventHub/Namespaces" atau "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Jenis identitas yang terakhir mengubah sumber daya.
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.

Share via

Queues - Get

Parameter URI

Respons

Keamanan

azure_auth

Scopes

Contoh

QueueGet

Sample Request

Sample Response

Definisi

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Sumber Daya Tambahan: