ServiceBusAdministrationClient class

Csomag:

@azure/service-bus

Minden művelet olyan ígéreteket ad vissza, amelyek a megfelelő kimenettel rendelkező objektumra lesznek feloldva. Ezeknek az objektumoknak is van egy _response nevű tulajdonsága, amelyet akkor használhat, ha hozzá szeretne férni a szolgáltatásból érkező közvetlen válaszhoz.

Extends

ServiceClient

Konstruktorok

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	Inicializálja a ServiceBusAdministrationClient osztály új példányát.
ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Örökölt tulajdonságok

pipeline

Az ügyfél által a kérések teljesítéséhez használt folyamat

Metódusok

createQueue(string, CreateQueueOptions)	Egy adott névvel rendelkező üzenetsor létrehozása a megadott beállítások használatával konfigurálva
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)	Létrehoz egy megadott névvel rendelkező szabályt, amely a megadott beállítások használatával van konfigurálva.
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)	Létrehoz egy megadott névvel rendelkező szabályt, amely a megadott beállítások használatával van konfigurálva.
createSubscription(string, string, CreateSubscriptionOptions)	Megadott névvel rendelkező előfizetést hoz létre, amely a megadott beállítások használatával van konfigurálva
createTopic(string, CreateTopicOptions)	Egy megadott névvel rendelkező témakör létrehozása a megadott beállítások használatával konfigurálva
deleteQueue(string, OperationOptions)	Üzenetsor törlése.
deleteRule(string, string, string, OperationOptions)	Töröl egy szabályt.
deleteSubscription(string, string, OperationOptions)	Előfizetés törlése.
deleteTopic(string, OperationOptions)	Egy témakör törlése.
getNamespaceProperties(OperationOptions)	Egy service bus-névtérhez kapcsolódó metaadatokat képviselő objektumot ad vissza.
getQueue(string, OperationOptions)	Az üzenetsort és annak tulajdonságait képviselő objektumot ad vissza. Ha le szeretné kapni az üzenetsor-futtatókörnyezet adatait, például az üzenetszám részleteit, használja getQueueRuntimeProperties API-t.
getQueueRuntimeProperties(string, OperationOptions)	Egy objektumot ad vissza, amely az üzenetsor futásidejű adatait, például az üzenetszám részleteit jelöli.
getRule(string, string, string, OperationOptions)	A szabályt képviselő objektumot adja vissza a megadott névvel és az összes tulajdonságával együtt.
getSubscription(string, string, OperationOptions)	Az előfizetést és annak tulajdonságait képviselő objektumot ad vissza. Ha le szeretné kapni az előfizetés futtatókörnyezetének adatait, például az üzenetszám részleteit, használja getSubscriptionRuntimeProperties API-t.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Az előfizetés futtatókörnyezetének adatait, például az üzenetszám részleteit képviselő objektumot ad vissza.
getTopic(string, OperationOptions)	A témakört és annak tulajdonságait képviselő objektumot ad vissza. Ha le szeretné kapni a témakör futtatókörnyezetének adatait, például az előfizetések számát, használja getTopicRuntimeProperties API-t.
getTopicRuntimeProperties(string, OperationOptions)	A témakör futtatókörnyezeti adatait, például az előfizetések számát képviselő objektumot ad vissza.
listQueues(OperationOptions)	Egy aszinkron iterátort ad vissza az összes üzenetsor listázásához. A .byPage() egy aszinkron iterátorral listázhatja a lapok üzenetsorait.
listQueuesRuntimeProperties(OperationOptions)	Egy aszinkron iterátort ad vissza az üzenetsorok futásidejű adatainak listázásához. A .byPage() egy aszinkron iterátort ad vissza a lapok üzenetsorainak futásidejű adatainak listázásához.
listRules(string, string, OperationOptions)	Egy aszinkron iterátort ad vissza, amely felsorolja a megadott előfizetés összes szabályát. A .byPage() egy aszinkron iterátorral listázhatja a szabályokat a lapokban.
listSubscriptions(string, OperationOptions)	Egy aszinkron iterátort ad vissza a megadott témakör összes előfizetésének listázásához. A .byPage() egy aszinkron iterátorral listázhatja az előfizetéseket a lapokban.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Egy aszinkron iterátort ad vissza a megadott témakör előfizetéseinek futtatókörnyezeti adatainak listázásához. A .byPage() egy aszinkron iterátort ad vissza az előfizetések futásidejű adatainak listázásához a lapokban.
listTopics(OperationOptions)	Egy aszinkron iterátort ad vissza az összes témakör listázásához. A .byPage() egy aszinkron iterátort ad vissza a lapok témaköreinek listázásához.
listTopicsRuntimeProperties(OperationOptions)	Egy aszinkron iterátort ad vissza a témakörök futásidejű adatainak listázásához. A .byPage() egy aszinkron iterátort ad vissza a lapok témaköreinek futásidejű adatainak listázásához.
queueExists(string, OperationOptions)	Ellenőrzi, hogy létezik-e egy adott üzenetsor.
ruleExists(string, string, string, OperationOptions)	Ellenőrzi, hogy létezik-e egy adott szabály.
subscriptionExists(string, string, OperationOptions)	Ellenőrzi, hogy létezik-e egy adott előfizetés a témakörben.
topicExists(string, OperationOptions)	Ellenőrzi, hogy létezik-e egy adott témakör.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Frissíti az üzenetsort a megadott üzenetsor-tulajdonságok alapján. Minden üzenetsor-tulajdonságot be kell állítani annak ellenére, hogy csak egy részhalmazuk frissíthető. Ezért a javasolt folyamat az getQueue()kimenetének használata, a kívánt tulajdonságok frissítése, majd a módosított objektum átadása updateQueue(). A nem frissíthető tulajdonságokat a rendszer a QueueProperties felületen olvashatóként jelöli meg.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	A megadott beállítások alapján frissíti a szabály tulajdonságait a megadott név alapján. Minden szabálytulajdonságnak akkor is be kell állítania, ha valamelyiket frissíti. Ezért a javasolt folyamat az getRule()kimenetének használata, a kívánt tulajdonságok frissítése, majd a módosított objektum átadása updateRule().
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Frissíti az előfizetést a megadott előfizetési tulajdonságok alapján. Minden előfizetési tulajdonságot be kell állítani annak ellenére, hogy csak egy részhalmazuk frissíthető. Ezért a javasolt folyamat az getSubscription()kimenetének használata, a kívánt tulajdonságok frissítése, majd a módosított objektum átadása updateSubscription(). A nem frissíthető tulajdonságokat a rendszer a SubscriptionProperties felületen olvashatóként jelöli meg.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Frissíti a témakört a megadott témakörtulajdonságok alapján. Minden témakörtulajdonságnak be kell állítania annak ellenére, hogy csak egy részhalmaza frissíthető. Ezért a javasolt folyamat az getTopic()kimenetének használata, a kívánt tulajdonságok frissítése, majd a módosított objektum átadása updateTopic(). A nem frissíthető tulajdonságokat a rendszer a TopicProperties felületen olvashatóként jelöli meg.

