ServiceBusAdministrationClient class

Csomag:

@azure/service-bus

Minden művelet olyan ígéreteket ad vissza, amelyek a megfelelő kimenettel rendelkező objektumra lesznek feloldva. Ezek az objektumok rendelkeznek egy nevű tulajdonságtal _response is, 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ő üzenetsort hoz létre, amely a megadott beállítások használatával van konfigurálva
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)	Létrehoz egy megadott névvel rendelkező szabályt, amely a megadott beállításokkal 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ásokkal van konfigurálva.
createSubscription(string, string, CreateSubscriptionOptions)	Létrehoz egy adott névvel rendelkező előfizetést, amely a megadott beállítások használatával van konfigurálva
createTopic(string, CreateTopicOptions)	Létrehoz egy adott névvel rendelkező témakört, amely a megadott beállítások használatával van konfigurálva
deleteQueue(string, OperationOptions)	Üzenetsor törlése.
deleteRule(string, string, string, OperationOptions)	Szabály törlése.
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 az API-t getQueueRuntimeProperties .
getQueueRuntimeProperties(string, OperationOptions)	Egy objektumot ad vissza, amely az üzenetsor-futtatókörnyezet adatait( például az üzenetszám részleteit) adja vissza.
getRule(string, string, string, OperationOptions)	Egy olyan objektumot ad vissza, amely a szabályt a megadott névvel és az összes tulajdonságával együtt jelöli.
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 az API-t getSubscriptionRuntimeProperties .
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Egy objektumot ad vissza, amely az előfizetés futtatókörnyezetének adatait, például az üzenetszám részleteit jelöli.
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 az API-t getTopicRuntimeProperties .
getTopicRuntimeProperties(string, OperationOptions)	Egy objektumot ad vissza, amely a témakör futtatókörnyezetének adatait( például az előfizetések számát) adja vissza.
listQueues(OperationOptions)	Egy aszinkron iterálót ad vissza az összes üzenetsor listázásához. A .byPage() egy aszinkron iterátorral listázhatja az üzenetsorokat a lapokban.
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álót ad vissza a megadott előfizetésben lévő összes szabály listázásához. A .byPage() egy aszinkron iterátorral listázhatja a szabályokat a lapokban.
listSubscriptions(string, OperationOptions)	Egy aszinkron iterálót 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átorral adja vissza a megadott témakör előfizetéseinek futásidejű adatait. A .byPage() egy aszinkron iterátorral listázhatja az előfizetések futásidejű adatait a lapokban.
listTopics(OperationOptions)	Egy aszinkron iterálót ad vissza az összes témakör listázásához. A .byPage() egy aszinkron iterátorral listázhatja a témaköröket a lapokban.
listTopicsRuntimeProperties(OperationOptions)	Egy aszinkron iterálót 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ítések 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 a következő kimenetének getQueue()használata: , frissítse a kívánt tulajdonságokat, majd adja át a módosított objektumot a következőnek updateQueue(): . A nem frissíthető tulajdonságokat a rendszer írásvédettként jelöli meg a QueueProperties felületen.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Frissítések a szabály tulajdonságait a megadott beállítások alapján a megadott név alapján. Minden szabálytulajdonságnak akkor is be kell állítania, ha az egyiket frissíti. Ezért a javasolt folyamat a következő kimenetének getRule()használata: , frissítse a kívánt tulajdonságokat, majd adja át a módosított objektumot a következőnek updateRule(): .
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Frissítések 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 a következő kimenetének getSubscription()használata: , frissítse a kívánt tulajdonságokat, majd adja át a módosított objektumot a következőnek updateSubscription(): . A nem frissíthető tulajdonságokat a rendszer írásvédettként jelöli meg a SubscriptionProperties felületen.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Frissítések 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 azok csak egy részhalmaza frissíthető. Ezért a javasolt folyamat a következő kimenetének getTopic()használata: , frissítse a kívánt tulajdonságokat, majd adja át a módosított objektumot a következőnek updateTopic(): . A nem frissíthető tulajdonságokat a rendszer írásvédettként jelöli meg a TopicProperties felületen.

Örökölt metódusok

sendOperationRequest<T>(OperationArguments, OperationSpec)	Küldjön egy HTTP-kérést, amely a megadott OperationSpec paranccsal van feltöltve.
sendRequest(PipelineRequest)	Küldje el a megadott httpRequest címet.

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 .servicebus.windows.net-hez.

credential

TokenCredential | NamedKeyCredential

Az ügyfél által használt hitelesítőadat-objektum, amellyel lekérheti a jogkivonatot a Azure Service Bus való kapcsolat hitelesítéséhez. A hitelesítő adatok létrehozásához lásd: @azure/identitás. Ha a felület saját implementációját használja az TokenCredential AAD-hez, állítsa be a service-bus ["https://servicebus.azure.net//user_impersonation"] "hatóköreit" a megfelelő jogkivonat beszerzéséhez. AzureNamedKeyCredential A from @azure/core-auth parancsot akkor használja, ha kapcsolati sztring használata nélkül szeretne megadni egy SharedAccessKeyName és SharedAccessKey értéket. Ezek a mezők a és key a name mezőre vannak képezve a mezőbenAzureNamedKeyCredential.

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 forrás ServiceClient.pipeline

