ServiceBusAdministrationClient class

Reference

Balíček:: @azure/service-bus

Všechny operace vrací přísliby, které se přeloží na objekt, který má příslušný výstup. Tyto objekty mají také vlastnost s názvem _response , kterou můžete použít, pokud chcete získat přístup k přímé odpovědi ze služby.

Extends: ServiceClient

Konstruktory

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	Inicializuje novou instanci ServiceBusAdministrationClient třídy.
ServiceBusAdministrationClient(string, TokenCredential \| NamedKeyCredential, ServiceBusAdministrationClientOptions)

Zděděné vlastnosti

pipeline

Kanál, který tento klient používá k vytváření požadavků

Metody

createQueue(string, CreateQueueOptions)	Vytvoří frontu se zadaným názvem nakonfigurovaným pomocí daných možností.
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, OperationOptions)	Vytvoří pravidlo se zadaným názvem nakonfigurovaným pomocí daných možností.
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, SqlRuleAction, OperationOptions)	Vytvoří pravidlo se zadaným názvem nakonfigurovaným pomocí daných možností.
createSubscription(string, string, CreateSubscriptionOptions)	Vytvoří předplatné se zadaným názvem nakonfigurovaným pomocí daných možností.
createTopic(string, CreateTopicOptions)	Vytvoří téma se zadaným názvem nakonfigurovaným pomocí zadaných možností.
deleteQueue(string, OperationOptions)	Odstraní frontu.
deleteRule(string, string, string, OperationOptions)	Odstraní pravidlo.
deleteSubscription(string, string, OperationOptions)	Odstraní předplatné.
deleteTopic(string, OperationOptions)	Odstraní téma.
getNamespaceProperties(OperationOptions)	Vrátí objekt představující metadata související s oborem názvů služby Service Bus.
getQueue(string, OperationOptions)	Vrátí objekt představující frontu a její vlastnosti. Pokud chcete získat informace o modulu runtime fronty, jako jsou podrobnosti o počtu zpráv, použijte `getQueueRuntimeProperties` rozhraní API.
getQueueRuntimeProperties(string, OperationOptions)	Vrátí objekt představující informace o modulu runtime fronty, jako jsou podrobnosti o počtu zpráv.
getRule(string, string, string, OperationOptions)	Vrátí objekt představující pravidlo se zadaným názvem spolu se všemi jeho vlastnostmi.
getSubscription(string, string, OperationOptions)	Vrátí objekt představující předplatné a jeho vlastnosti. Pokud chcete získat informace o modulu runtime předplatného, jako jsou podrobnosti o počtu zpráv, použijte `getSubscriptionRuntimeProperties` rozhraní API.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Vrátí objekt představující informace o modulu runtime předplatného, jako jsou podrobnosti o počtu zpráv.
getTopic(string, OperationOptions)	Vrátí objekt představující téma a jeho vlastnosti. Pokud chcete získat informace o modulu runtime témat, jako jsou podrobnosti o počtu předplatného, použijte `getTopicRuntimeProperties` rozhraní API.
getTopicRuntimeProperties(string, OperationOptions)	Vrátí objekt představující informace modulu runtime tématu, jako je počet odběrů.
listQueues(OperationOptions)	Vrátí asynchronní iterátor pro výpis všech front. .byPage() vrátí asynchronní iterátor pro výpis front na stránkách.
listQueuesRuntimeProperties(OperationOptions)	Vrátí asynchronní iterátor pro výpis informací o modulu runtime front. .byPage() vrátí asynchronní iterátor pro výpis informací o modulu runtime front na stránkách.
listRules(string, string, OperationOptions)	Vrátí asynchronní iterátor pro výpis všech pravidel v zadaném předplatném. .byPage() vrátí asynchronní iterátor pro výpis pravidel na stránkách.
listSubscriptions(string, OperationOptions)	Vrátí asynchronní iterátor pro výpis všech předplatných v zadaném tématu. .byPage() vrátí asynchronní iterovatelný iterátor pro výpis odběrů na stránkách.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Vrátí asynchronní iterátor pro výpis informací o modulu runtime odběrů v zadaném tématu. .byPage() vrátí asynchronní iterovatelný iterátor pro výpis informací o modulu runtime odběrů na stránkách.
listTopics(OperationOptions)	Vrátí asynchronní iterátor pro výpis všech témat. .byPage() vrátí asynchronní iterátor pro výpis témat na stránkách.
listTopicsRuntimeProperties(OperationOptions)	Vrátí asynchronní iterátor pro výpis informací o modulu runtime témat. .byPage() vrátí asynchronní iterátor pro výpis informací o modulu runtime témat na stránkách.
queueExists(string, OperationOptions)	Zkontroluje, jestli daná fronta existuje nebo ne.
ruleExists(string, string, string, OperationOptions)	Zkontroluje, jestli dané pravidlo existuje nebo ne.
subscriptionExists(string, string, OperationOptions)	Zkontroluje, jestli dané předplatné v tématu existuje nebo ne.
topicExists(string, OperationOptions)	Zkontroluje, jestli dané téma existuje nebo ne.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Aktualizace frontu na základě zadaných vlastností fronty. Všechny vlastnosti fronty musí být nastaveny, i když je ve skutečnosti možné aktualizovat pouze jejich podmnožinu. Proto je navrhovaný tok použít výstup z `getQueue()`, aktualizovat požadované vlastnosti v něm a pak předat upravený objekt do `updateQueue()`. Vlastnosti, které nelze aktualizovat, jsou v rozhraní označeny jako jen pro `QueueProperties` čtení.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Aktualizace vlastnosti pravidla podle daného názvu na základě daných možností. Všechny vlastnosti pravidla musí být nastaveny i v případě, že se aktualizuje jedna z nich. Proto je navrhovaný tok použít výstup z `getRule()`, aktualizovat požadované vlastnosti v něm a pak předat upravený objekt do `updateRule()`.
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Aktualizace předplatné na základě zadaných vlastností předplatného. Všechny vlastnosti předplatného musí být nastaveny, i když je ve skutečnosti možné aktualizovat jenom jejich podmnožinu. Proto je navrhovaný tok použít výstup z `getSubscription()`, aktualizovat požadované vlastnosti v něm a pak předat upravený objekt do `updateSubscription()`. Vlastnosti, které nelze aktualizovat, jsou v rozhraní označeny jako jen pro `SubscriptionProperties` čtení.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Aktualizace téma na základě zadaných vlastností tématu. Všechny vlastnosti tématu musí být nastaveny, i když je ve skutečnosti možné aktualizovat jenom jejich podmnožinu. Proto je navrhovaný tok použít výstup z `getTopic()`, aktualizovat požadované vlastnosti v něm a pak předat upravený objekt do `updateTopic()`. Vlastnosti, které nelze aktualizovat, jsou v rozhraní označeny jako jen pro `TopicProperties` čtení.

