ServiceBusAdministrationClient class

Paket:

@azure/service-bus

Alla åtgärder returnerar löften som matchar ett objekt som har relevanta utdata. Dessa objekt har också en egenskap som heter _response som du kan använda om du vill komma åt direktsvaret från tjänsten.

Extends

ServiceClient

Konstruktorer

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	Initierar en ny instans av klassen ServiceBusAdministrationClient.
ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Ärvda egenskaper

pipeline

Pipelinen som används av den här klienten för att göra begäranden

Metoder

createQueue(string, CreateQueueOptions)	Skapar en kö med förnamn, konfigurerad med hjälp av de angivna alternativen
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)	Skapar en regel med förnamn, konfigurerad med hjälp av de angivna alternativen.
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)	Skapar en regel med förnamn, konfigurerad med hjälp av de angivna alternativen.
createSubscription(string, string, CreateSubscriptionOptions)	Skapar en prenumeration med förnamn, konfigurerad med hjälp av de angivna alternativen
createTopic(string, CreateTopicOptions)	Skapar ett ämne med förnamn, konfigurerat med hjälp av de angivna alternativen
deleteQueue(string, OperationOptions)	Tar bort en kö.
deleteRule(string, string, string, OperationOptions)	Tar bort en regel.
deleteSubscription(string, string, OperationOptions)	Tar bort en prenumeration.
deleteTopic(string, OperationOptions)	Tar bort ett ämne.
getNamespaceProperties(OperationOptions)	Returnerar ett objekt som representerar metadata som är relaterade till ett Service Bus-namnområde.
getQueue(string, OperationOptions)	Returnerar ett objekt som representerar kön och dess egenskaper. Om du vill hämta information om kökörning som information om antal meddelanden använder du getQueueRuntimeProperties API.
getQueueRuntimeProperties(string, OperationOptions)	Returnerar ett objekt som representerar information om kökörning som information om antal meddelanden.
getRule(string, string, string, OperationOptions)	Returnerar ett objekt som representerar regeln med det angivna namnet tillsammans med alla dess egenskaper.
getSubscription(string, string, OperationOptions)	Returnerar ett objekt som representerar prenumerationen och dess egenskaper. Om du vill hämta information om prenumerationskörning som information om antal meddelanden använder du getSubscriptionRuntimeProperties API.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Returnerar ett objekt som representerar information om prenumerationskörning som information om antal meddelanden.
getTopic(string, OperationOptions)	Returnerar ett objekt som representerar ämnet och dess egenskaper. Om du vill hämta information om ämneskörning som information om antal prenumerationer använder du getTopicRuntimeProperties API.
getTopicRuntimeProperties(string, OperationOptions)	Returnerar ett objekt som representerar ämneskörningsinformation som antal prenumerationer.
listQueues(OperationOptions)	Returnerar en iterbar iterator som kan asynkronas för att visa en lista över alla köer. .byPage() returnerar en iterator som kan itereras asynkront för att visa en lista över köerna på sidor.
listQueuesRuntimeProperties(OperationOptions)	Returnerar en itererbar iterator som kan asynkroniseras för att visa runtime-information om köerna. .byPage() returnerar en iterator som kan itereras asynkron för att visa runtime-information om köerna på sidor.
listRules(string, string, OperationOptions)	Returnerar en iterbar iterator för asynkronisering för att visa alla regler under den angivna prenumerationen. .byPage() returnerar en iterator som kan itereras asynkront för att visa reglerna på sidor.
listSubscriptions(string, OperationOptions)	Returnerar en itererbar iterator för asynkronisering för att visa en lista över alla prenumerationer under det angivna ämnet. .byPage() returnerar en iterator som kan itereras asynkront för att visa prenumerationerna på sidor.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Returnerar en itererbar iterator som kan asynkroniseras för att visa runtime-information om prenumerationerna under det angivna ämnet. .byPage() returnerar en iterator som kan itereras asynkron för att visa runtime-information om prenumerationer på sidor.
listTopics(OperationOptions)	Returnerar en itererbar iterator som kan asynkroniseras för att visa en lista över alla ämnen. .byPage() returnerar en iterator som kan itereras asynkron för att visa en lista över ämnena på sidor.
listTopicsRuntimeProperties(OperationOptions)	Returnerar en itererbar iterator som kan asynkroniseras för att visa körningsinformation om ämnena. .byPage() returnerar en iterator som kan itereras asynkron för att visa runtime-information om ämnena på sidor.
queueExists(string, OperationOptions)	Kontrollerar om en viss kö finns eller inte.
ruleExists(string, string, string, OperationOptions)	Kontrollerar om en viss regel finns eller inte.
subscriptionExists(string, string, OperationOptions)	Kontrollerar om en viss prenumeration finns i ämnet eller inte.
topicExists(string, OperationOptions)	Kontrollerar om ett visst ämne finns eller inte.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Uppdaterar kön baserat på de köegenskaper som angetts. Alla köegenskaper måste anges även om endast en delmängd av dem faktiskt är uppdaterbara. Därför är det föreslagna flödet att använda utdata från getQueue(), uppdatera önskade egenskaper i det och sedan skicka det ändrade objektet till updateQueue(). Egenskaperna som inte kan uppdateras markeras som skrivskyddade i QueueProperties-gränssnittet.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Uppdaterar egenskaperna för regeln med det angivna namnet baserat på de angivna alternativen. Alla regelegenskaper måste anges även om en av dem uppdateras. Därför är det föreslagna flödet att använda utdata från getRule(), uppdatera önskade egenskaper i det och sedan skicka det ändrade objektet till updateRule().
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Uppdaterar prenumerationen baserat på de prenumerationsegenskaper som tillhandahålls. Alla prenumerationsegenskaper måste anges även om endast en delmängd av dem faktiskt är uppdaterbara. Därför är det föreslagna flödet att använda utdata från getSubscription(), uppdatera önskade egenskaper i det och sedan skicka det ändrade objektet till updateSubscription(). Egenskaperna som inte kan uppdateras markeras som skrivskyddade i SubscriptionProperties-gränssnittet.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Uppdaterar ämnet baserat på de ämnesegenskaper som tillhandahålls. Alla ämnesegenskaper måste anges även om endast en delmängd av dem faktiskt är uppdaterbara. Därför är det föreslagna flödet att använda utdata från getTopic(), uppdatera önskade egenskaper i det och sedan skicka det ändrade objektet till updateTopic(). Egenskaperna som inte kan uppdateras markeras som skrivskyddade i TopicProperties-gränssnittet.

