ServiceBusAdministrationClient class

Paket:

@azure/service-bus

Tüm işlemler, ilgili çıkışı içeren bir nesneye çözümleyen vaatler döndürür. Bu nesneler, hizmetten doğrudan yanıta erişmek istiyorsanız kullanabileceğiniz adlı _response bir özelliğe de sahiptir.

Extends

ServiceClient

Oluşturucular

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	ServiceBusAdministrationClient sınıfının yeni bir örneğini başlatır.
ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Devralınan Özellikler

pipeline

bu istemci tarafından istekte bulunmak için kullanılan işlem hattı

Yöntemler

createQueue(string, CreateQueueOptions)	Verilen adla verilen seçenekler kullanılarak yapılandırılmış bir kuyruk oluşturur
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)	Verilen adla, verilen seçenekler kullanılarak yapılandırılmış bir kural oluşturur.
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)	Verilen adla, verilen seçenekler kullanılarak yapılandırılmış bir kural oluşturur.
createSubscription(string, string, CreateSubscriptionOptions)	Verilen adla, verilen seçenekler kullanılarak yapılandırılmış bir abonelik oluşturur
createTopic(string, CreateTopicOptions)	Verilen adla, verilen seçenekler kullanılarak yapılandırılmış bir konu oluşturur
deleteQueue(string, OperationOptions)	Bir kuyruğu siler.
deleteRule(string, string, string, OperationOptions)	Kuralı siler.
deleteSubscription(string, string, OperationOptions)	Aboneliği siler.
deleteTopic(string, OperationOptions)	Bir konuyu siler.
getNamespaceProperties(OperationOptions)	Service Bus ad alanıyla ilgili meta verileri temsil eden bir nesne döndürür.
getQueue(string, OperationOptions)	Kuyruğu ve özelliklerini temsil eden bir nesne döndürür. İleti sayısı ayrıntıları gibi Kuyruk çalışma zamanı bilgilerini almak istiyorsanız API'yi kullanın getQueueRuntimeProperties .
getQueueRuntimeProperties(string, OperationOptions)	İleti sayısı ayrıntıları gibi Kuyruk çalışma zamanı bilgilerini temsil eden bir nesne döndürür.
getRule(string, string, string, OperationOptions)	Tüm özellikleriyle birlikte verilen ada sahip Kuralı temsil eden bir nesne döndürür.
getSubscription(string, string, OperationOptions)	Aboneliği ve özelliklerini temsil eden bir nesne döndürür. İleti sayısı ayrıntıları gibi Abonelik çalışma zamanı bilgilerini almak istiyorsanız API'yi kullanın getSubscriptionRuntimeProperties .
getSubscriptionRuntimeProperties(string, string, OperationOptions)	İleti sayısı ayrıntıları gibi Abonelik çalışma zamanı bilgilerini temsil eden bir nesne döndürür.
getTopic(string, OperationOptions)	Konu başlığını ve özelliklerini temsil eden bir nesne döndürür. Abonelik sayısı ayrıntıları gibi Konu çalışma zamanı bilgilerini almak istiyorsanız API'yi kullanın getTopicRuntimeProperties .
getTopicRuntimeProperties(string, OperationOptions)	Abonelik sayısı gibi Konu çalışma zamanı bilgilerini temsil eden bir nesne döndürür.
listQueues(OperationOptions)	Tüm kuyrukları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. .byPage() sayfalardaki kuyrukları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.
listQueuesRuntimeProperties(OperationOptions)	Kuyrukların çalışma zamanı bilgilerini listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. .byPage() sayfalardaki kuyrukların çalışma zamanı bilgilerini listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.
listRules(string, string, OperationOptions)	Belirtilen abonelik altındaki tüm kuralları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. .byPage() sayfalardaki kuralları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.
listSubscriptions(string, OperationOptions)	Belirtilen konu başlığı altındaki tüm abonelikleri listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür. .byPage() abonelikleri sayfalarda listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Belirtilen konu başlığı altında aboneliklerin çalışma zamanı bilgilerini listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür. .byPage() sayfalardaki aboneliklerin çalışma zamanı bilgilerini listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.
listTopics(OperationOptions)	Tüm konuları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür. .byPage() sayfalardaki konuları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.
listTopicsRuntimeProperties(OperationOptions)	Konuların çalışma zamanı bilgilerini listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür. .byPage() sayfalardaki konuların çalışma zamanı bilgilerini listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.
queueExists(string, OperationOptions)	Belirli bir kuyruğun var olup olmadığını denetler.
ruleExists(string, string, string, OperationOptions)	Belirli bir kuralın mevcut olup olmadığını denetler.
subscriptionExists(string, string, OperationOptions)	Belirli bir aboneliğin konu başlığında mevcut olup olmadığını denetler.
topicExists(string, OperationOptions)	Belirli bir konunun var olup olmadığını denetler.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Sağlanan kuyruk özelliklerine göre kuyruğu Güncelleştirmeler. Yalnızca bir alt kümesi güncelleştirilebilir olsa bile tüm kuyruk özellikleri ayarlanmalıdır. Bu nedenle, önerilen akış çıkışını getQueue()kullanmak, içindeki istenen özellikleri güncelleştirmek ve ardından değiştirilen nesneyi öğesine geçirmektir updateQueue(). Güncelleştirilemeyen özellikler arabirimde QueueProperties salt okunur olarak işaretlenir.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Verilen seçeneklere göre verilen ada göre Kural'da özellikleri Güncelleştirmeler. Bunlardan biri güncelleştirilse bile tüm kural özellikleri ayarlanmalıdır. Bu nedenle, önerilen akış çıkışını getRule()kullanmak, içindeki istenen özellikleri güncelleştirmek ve ardından değiştirilen nesneyi öğesine geçirmektir updateRule().
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Sağlanan abonelik özelliklerine göre aboneliği Güncelleştirmeler. Yalnızca bir alt kümesi güncelleştirilebilir olsa bile tüm abonelik özellikleri ayarlanmalıdır. Bu nedenle, önerilen akış çıkışını getSubscription()kullanmak, içindeki istenen özellikleri güncelleştirmek ve ardından değiştirilen nesneyi öğesine geçirmektir updateSubscription(). Güncelleştirilemeyen özellikler arabirimde SubscriptionProperties salt okunur olarak işaretlenir.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Sağlanan konu özelliklerine göre konuyu Güncelleştirmeler. Yalnızca bir alt kümesi gerçekten güncelleştirilebilir olsa bile tüm konu özellikleri ayarlanmalıdır. Bu nedenle, önerilen akış çıkışını getTopic()kullanmak, içindeki istenen özellikleri güncelleştirmek ve ardından değiştirilen nesneyi öğesine geçirmektir updateTopic(). Güncelleştirilemeyen özellikler arabirimde TopicProperties salt okunur olarak işaretlenir.