Zděděné metody

sendOperationRequest<T>(OperationArguments, OperationSpec)	Odešlete požadavek HTTP, který se vyplní pomocí zadaného objektu OperationSpec.
sendRequest(PipelineRequest)	Odešlete zadaný požadavek httpRequest.

Podrobnosti konstruktoru

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Inicializuje novou instanci ServiceBusAdministrationClient třídy.

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

Parametry

connectionString: string

Připojovací řetězec potřebný pro připojení klienta k Azure.

options: ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

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

Parametry

fullyQualifiedNamespace: string

Plně kvalifikovaný obor názvů instance služby Service Bus, který se bude pravděpodobně podobat .servicebus.windows.net.

credential: TokenCredential | NamedKeyCredential

Objekt přihlašovacích údajů, který klient používá k získání tokenu pro ověření připojení k Azure Service Bus. Informace o vytvoření přihlašovacích údajů najdete v tématu @azure/identity. Pokud používáte vlastní implementaci TokenCredential rozhraní pro AAD, nastavte obory pro service-bus tak, aby ["https://servicebus.azure.net//user_impersonation"] získaly příslušný token. AzureNamedKeyCredential Pokud chcete předat SharedAccessKeyNameSharedAccessKey a bez použití připojovacího řetězce, použijte příkaz from @azure/core-auth. Tato pole se mapují na name pole a key v AzureNamedKeyCredentialuvedeném pořadí .