Ärvda metoder

sendOperationRequest<T>(OperationArguments, OperationSpec)	Skicka en HTTP-begäran som fylls i med den angivna OperationSpec.
sendRequest(PipelineRequest)	Skicka angivet httpRequest.

Konstruktorinformation

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Initierar en ny instans av klassen ServiceBusAdministrationClient.

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

Parametrar

connectionString

string

Anslutningssträngen som krävs för att klienten ska kunna ansluta till Azure.

options

ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

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

Parametrar

fullyQualifiedNamespace

string

Det fullständigt kvalificerade namnområdet för din Service Bus-instans som sannolikt liknar .servicebus.windows.net.

credential

TokenCredential | NamedKeyCredential

Ett autentiseringsobjekt som används av klienten för att hämta token för att autentisera anslutningen till Azure Service Bus. Se @azure/identitet för att skapa autentiseringsuppgifterna. Om du använder din egen implementering av TokenCredential-gränssnittet mot AAD anger du "omfången" för service-bus som ["https://servicebus.azure.net//user_impersonation"] för att hämta rätt token. Använd AzureNamedKeyCredential från @azure/core-auth om du vill skicka in en SharedAccessKeyName och SharedAccessKey utan att använda en anslutningssträng. Fälten mappas till fältet name respektive key i AzureNamedKeyCredential.

options

ServiceBusAdministrationClientOptions

PipelineOptions

Information om ärvda egenskaper

pipeline

Pipelinen som används av den här klienten för att göra begäranden

pipeline: Pipeline

Egenskapsvärde

Pipeline

ärvd från ServiceClient.pipeline

Metodinformation

createQueue(string, CreateQueueOptions)

Skapar en kö med förnamn, konfigurerad med hjälp av de angivna alternativen

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

Parametrar

queueName

string

options

CreateQueueOptions

Alternativ för att konfigurera kön som skapas(Du kan till exempel konfigurera en kö för att stödja partitioner eller sessioner) och de åtgärdsalternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<QueueProperties>>

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

Skapar en regel med förnamn, konfigurerad med hjälp av de angivna alternativen.

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

Parametrar

topicName

string

subscriptionName

string

ruleName

string

ruleFilter

CorrelationRuleFilter | SqlRuleFilter

Definierar filteruttrycket som regeln utvärderar.

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<RuleProperties>>

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

Skapar en regel med förnamn, konfigurerad med hjälp av de angivna alternativen.

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

Parametrar

topicName

string

subscriptionName

string

ruleName

string

ruleFilter