Örökölt metódusok

sendOperationRequest<T>(OperationArguments, OperationSpec)	Küldjön egy HTTP-kérést, amely a megadott OperationSpec használatával van feltöltve.
sendRequest(PipelineRequest)	Küldje el a megadott httpRequestet.

Konstruktor adatai

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Inicializálja a ServiceBusAdministrationClient osztály új példányát.

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

Paraméterek

connectionString

string

Az ügyfél azure-hoz való csatlakozásához szükséges kapcsolati sztring.

options

ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

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

Paraméterek

fullyQualifiedNamespace

string

A Service Bus-példány teljes névtere, amely valószínűleg hasonló a yournamespace.servicebus.windows.net <>névtérhez.

credential

TokenCredential | NamedKeyCredential

Egy hitelesítő objektum, amellyel az ügyfél lekérheti a jogkivonatot az Azure Service Bus-kapcsolat hitelesítéséhez. A hitelesítő adatok létrehozásához tekintse meg a @azure/identitást. Ha a TokenCredential felület saját implementációját használja az AAD-hez, állítsa be a service-bus hatóköreit ["https://servicebus.azure.net//user_impersonation"] a megfelelő jogkivonat beszerzéséhez. A @azure/core-auth AzureNamedKeyCredential akkor használja, ha kapcsolati sztring használata nélkül szeretne átadni egy SharedAccessKeyName és SharedAccessKey. Ezek a mezők a namekey és AzureNamedKeyCredential mezőjére vannak megfeleltetve.