Metódus adatai

createQueue(string, CreateQueueOptions)

Egy adott névvel rendelkező üzenetsort hoz létre, amely a megadott beállítások használatával van 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ához, nyomon követéséhez és vezérléséhez használható műveleti beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

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ásokkal 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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

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ásokkal 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, ha a társított szűrő alkalmazandó.

operationOptions

OperationOptions

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ó beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

Válaszok

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Létrehoz egy adott névvel rendelkező előfizetést, 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 (Konfigurálhat például 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 vezérléséhez használható műveleti beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

Válaszok

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Létrehoz egy adott névvel rendelkező témakört, amely a megadott beállítások használatával van 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), valamint a HTTP-kérés egyéb konfigurációinak megszakításához, nyomon követéséhez és vezérléséhez használható műveleti beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

Válaszok

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Szabály törlése.

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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

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ához, nyomon követéséhez és szabályozásához 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 az API-t getQueueRuntimeProperties .

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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

Válaszok

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Egy objektumot ad vissza, amely az üzenetsor-futtatókörnyezet adatait( például az üzenetszám részleteit) adja vissza.

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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

Válaszok

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Egy olyan objektumot ad vissza, amely a szabályt a megadott névvel és az összes tulajdonságával együtt jelöli.

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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

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 az API-t getSubscriptionRuntimeProperties .

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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

Válaszok

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

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

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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

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 az API-t getTopicRuntimeProperties .

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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

Válaszok

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Egy objektumot ad vissza, amely a témakör futtatókörnyezetének adatait( például az előfizetések számát) adja 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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

Válaszok

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

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

A .byPage() egy aszinkron iterátorral listázhatja az üzenetsorokat a lapokban.

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álót ad vissza a megadott előfizetésben lévő összes szabály listázásához.

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álót 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átorral adja vissza a megadott témakör előfizetéseinek futásidejű adatait.

A .byPage() egy aszinkron iterátorral listázhatja az előfizetések futásidejű adatait 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álót ad vissza az összes témakör listázásához.

A .byPage() egy aszinkron iterátorral listázhatja a témaköröket a lapokban.

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álót 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ához, nyomon követéséhez és szabályozásához 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ához, nyomon követéséhez és szabályozásához 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ához, nyomon követéséhez és szabályozásához használható beállítások.

Válaszok

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Frissítések 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 a következő kimenetének getQueue()használata: , frissítse a kívánt tulajdonságokat, majd adja át a módosított objektumot a következőnek updateQueue(): .

A nem frissíthető tulajdonságokat a rendszer írásvédettként jelöli meg a QueueProperties felületen.

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ő az üzenetsor létrehozása után.

operationOptions

OperationOptions

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ó beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

Válaszok

Promise<WithResponse<QueueProperties>>

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

Frissítések a szabály tulajdonságait a megadott beállítások alapján a megadott név alapján. Minden szabálytulajdonságnak akkor is be kell állítania, ha az egyiket frissíti. Ezért a javasolt folyamat a következő kimenetének getRule()használata: , frissítse a kívánt tulajdonságokat, majd adja át a módosított objektumot a következőnek 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ának beállításai. Konfigurálhatja például úgy a szűrőt, 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ához, nyomon követéséhez és szabályozásához használható beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

Válaszok

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Frissítések 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 a következő kimenetének getSubscription()használata: , frissítse a kívánt tulajdonságokat, majd adja át a módosított objektumot a következőnek updateSubscription(): .

A nem frissíthető tulajdonságokat a rendszer írásvédettként jelöli meg a SubscriptionProperties felületen.

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 jelképező objektum. subscriptionName, topicNameés requiresSession nem frissíthető az előfizetés létrehozása után.

operationOptions

OperationOptions

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ó beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

Válaszok

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Frissítések 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 azok csak egy részhalmaza frissíthető. Ezért a javasolt folyamat a következő kimenetének getTopic()használata: , frissítse a kívánt tulajdonságokat, majd adja át a módosított objektumot a következőnek updateTopic(): .

A nem frissíthető tulajdonságokat a rendszer írásvédettként jelöli meg a TopicProperties felületen.

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ő a témakör létrehozása után.

operationOptions

OperationOptions

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ó beállítások.

Az alábbiakban olyan hibákat talál, amelyek a művelettől várhatók

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 paranccsal 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 sablonos értékei ki lesznek töltve.

operationSpec

OperationSpec

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

Válaszok

Promise<T>

Örökölt forrás ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Küldje el a megadott httpRequest címet.

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

Paraméterek

request

PipelineRequest

Válaszok

Promise<PipelineResponse>

Örökölt forrás ServiceClient.sendRequest