CorrelationRuleFilter | SqlRuleFilter

Definierar filteruttrycket som regeln utvärderar.

ruleAction

SqlRuleAction

Det SQL-liknande uttryck som kan köras i meddelandet om det associerade filtret ska tillämpas.

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Skapar en prenumeration med förnamn, konfigurerad med hjälp av de angivna alternativen

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

Parametrar

topicName

string

subscriptionName

string

options

CreateSubscriptionOptions

Alternativ för att konfigurera prenumerationen som skapas(Du kan till exempel konfigurera en prenumeration för att stödja partitioner eller sessioner) och de åtgärdsalternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Skapar ett ämne med förnamn, konfigurerat med hjälp av de angivna alternativen

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

Parametrar

topicName

string

options

CreateTopicOptions

Alternativ för att konfigurera ämnet som skapas(Du kan till exempel konfigurera ett ämne för att stödja partitioner) och de åtgärdsalternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Tar bort en kö.

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

Parametrar

queueName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Tar bort en regel.

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

Parametrar

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Tar bort en prenumeration.

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

Parametrar

topicName

string

subscriptionName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Tar bort ett ämne.

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

Parametrar

topicName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Returnerar ett objekt som representerar metadata som är relaterade till ett Service Bus-namnområde.

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

Parametrar

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Returer

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Returnerar ett objekt som representerar kön och dess egenskaper. Om du vill hämta information om kökörning som information om antal meddelanden använder du getQueueRuntimeProperties API.

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

Parametrar

queueName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Returnerar ett objekt som representerar information om kökörning som information om antal meddelanden.

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

Parametrar

queueName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Returnerar ett objekt som representerar regeln med det angivna namnet tillsammans med alla dess egenskaper.

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

Parametrar

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Returnerar ett objekt som representerar prenumerationen och dess egenskaper. Om du vill hämta information om prenumerationskörning som information om antal meddelanden använder du getSubscriptionRuntimeProperties API.

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

Parametrar

topicName

string

subscriptionName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Returnerar ett objekt som representerar information om prenumerationskörning som information om antal meddelanden.

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

Parametrar

topicName

string

subscriptionName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Returnerar ett objekt som representerar ämnet och dess egenskaper. Om du vill hämta information om ämneskörning som information om antal prenumerationer använder du getTopicRuntimeProperties API.

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

Parametrar

topicName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Returnerar ett objekt som representerar ämneskörningsinformation som antal prenumerationer.

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

Parametrar

topicName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

Returnerar en iterbar iterator som kan asynkronas för att visa en lista över alla köer.

.byPage() returnerar en iterator som kan itereras asynkront för att visa en lista över köerna på sidor.

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

Parametrar

options

OperationOptions

Returer

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

En asyncIterableIterator som stöder växling.

listQueuesRuntimeProperties(OperationOptions)

Returnerar en itererbar iterator som kan asynkroniseras för att visa runtime-information om köerna.

.byPage() returnerar en iterator som kan itereras asynkron för att visa runtime-information om köerna på sidor.

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

Parametrar

options

OperationOptions

Returer

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

En asyncIterableIterator som stöder växling.

listRules(string, string, OperationOptions)

Returnerar en iterbar iterator för asynkronisering för att visa alla regler under den angivna prenumerationen.

.byPage() returnerar en iterator som kan itereras asynkront för att visa reglerna på sidor.

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

Parametrar

topicName

string

subscriptionName

string

options

OperationOptions

Returer

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

En asyncIterableIterator som stöder växling.

listSubscriptions(string, OperationOptions)

Returnerar en itererbar iterator för asynkronisering för att visa en lista över alla prenumerationer under det angivna ämnet.

.byPage() returnerar en iterator som kan itereras asynkront för att visa prenumerationerna på sidor.

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

Parametrar

topicName

string

options

OperationOptions

Returer

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

En asyncIterableIterator som stöder växling.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Returnerar en itererbar iterator som kan asynkroniseras för att visa runtime-information om prenumerationerna under det angivna ämnet.

.byPage() returnerar en iterator som kan itereras asynkron för att visa runtime-information om prenumerationer på sidor.

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

Parametrar

topicName

string

options

OperationOptions

Returer

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

En asyncIterableIterator som stöder växling.

listTopics(OperationOptions)

Returnerar en itererbar iterator som kan asynkroniseras för att visa en lista över alla ämnen.

.byPage() returnerar en iterator som kan itereras asynkron för att visa en lista över ämnena på sidor.

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

Parametrar

options

OperationOptions

Returer

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