options

ServiceBusAdministrationClientOptions

PipelineOptions

Örökölt tulajdonság részletei

pipeline

Az ügyfél által a kérések teljesítéséhez használt folyamat

pipeline: Pipeline

Tulajdonság értéke

Pipeline

örökölt ServiceClient.pipeline

Metódus adatai

createQueue(string, CreateQueueOptions)

Egy adott névvel rendelkező üzenetsor létrehozása a megadott beállítások használatával konfigurálva

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

Paraméterek

queueName

string

options

CreateQueueOptions

A létrehozott üzenetsor konfigurálásának beállításai (például konfigurálhat egy üzenetsort partíciók vagy munkamenetek támogatására), valamint a HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és vezérlésére használható műveleti beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<QueueProperties>>

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

Létrehoz egy megadott névvel rendelkező szabályt, amely a megadott beállítások használatával van konfigurálva.

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

Paraméterek

topicName

string

subscriptionName

string

ruleName

string

ruleFilter

CorrelationRuleFilter | SqlRuleFilter

Meghatározza a szabály által kiértékelt szűrőkifejezést.

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<RuleProperties>>

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

Létrehoz egy megadott névvel rendelkező szabályt, amely a megadott beállítások használatával van konfigurálva.

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

Paraméterek

topicName

string

subscriptionName

string

ruleName

string

ruleFilter

CorrelationRuleFilter | SqlRuleFilter

Meghatározza a szabály által kiértékelt szűrőkifejezést.

ruleAction

SqlRuleAction

Az üzeneten végrehajtható SQL-hez hasonló kifejezés a társított szűrő alkalmazása esetén.

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Megadott névvel rendelkező előfizetést hoz létre, amely a megadott beállítások használatával van konfigurálva

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

Paraméterek

topicName

string

subscriptionName

string

options

CreateSubscriptionOptions

A létrehozandó előfizetés konfigurálásának beállításai (például konfigurálhat egy előfizetést partíciók vagy munkamenetek támogatására), valamint a HTTP-kérés egyéb konfigurációinak megszakításához, nyomon követéséhez és szabályozásához használható műveleti beállításokat.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Egy megadott névvel rendelkező témakör létrehozása a megadott beállítások használatával konfigurálva

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

Paraméterek

topicName

string

options

CreateTopicOptions

A létrehozandó témakör konfigurálásának beállításai (például konfigurálhat egy témakört a partíciók támogatásához) és a HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és vezérlésére használható műveleti beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Üzenetsor törlése.

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

Paraméterek

queueName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Töröl egy szabályt.

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

Paraméterek

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Előfizetés törlése.

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

Paraméterek

topicName

string

subscriptionName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Egy témakör törlése.

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

Paraméterek

topicName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Egy service bus-névtérhez kapcsolódó metaadatokat képviselő objektumot ad vissza.

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

Paraméterek

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Válaszok

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Az üzenetsort és annak tulajdonságait képviselő objektumot ad vissza. Ha le szeretné kapni az üzenetsor-futtatókörnyezet adatait, például az üzenetszám részleteit, használja getQueueRuntimeProperties API-t.

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

Paraméterek

queueName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Egy objektumot ad vissza, amely az üzenetsor futásidejű adatait, például az üzenetszám részleteit jelöli.

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