options: ServiceBusAdministrationClientOptions

PipelineOptions

Podrobnosti zděděných vlastností

pipeline

Kanál, který tento klient používá k vytváření požadavků

pipeline: Pipeline

Hodnota vlastnosti

Pipeline

Zděděno z ServiceClient.pipeline

Podrobnosti metody

createQueue(string, CreateQueueOptions)

Vytvoří frontu se zadaným názvem nakonfigurovaným pomocí daných možností.

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

Parametry

queueName: string

options: CreateQueueOptions

Možnosti konfigurace vytvářené fronty (můžete například nakonfigurovat frontu tak, aby podporovala oddíly nebo relace) a možnosti operace, které se dají použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<QueueProperties>>

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

Vytvoří pravidlo se zadaným názvem nakonfigurovaným pomocí daných možností.

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

Parametry

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

Definuje výraz filtru, který pravidlo vyhodnocuje.

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<RuleProperties>>

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

Vytvoří pravidlo se zadaným názvem nakonfigurovaným pomocí daných možností.

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

Parametry

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

Definuje výraz filtru, který pravidlo vyhodnocuje.

ruleAction: SqlRuleAction

Výraz typu SQL, který se dá spustit ve zprávě, pokud se použije přidružený filtr.

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Vytvoří předplatné se zadaným názvem nakonfigurovaným pomocí daných možností.

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

Parametry

topicName: string

subscriptionName: string

options: CreateSubscriptionOptions

Možnosti konfigurace vytvářeného předplatného (můžete například nakonfigurovat předplatné tak, aby podporovalo oddíly nebo relace) a možnosti operace, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Vytvoří téma se zadaným názvem nakonfigurovaným pomocí zadaných možností.

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

Parametry

topicName: string

options: CreateTopicOptions

Možnosti konfigurace vytvářeného tématu (můžete například nakonfigurovat téma pro podporu oddílů) a možnosti operace, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Odstraní frontu.

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

Parametry

queueName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Odstraní pravidlo.

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

Parametry

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Odstraní předplatné.

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

Parametry

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Odstraní téma.

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

Parametry

topicName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Vrátí objekt představující metadata související s oborem názvů služby Service Bus.

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

Parametry

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Návraty

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Vrátí objekt představující frontu a její vlastnosti. Pokud chcete získat informace o modulu runtime fronty, jako jsou podrobnosti o počtu zpráv, použijte getQueueRuntimeProperties rozhraní API.

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

Parametry

queueName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Vrátí objekt představující informace o modulu runtime fronty, jako jsou podrobnosti o počtu zpráv.

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

Parametry

queueName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Vrátí objekt představující pravidlo se zadaným názvem spolu se všemi jeho vlastnostmi.

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

Parametry

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Vrátí objekt představující předplatné a jeho vlastnosti. Pokud chcete získat informace o modulu runtime předplatného, jako jsou podrobnosti o počtu zpráv, použijte getSubscriptionRuntimeProperties rozhraní API.

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

Parametry

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Vrátí objekt představující informace o modulu runtime předplatného, jako jsou podrobnosti o počtu zpráv.

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

Parametry

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Vrátí objekt představující téma a jeho vlastnosti. Pokud chcete získat informace o modulu runtime témat, jako jsou podrobnosti o počtu předplatného, použijte getTopicRuntimeProperties rozhraní API.

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

Parametry

topicName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Vrátí objekt představující informace modulu runtime tématu, jako je počet odběrů.

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

Parametry

topicName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

Vrátí asynchronní iterátor pro výpis všech front.

.byPage() vrátí asynchronní iterátor pro výpis front na stránkách.

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

Parametry

options: OperationOptions

Návraty

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

AsyncIterableIterator, který podporuje stránkování.

listQueuesRuntimeProperties(OperationOptions)