En asyncIterableIterator som stöder växling.

listTopicsRuntimeProperties(OperationOptions)

Returnerar en itererbar iterator som kan asynkroniseras för att visa körningsinformation om ämnena.

.byPage() returnerar en iterator som kan itereras asynkron för att visa runtime-information om ämnena på sidor.

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

Parametrar

options

OperationOptions

Returer

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

En asyncIterableIterator som stöder växling.

queueExists(string, OperationOptions)

Kontrollerar om en viss kö finns eller inte.

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

Parametrar

queueName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Returer

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Kontrollerar om en viss regel finns eller inte.

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

Parametrar

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

Returer

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Kontrollerar om en viss prenumeration finns i ämnet eller inte.

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

Parametrar

topicName

string

subscriptionName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Returer

Promise<boolean>

topicExists(string, OperationOptions)

Kontrollerar om ett visst ämne finns eller inte.

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

Parametrar

topicName

string

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Returer

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Uppdaterar kön baserat på de köegenskaper som angetts. Alla köegenskaper måste anges även om endast en delmängd av dem faktiskt är uppdaterbara. Därför är det föreslagna flödet att använda utdata från getQueue(), uppdatera önskade egenskaper i det och sedan skicka det ändrade objektet till updateQueue().

Egenskaperna som inte kan uppdateras markeras som skrivskyddade i QueueProperties-gränssnittet.

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

Parametrar

queue

WithResponse<QueueProperties>

Objekt som representerar egenskaperna för kön och råsvaret. requiresSession, requiresDuplicateDetection, enablePartitioningoch name kan inte uppdateras när du har skapat kön.

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<QueueProperties>>

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

Uppdaterar egenskaperna för regeln med det angivna namnet baserat på de angivna alternativen. Alla regelegenskaper måste anges även om en av dem uppdateras. Därför är det föreslagna flödet att använda utdata från getRule(), uppdatera önskade egenskaper i det och sedan skicka det ändrade objektet till updateRule().

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

Parametrar

topicName

string

subscriptionName

string

rule

WithResponse<RuleProperties>

Alternativ för att konfigurera regeln som uppdateras och råsvaret. Du kan till exempel konfigurera filtret så att det tillämpas på tillhörande ämne/prenumeration.

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Uppdaterar prenumerationen baserat på de prenumerationsegenskaper som tillhandahålls. Alla prenumerationsegenskaper måste anges även om endast en delmängd av dem faktiskt är uppdaterbara. Därför är det föreslagna flödet att använda utdata från getSubscription(), uppdatera önskade egenskaper i det och sedan skicka det ändrade objektet till updateSubscription().

Egenskaperna som inte kan uppdateras markeras som skrivskyddade i SubscriptionProperties-gränssnittet.

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

Parametrar

subscription

WithResponse<SubscriptionProperties>

Objekt som representerar egenskaperna för prenumerationen och råsvaret. subscriptionName, topicNameoch requiresSession kan inte uppdateras när du har skapat prenumerationen.

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Uppdaterar ämnet baserat på de ämnesegenskaper som tillhandahålls. Alla ämnesegenskaper måste anges även om endast en delmängd av dem faktiskt är uppdaterbara. Därför är det föreslagna flödet att använda utdata från getTopic(), uppdatera önskade egenskaper i det och sedan skicka det ändrade objektet till updateTopic().

Egenskaperna som inte kan uppdateras markeras som skrivskyddade i TopicProperties-gränssnittet.

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

Parametrar

topic

WithResponse<TopicProperties>

Objekt som representerar egenskaperna för ämnet och råsvaret. requiresDuplicateDetection, enablePartitioningoch name kan inte uppdateras när du har skapat ämnet.

operationOptions

OperationOptions

De alternativ som kan användas för att avbryta, spåra och kontrollera andra konfigurationer på HTTP-begäran.

Följande är fel som kan förväntas av den här åtgärden

Returer

Promise<WithResponse<TopicProperties>>

Ärvd metodinformation

sendOperationRequest<T>(OperationArguments, OperationSpec)

Skicka en HTTP-begäran som fylls i med den angivna OperationSpec.

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

Parametrar

operationArguments

OperationArguments

Argumenten som HTTP-begärans mallade värden fylls i från.

operationSpec

OperationSpec

Den OperationSpec som ska användas för att fylla i httpRequest.

Returer

Promise<T>

ärvd från ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Skicka angivet httpRequest.

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

Parametrar

request

PipelineRequest

Returer

Promise<PipelineResponse>

ärvd från ServiceClient.sendRequest