Paraméterek

queueName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

A szabályt képviselő objektumot adja vissza a megadott névvel és az összes tulajdonságával együtt.

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

Paraméterek

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Az előfizetést és annak tulajdonságait képviselő objektumot ad vissza. Ha le szeretné kapni az előfizetés futtatókörnyezetének adatait, például az üzenetszám részleteit, használja getSubscriptionRuntimeProperties API-t.

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

Paraméterek

topicName

string

subscriptionName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Az előfizetés futtatókörnyezetének adatait, például az üzenetszám részleteit képviselő objektumot ad vissza.

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

Paraméterek

topicName

string

subscriptionName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

A témakört és annak tulajdonságait képviselő objektumot ad vissza. Ha le szeretné kapni a témakör futtatókörnyezetének adatait, például az előfizetések számát, használja getTopicRuntimeProperties API-t.

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

Paraméterek

topicName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

A témakör futtatókörnyezeti adatait, például az előfizetések számát képviselő objektumot ad vissza.

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

Paraméterek

topicName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

Egy aszinkron iterátort ad vissza az összes üzenetsor listázásához.

A .byPage() egy aszinkron iterátorral listázhatja a lapok üzenetsorait.

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

Paraméterek

options

OperationOptions

Válaszok

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

Lapozást támogató asyncIterableIterator.

listQueuesRuntimeProperties(OperationOptions)

Egy aszinkron iterátort ad vissza az üzenetsorok futásidejű adatainak listázásához.

A .byPage() egy aszinkron iterátort ad vissza a lapok üzenetsorainak futásidejű adatainak listázásához.

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

Paraméterek

options

OperationOptions

Válaszok

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

Lapozást támogató asyncIterableIterator.

listRules(string, string, OperationOptions)

Egy aszinkron iterátort ad vissza, amely felsorolja a megadott előfizetés összes szabályát.

A .byPage() egy aszinkron iterátorral listázhatja a szabályokat a lapokban.

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

Paraméterek

topicName

string

subscriptionName

string

options

OperationOptions

Válaszok

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

Lapozást támogató asyncIterableIterator.

listSubscriptions(string, OperationOptions)

Egy aszinkron iterátort ad vissza a megadott témakör összes előfizetésének listázásához.

A .byPage() egy aszinkron iterátorral listázhatja az előfizetéseket a lapokban.

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

Paraméterek

topicName

string

options

OperationOptions

Válaszok

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

Lapozást támogató asyncIterableIterator.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Egy aszinkron iterátort ad vissza a megadott témakör előfizetéseinek futtatókörnyezeti adatainak listázásához.

A .byPage() egy aszinkron iterátort ad vissza az előfizetések futásidejű adatainak listázásához a lapokban.

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

Paraméterek

topicName

string

options

OperationOptions

Válaszok

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

Lapozást támogató asyncIterableIterator.

listTopics(OperationOptions)

Egy aszinkron iterátort ad vissza az összes témakör listázásához.

A .byPage() egy aszinkron iterátort ad vissza a lapok témaköreinek listázásához.

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

Paraméterek

options

OperationOptions

Válaszok

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

Lapozást támogató asyncIterableIterator.

listTopicsRuntimeProperties(OperationOptions)

Egy aszinkron iterátort ad vissza a témakörök futásidejű adatainak listázásához.

A .byPage() egy aszinkron iterátort ad vissza a lapok témaköreinek futásidejű adatainak listázásához.

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

Paraméterek

options

OperationOptions

Válaszok

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

Lapozást támogató asyncIterableIterator.

queueExists(string, OperationOptions)

Ellenőrzi, hogy létezik-e egy adott üzenetsor.

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

Paraméterek

queueName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Válaszok

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Ellenőrzi, hogy létezik-e egy adott szabály.

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

Paraméterek

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

Válaszok

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Ellenőrzi, hogy létezik-e egy adott előfizetés a témakörben.

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

Paraméterek

topicName

string

subscriptionName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Válaszok