Devralınan Yöntemler

sendOperationRequest<T>(OperationArguments, OperationSpec)	Sağlanan OperationSpec kullanılarak doldurulan bir HTTP isteği gönderin.
sendRequest(PipelineRequest)	Sağlanan httpRequest'i gönderin.

Oluşturucu Ayrıntıları

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

ServiceBusAdministrationClient sınıfının yeni bir örneğini başlatır.

new ServiceBusAdministrationClient(connectionString: string, options?: ServiceBusAdministrationClientOptions)

Parametreler

connectionString

string

İstemcinin Azure'a bağlanması için gereken bağlantı dizesi.

options

ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

new ServiceBusAdministrationClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential, options?: ServiceBusAdministrationClientOptions)

Parametreler

fullyQualifiedNamespace

string

Service Bus örneğinizin .servicebus.windows.net benzer olabilecek tam ad alanı.

credential

TokenCredential | NamedKeyCredential

Azure Service Bus ile bağlantının kimliğini doğrulamak üzere belirteci almak için istemci tarafından kullanılan bir kimlik bilgisi nesnesi. Kimlik bilgilerini oluşturmak için bkz. @azure/kimlik. AAD'ye karşı kendi arabirimi uygulamanızı TokenCredential kullanıyorsanız, uygun belirteci almak için service-bus için "kapsamları ["https://servicebus.azure.net//user_impersonation"] " ayarlayın. AzureNamedKeyCredential bağlantı dizesi kullanmadan ve SharedAccessKey geçirmek SharedAccessKeyName istiyorsanız from @azure/core-auth komutunu kullanın. Bu alanlar, içinde sırasıyla ve key alanıyla AzureNamedKeyCredentialeşlername.

options

ServiceBusAdministrationClientOptions

PipelineOptions

Devralınan Özellik Detayları

pipeline

bu istemci tarafından istekte bulunmak için kullanılan işlem hattı

pipeline: Pipeline

Özellik Değeri

Pipeline

Devralınan ServiceClient.pipeline

Yöntem Ayrıntıları

createQueue(string, CreateQueueOptions)