Vrátí asynchronní iterátor pro výpis informací o modulu runtime front.

.byPage() vrátí asynchronní iterátor pro výpis informací o modulu runtime front na stránkách.

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

Parametry

options: OperationOptions

Návraty

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

AsyncIterableIterator, který podporuje stránkování.

listRules(string, string, OperationOptions)

Vrátí asynchronní iterátor pro výpis všech pravidel v zadaném předplatném.

.byPage() vrátí asynchronní iterátor pro výpis pravidel na stránkách.

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

Parametry

topicName: string

subscriptionName: string

options: OperationOptions

Návraty

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

AsyncIterableIterator, který podporuje stránkování.

listSubscriptions(string, OperationOptions)

Vrátí asynchronní iterátor pro výpis všech předplatných v zadaném tématu.

.byPage() vrátí asynchronní iterovatelný iterátor pro výpis odběrů na stránkách.

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

Parametry

topicName: string

options: OperationOptions

Návraty

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

AsyncIterableIterator, který podporuje stránkování.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Vrátí asynchronní iterátor pro výpis informací o modulu runtime odběrů v zadaném tématu.

.byPage() vrátí asynchronní iterovatelný iterátor pro výpis informací o modulu runtime odběrů na stránkách.

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

Parametry

topicName: string

options: OperationOptions

Návraty

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

AsyncIterableIterator, který podporuje stránkování.

listTopics(OperationOptions)

Vrátí asynchronní iterátor pro výpis všech témat.

.byPage() vrátí asynchronní iterátor pro výpis témat na stránkách.

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

Parametry

options: OperationOptions

Návraty

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

AsyncIterableIterator, který podporuje stránkování.

listTopicsRuntimeProperties(OperationOptions)

Vrátí asynchronní iterátor pro výpis informací o modulu runtime témat.

.byPage() vrátí asynchronní iterátor pro výpis informací o modulu runtime témat na stránkách.

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

Parametry

options: OperationOptions

Návraty

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

AsyncIterableIterator, který podporuje stránkování.

queueExists(string, OperationOptions)

Zkontroluje, jestli daná fronta existuje nebo ne.

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

Parametry

queueName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Návraty

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Zkontroluje, jestli dané pravidlo existuje nebo ne.

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

Parametry

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Návraty

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Zkontroluje, jestli dané předplatné v tématu existuje nebo ne.

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

Parametry

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Návraty

Promise<boolean>

topicExists(string, OperationOptions)

Zkontroluje, jestli dané téma existuje nebo ne.

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

Parametry

topicName: string

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Návraty

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Aktualizace frontu na základě zadaných vlastností fronty. Všechny vlastnosti fronty musí být nastaveny, i když je ve skutečnosti možné aktualizovat pouze jejich podmnožinu. Proto je navrhovaný tok použít výstup z getQueue(), aktualizovat požadované vlastnosti v něm a pak předat upravený objekt do updateQueue().

Vlastnosti, které nelze aktualizovat, jsou v rozhraní označeny jako jen pro QueueProperties čtení.

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

Parametry

queue: WithResponse<QueueProperties>

Objekt představující vlastnosti fronty a nezpracovanou odpověď. requiresSessionenablePartitioning, requiresDuplicateDetection, a name se po vytvoření fronty nedají aktualizovat.

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<QueueProperties>>

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

Aktualizace vlastnosti pravidla podle daného názvu na základě daných možností. Všechny vlastnosti pravidla musí být nastaveny i v případě, že se aktualizuje jedna z nich. Proto je navrhovaný tok použít výstup z getRule(), aktualizovat požadované vlastnosti v něm a pak předat upravený objekt do updateRule().

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

Parametry

topicName: string

subscriptionName: string

rule: WithResponse<RuleProperties>

Možnosti konfigurace aktualizovaného pravidla a nezpracované odpovědi Můžete například nakonfigurovat filtr tak, aby se použil na přidružené téma nebo předplatné.

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Aktualizace předplatné na základě zadaných vlastností předplatného. Všechny vlastnosti předplatného musí být nastaveny, i když je ve skutečnosti možné aktualizovat jenom jejich podmnožinu. Proto je navrhovaný tok použít výstup z getSubscription(), aktualizovat požadované vlastnosti v něm a pak předat upravený objekt do updateSubscription().