Promise<boolean>

topicExists(string, OperationOptions)

Ellenőrzi, hogy létezik-e egy adott témakör.

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

Paraméterek

topicName

string

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Válaszok

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Frissíti az üzenetsort a megadott üzenetsor-tulajdonságok alapján. Minden üzenetsor-tulajdonságot be kell állítani annak ellenére, hogy csak egy részhalmazuk frissíthető. Ezért a javasolt folyamat az getQueue()kimenetének használata, a kívánt tulajdonságok frissítése, majd a módosított objektum átadása updateQueue().

A nem frissíthető tulajdonságokat a rendszer a QueueProperties felületen olvashatóként jelöli meg.

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

Paraméterek

queue

WithResponse<QueueProperties>

Az üzenetsor tulajdonságait és a nyers választ képviselő objektum. requiresSession, requiresDuplicateDetection, enablePartitioningés name nem frissíthetők az üzenetsor létrehozása után.

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<QueueProperties>>

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

A megadott beállítások alapján frissíti a szabály tulajdonságait a megadott név alapján. Minden szabálytulajdonságnak akkor is be kell állítania, ha valamelyiket frissíti. Ezért a javasolt folyamat az getRule()kimenetének használata, a kívánt tulajdonságok frissítése, majd a módosított objektum átadása updateRule().

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

Paraméterek

topicName

string

subscriptionName

string

rule

WithResponse<RuleProperties>

A frissítendő szabály és a nyers válasz konfigurálására vonatkozó beállítások. Konfigurálhatja például a szűrőt úgy, hogy a társított témakörre/előfizetésre vonatkozzanak.

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Frissíti az előfizetést a megadott előfizetési tulajdonságok alapján. Minden előfizetési tulajdonságot be kell állítani annak ellenére, hogy csak egy részhalmazuk frissíthető. Ezért a javasolt folyamat az getSubscription()kimenetének használata, a kívánt tulajdonságok frissítése, majd a módosított objektum átadása updateSubscription().

A nem frissíthető tulajdonságokat a rendszer a SubscriptionProperties felületen olvashatóként jelöli meg.

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

Paraméterek

subscription

WithResponse<SubscriptionProperties>

Az előfizetés tulajdonságait és a nyers választ képviselő objektum. subscriptionName, topicNameés requiresSession nem frissíthetők az előfizetés létrehozása után.

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Frissíti a témakört a megadott témakörtulajdonságok alapján. Minden témakörtulajdonságnak be kell állítania annak ellenére, hogy csak egy részhalmaza frissíthető. Ezért a javasolt folyamat az getTopic()kimenetének használata, a kívánt tulajdonságok frissítése, majd a módosított objektum átadása updateTopic().

A nem frissíthető tulajdonságokat a rendszer a TopicProperties felületen olvashatóként jelöli meg.

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

Paraméterek

topic

WithResponse<TopicProperties>

A témakör tulajdonságait és a nyers választ képviselő objektum. requiresDuplicateDetection, enablePartitioningés name nem frissíthetők a témakör létrehozása után.

operationOptions

OperationOptions

A HTTP-kérés egyéb konfigurációinak megszakítására, nyomon követésére és szabályozására használható beállítások.

Az alábbi hibák várhatók a művelettől

Válaszok

Promise<WithResponse<TopicProperties>>

Örökölt metódus részletei

sendOperationRequest<T>(OperationArguments, OperationSpec)

Küldjön egy HTTP-kérést, amely a megadott OperationSpec használatával van feltöltve.

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

Paraméterek

operationArguments

OperationArguments

Azok az argumentumok, amelyekből a HTTP-kérelem sablonértékei ki lesznek töltve.

operationSpec

OperationSpec

A httpRequest feltöltéséhez használandó OperationSpec.

Válaszok

Promise<T>

Örökölt ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Küldje el a megadott httpRequestet.

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

Paraméterek

request

PipelineRequest

Válaszok

Promise<PipelineResponse>

Örökölt ServiceClient.sendRequest