Verilen adla verilen seçenekler kullanılarak yapılandırılmış bir kuyruk oluşturur

function createQueue(queueName: string, options?: CreateQueueOptions): Promise<WithResponse<QueueProperties>>

Parametreler

queueName

string

options

CreateQueueOptions

Oluşturulan Kuyruğu yapılandırma seçenekleri (Örneğin, bir kuyruğu bölümleri veya oturumları destekleyecek şekilde yapılandırabilirsiniz) ve HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek işlem seçenekleri.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<QueueProperties>>

createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)

Verilen adla, verilen seçenekler kullanılarak yapılandırılmış bir kural oluşturur.

function createRule(topicName: string, subscriptionName: string, ruleName: string, ruleFilter: CorrelationRuleFilter | SqlRuleFilter, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

Parametreler

topicName

string

subscriptionName

string

ruleName

string

ruleFilter

CorrelationRuleFilter | SqlRuleFilter

Kuralın değerlendirdığı filtre ifadesini tanımlar.

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<RuleProperties>>

createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)

Verilen adla, verilen seçenekler kullanılarak yapılandırılmış bir kural oluşturur.

function createRule(topicName: string, subscriptionName: string, ruleName: string, ruleFilter: CorrelationRuleFilter | SqlRuleFilter, ruleAction: SqlRuleAction, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

Parametreler

topicName

string

subscriptionName

string

ruleName

string

ruleFilter

CorrelationRuleFilter | SqlRuleFilter

Kuralın değerlendirdığı filtre ifadesini tanımlar.

ruleAction

SqlRuleAction

İlişkili filtre uygulanmalıdır, iletide yürütülebilen SQL like ifadesi.

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Verilen adla, verilen seçenekler kullanılarak yapılandırılmış bir abonelik oluşturur

function createSubscription(topicName: string, subscriptionName: string, options?: CreateSubscriptionOptions): Promise<WithResponse<SubscriptionProperties>>

Parametreler

topicName

string

subscriptionName

string

options

CreateSubscriptionOptions

Oluşturulan Aboneliği yapılandırma seçenekleri (Örneğin, bir Aboneliği bölümleri veya oturumları destekleyecek şekilde yapılandırabilirsiniz) ve HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek işlem seçenekleri.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Verilen adla, verilen seçenekler kullanılarak yapılandırılmış bir konu oluşturur

function createTopic(topicName: string, options?: CreateTopicOptions): Promise<WithResponse<TopicProperties>>

Parametreler

topicName

string

options

CreateTopicOptions

Oluşturulan Konuyu yapılandırma seçenekleri (Örneğin, bölümleri desteklemek için bir konu yapılandırabilirsiniz) ve HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek işlem seçenekleri.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Bir kuyruğu siler.

function deleteQueue(queueName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

Parametreler

queueName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Kuralı siler.

function deleteRule(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

Parametreler

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Aboneliği siler.

function deleteSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

Parametreler

topicName

string

subscriptionName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Bir konuyu siler.

function deleteTopic(topicName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

Parametreler

topicName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Service Bus ad alanıyla ilgili meta verileri temsil eden bir nesne döndürür.

function getNamespaceProperties(operationOptions?: OperationOptions): Promise<WithResponse<NamespaceProperties>>

Parametreler

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Döndürülenler

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Kuyruğu ve özelliklerini temsil eden bir nesne döndürür. İleti sayısı ayrıntıları gibi Kuyruk çalışma zamanı bilgilerini almak istiyorsanız API'yi kullanın getQueueRuntimeProperties .

function getQueue(queueName: string, operationOptions?: OperationOptions): Promise<WithResponse<QueueProperties>>

Parametreler

queueName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

İleti sayısı ayrıntıları gibi Kuyruk çalışma zamanı bilgilerini temsil eden bir nesne döndürür.

function getQueueRuntimeProperties(queueName: string, operationOptions?: OperationOptions): Promise<WithResponse<QueueRuntimeProperties>>

Parametreler

queueName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Tüm özellikleriyle birlikte verilen ada sahip Kuralı temsil eden bir nesne döndürür.

function getRule(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

Parametreler

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Aboneliği ve özelliklerini temsil eden bir nesne döndürür. İleti sayısı ayrıntıları gibi Abonelik çalışma zamanı bilgilerini almak istiyorsanız API'yi kullanın getSubscriptionRuntimeProperties .

function getSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionProperties>>

Parametreler

topicName

string

subscriptionName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

İleti sayısı ayrıntıları gibi Abonelik çalışma zamanı bilgilerini temsil eden bir nesne döndürür.

function getSubscriptionRuntimeProperties(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionRuntimeProperties>>

Parametreler

topicName

string

subscriptionName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Konu başlığını ve özelliklerini temsil eden bir nesne döndürür. Abonelik sayısı ayrıntıları gibi Konu çalışma zamanı bilgilerini almak istiyorsanız API'yi kullanın getTopicRuntimeProperties .

function getTopic(topicName: string, operationOptions?: OperationOptions): Promise<WithResponse<TopicProperties>>

Parametreler

topicName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Abonelik sayısı gibi Konu çalışma zamanı bilgilerini temsil eden bir nesne döndürür.

function getTopicRuntimeProperties(topicName: string, operationOptions?: OperationOptions): Promise<WithResponse<TopicRuntimeProperties>>

Parametreler

topicName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

Tüm kuyrukları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

.byPage() sayfalardaki kuyrukları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

function listQueues(options?: OperationOptions): PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

Parametreler

options

OperationOptions

Döndürülenler

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

Disk belleğini destekleyen asyncIterableIterator.

listQueuesRuntimeProperties(OperationOptions)

Kuyrukların çalışma zamanı bilgilerini listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

.byPage() sayfalardaki kuyrukların çalışma zamanı bilgilerini listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

function listQueuesRuntimeProperties(options?: OperationOptions): PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

Parametreler

options

OperationOptions

Döndürülenler

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

Disk belleğini destekleyen asyncIterableIterator.

listRules(string, string, OperationOptions)

Belirtilen abonelik altındaki tüm kuralları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

.byPage() sayfalardaki kuralları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

function listRules(topicName: string, subscriptionName: string, options?: OperationOptions): PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

Parametreler

topicName

string

subscriptionName

string

options

OperationOptions

Döndürülenler

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

Disk belleğini destekleyen bir asyncIterableIterator.

listSubscriptions(string, OperationOptions)

Belirtilen konu başlığı altındaki tüm abonelikleri listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

.byPage() abonelikleri sayfalarda listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

function listSubscriptions(topicName: string, options?: OperationOptions): PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

Parametreler

topicName

string

options

OperationOptions

Döndürülenler

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

Disk belleğini destekleyen bir asyncIterableIterator.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Belirtilen konu başlığı altında aboneliklerin çalışma zamanı bilgilerini listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

.byPage() sayfalardaki aboneliklerin çalışma zamanı bilgilerini listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

function listSubscriptionsRuntimeProperties(topicName: string, options?: OperationOptions): PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

Parametreler

topicName

string

options

OperationOptions

Döndürülenler

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

Disk belleğini destekleyen bir asyncIterableIterator.

listTopics(OperationOptions)

Tüm konuları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

.byPage() sayfalardaki konuları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

function listTopics(options?: OperationOptions): PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

Parametreler

options

OperationOptions

Döndürülenler

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

Disk belleğini destekleyen bir asyncIterableIterator.

listTopicsRuntimeProperties(OperationOptions)

Konuların çalışma zamanı bilgilerini listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

.byPage() sayfalardaki konuların çalışma zamanı bilgilerini listelemek için zaman uyumsuz yinelenebilir bir yineleyici döndürür.

function listTopicsRuntimeProperties(options?: OperationOptions): PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

Parametreler

options

OperationOptions

Döndürülenler

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

Disk belleğini destekleyen bir asyncIterableIterator.

queueExists(string, OperationOptions)

Belirli bir kuyruğun var olup olmadığını denetler.

function queueExists(queueName: string, operationOptions?: OperationOptions): Promise<boolean>

Parametreler

queueName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Döndürülenler

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Belirli bir kuralın mevcut olup olmadığını denetler.

function ruleExists(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<boolean>

Parametreler

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

Döndürülenler

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Belirli bir aboneliğin konu başlığında mevcut olup olmadığını denetler.

function subscriptionExists(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<boolean>

Parametreler

topicName

string

subscriptionName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Döndürülenler

Promise<boolean>

topicExists(string, OperationOptions)

Belirli bir konunun var olup olmadığını denetler.

function topicExists(topicName: string, operationOptions?: OperationOptions): Promise<boolean>

Parametreler

topicName

string

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Döndürülenler

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Sağlanan kuyruk özelliklerine göre kuyruğu Güncelleştirmeler. Yalnızca bir alt kümesi güncelleştirilebilir olsa bile tüm kuyruk özellikleri ayarlanmalıdır. Bu nedenle, önerilen akış çıkışını getQueue()kullanmak, içindeki istenen özellikleri güncelleştirmek ve ardından değiştirilen nesneyi öğesine geçirmektir updateQueue().

Güncelleştirilemeyen özellikler arabirimde QueueProperties salt okunur olarak işaretlenir.

function updateQueue(queue: WithResponse<QueueProperties>, operationOptions?: OperationOptions): Promise<WithResponse<QueueProperties>>

Parametreler

queue

WithResponse<QueueProperties>

Kuyruğun özelliklerini ve ham yanıtı temsil eden nesne. requiresSession, requiresDuplicateDetection, enablePartitioningve name kuyruk oluşturulduktan sonra güncelleştirilemez.

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<QueueProperties>>

updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)

Verilen seçeneklere göre verilen ada göre Kural'da özellikleri Güncelleştirmeler. Bunlardan biri güncelleştirilse bile tüm kural özellikleri ayarlanmalıdır. Bu nedenle, önerilen akış çıkışını getRule()kullanmak, içindeki istenen özellikleri güncelleştirmek ve ardından değiştirilen nesneyi öğesine geçirmektir updateRule().

function updateRule(topicName: string, subscriptionName: string, rule: WithResponse<RuleProperties>, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

Parametreler

topicName

string

subscriptionName

string

rule

WithResponse<RuleProperties>

Güncelleştirilmekte olan Kuralı ve ham yanıtı yapılandırma seçenekleri. Örneğin, filtreyi ilişkili Konu/Abonelik'e uygulanacak şekilde yapılandırabilirsiniz.

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Sağlanan abonelik özelliklerine göre aboneliği Güncelleştirmeler. Yalnızca bir alt kümesi güncelleştirilebilir olsa bile tüm abonelik özellikleri ayarlanmalıdır. Bu nedenle, önerilen akış çıkışını getSubscription()kullanmak, içindeki istenen özellikleri güncelleştirmek ve ardından değiştirilen nesneyi öğesine geçirmektir updateSubscription().

Güncelleştirilemeyen özellikler arabirimde SubscriptionProperties salt okunur olarak işaretlenir.

function updateSubscription(subscription: WithResponse<SubscriptionProperties>, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionProperties>>

Parametreler

subscription

WithResponse<SubscriptionProperties>

Aboneliğin özelliklerini ve ham yanıtı temsil eden nesne. subscriptionName, topicNameve requiresSession abonelik oluşturulduktan sonra güncelleştirilemez.

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Sağlanan konu özelliklerine göre konuyu Güncelleştirmeler. Yalnızca bir alt kümesi gerçekten güncelleştirilebilir olsa bile tüm konu özellikleri ayarlanmalıdır. Bu nedenle, önerilen akış çıkışını getTopic()kullanmak, içindeki istenen özellikleri güncelleştirmek ve ardından değiştirilen nesneyi öğesine geçirmektir updateTopic().

Güncelleştirilemeyen özellikler arabirimde TopicProperties salt okunur olarak işaretlenir.

function updateTopic(topic: WithResponse<TopicProperties>, operationOptions?: OperationOptions): Promise<WithResponse<TopicProperties>>

Parametreler

topic

WithResponse<TopicProperties>

Konunun özelliklerini ve ham yanıtı temsil eden nesne. requiresDuplicateDetection, enablePartitioningve name konu oluşturulduktan sonra güncelleştirilemez.

operationOptions

OperationOptions

HTTP isteğindeki diğer yapılandırmaları durdurmak, izlemek ve denetlemek için kullanılabilecek seçenekler.

Bu işlemden bekleyebileceğiniz hatalar aşağıdadır

Döndürülenler

Promise<WithResponse<TopicProperties>>

Devralınan Yöntemin Ayrıntıları

sendOperationRequest<T>(OperationArguments, OperationSpec)

Sağlanan OperationSpec kullanılarak doldurulan bir HTTP isteği gönderin.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parametreler

operationArguments

OperationArguments

HTTP isteğinin şablonlu değerlerinin doldurulacağı bağımsız değişkenler.

operationSpec

OperationSpec

httpRequest'i doldurmak için kullanılacak OperationSpec.

Döndürülenler

Promise<T>

Devralınan ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Sağlanan httpRequest'i gönderin.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parametreler

request

PipelineRequest

Döndürülenler

Promise<PipelineResponse>

Devralınan ServiceClient.sendRequest