Vlastnosti, které nelze aktualizovat, jsou v rozhraní označeny jako jen pro SubscriptionProperties čtení.

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

Parametry

subscription: WithResponse<SubscriptionProperties>

Objekt představující vlastnosti předplatného a nezpracovanou odpověď. subscriptionName, topicNamea requiresSession se po vytvoření předplatného nedají aktualizovat.

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Aktualizace téma na základě zadaných vlastností tématu. Všechny vlastnosti tématu musí být nastaveny, i když je ve skutečnosti možné aktualizovat jenom jejich podmnožinu. Proto je navrhovaný tok použít výstup z getTopic(), aktualizovat požadované vlastnosti v něm a pak předat upravený objekt do updateTopic().

Vlastnosti, které nelze aktualizovat, jsou v rozhraní označeny jako jen pro TopicProperties čtení.

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

Parametry

topic: WithResponse<TopicProperties>

Objekt představující vlastnosti tématu a nezpracovanou odpověď. requiresDuplicateDetection, enablePartitioninga name se po vytvoření tématu nedají aktualizovat.

operationOptions: OperationOptions

Možnosti, které lze použít k přerušení, trasování a řízení dalších konfigurací v požadavku HTTP.

Níže jsou uvedené chyby, které lze očekávat od této operace.

Návraty

Promise<WithResponse<TopicProperties>>

Podrobnosti zděděných metod

sendOperationRequest<T>(OperationArguments, OperationSpec)

Odešlete požadavek HTTP, který se vyplní pomocí zadaného objektu OperationSpec.

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

Parametry

operationArguments: OperationArguments

Argumenty, ze které budou vyplněny hodnoty šablony požadavku HTTP.

operationSpec: OperationSpec

OperationSpec, který se má použít k naplnění httpRequest.

Návraty

Promise<T>

Zděděno z ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Odešlete zadaný požadavek httpRequest.

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

Parametry

request: PipelineRequest

Návraty

Promise<PipelineResponse>

Zděděno z ServiceClient.sendRequest

Share via

ServiceBusAdministrationClient class

Konstruktory

Zděděné vlastnosti

Metody

Zděděné metody

Podrobnosti konstruktoru

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Parametry

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Parametry

Podrobnosti zděděných vlastností

pipeline

Hodnota vlastnosti

Podrobnosti metody

createQueue(string, CreateQueueOptions)

Parametry

Návraty

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

Parametry

Návraty

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

Parametry

Návraty

createSubscription(string, string, CreateSubscriptionOptions)

Parametry

Návraty

createTopic(string, CreateTopicOptions)

Parametry

Návraty

deleteQueue(string, OperationOptions)

Parametry

Návraty

deleteRule(string, string, string, OperationOptions)

Parametry

Návraty

deleteSubscription(string, string, OperationOptions)

Parametry

Návraty

deleteTopic(string, OperationOptions)

Parametry

Návraty

getNamespaceProperties(OperationOptions)

Parametry

Návraty

getQueue(string, OperationOptions)

Parametry

Návraty

getQueueRuntimeProperties(string, OperationOptions)

Parametry

Návraty

getRule(string, string, string, OperationOptions)

Parametry

Návraty

getSubscription(string, string, OperationOptions)

Parametry

Návraty

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Parametry

Návraty

getTopic(string, OperationOptions)

Parametry

Návraty

getTopicRuntimeProperties(string, OperationOptions)

Parametry

Návraty

listQueues(OperationOptions)

Parametry

Návraty

listQueuesRuntimeProperties(OperationOptions)

Parametry

Návraty

listRules(string, string, OperationOptions)

Parametry

Návraty

listSubscriptions(string, OperationOptions)

Parametry

Návraty

listSubscriptionsRuntimeProperties(string, OperationOptions)

Parametry