ServiceBusAdministrationClient class

Riferimento

Pacchetto:: @azure/service-bus

Tutte le operazioni restituiscono promesse che vengono risolte in un oggetto con l'output pertinente. Questi oggetti hanno anche una proprietà denominata _response che è possibile usare se si desidera accedere alla risposta diretta dal servizio.

Extends: ServiceClient

Costruttori

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	Inizializza una nuova istanza della classe ServiceBusAdministrationClient.
ServiceBusAdministrationClient(string, TokenCredential \| NamedKeyCredential, ServiceBusAdministrationClientOptions)

Proprietà ereditate

pipeline

Pipeline usata da questo client per effettuare richieste

Metodi

createQueue(string, CreateQueueOptions)	Crea una coda con il nome specificato, configurata usando le opzioni specificate
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, OperationOptions)	Crea una regola con il nome specificato, configurata usando le opzioni specificate.
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, SqlRuleAction, OperationOptions)	Crea una regola con il nome specificato, configurata usando le opzioni specificate.
createSubscription(string, string, CreateSubscriptionOptions)	Crea una sottoscrizione con il nome specificato, configurata usando le opzioni specificate
createTopic(string, CreateTopicOptions)	Crea un argomento con il nome specificato, configurato usando le opzioni specificate
deleteQueue(string, OperationOptions)	Elimina una coda.
deleteRule(string, string, string, OperationOptions)	Elimina una regola.
deleteSubscription(string, string, OperationOptions)	Elimina una sottoscrizione.
deleteTopic(string, OperationOptions)	Elimina un argomento.
getNamespaceProperties(OperationOptions)	Restituisce un oggetto che rappresenta i metadati correlati a uno spazio dei nomi del bus di servizio.
getQueue(string, OperationOptions)	Restituisce un oggetto che rappresenta la coda e le relative proprietà. Per ottenere informazioni sul runtime della coda, ad esempio i dettagli del conteggio dei messaggi, usare `getQueueRuntimeProperties` API.
getQueueRuntimeProperties(string, OperationOptions)	Restituisce un oggetto che rappresenta le informazioni di runtime della coda, ad esempio i dettagli del conteggio dei messaggi.
getRule(string, string, string, OperationOptions)	Restituisce un oggetto che rappresenta la regola con il nome specificato insieme a tutte le relative proprietà.
getSubscription(string, string, OperationOptions)	Restituisce un oggetto che rappresenta la sottoscrizione e le relative proprietà. Per ottenere informazioni sul runtime della sottoscrizione, ad esempio i dettagli del conteggio dei messaggi, usare `getSubscriptionRuntimeProperties` API.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Restituisce un oggetto che rappresenta le informazioni di runtime della sottoscrizione, ad esempio i dettagli del conteggio dei messaggi.
getTopic(string, OperationOptions)	Restituisce un oggetto che rappresenta l'argomento e le relative proprietà. Per ottenere informazioni sul runtime dell'argomento, ad esempio i dettagli del conteggio delle sottoscrizioni, usare `getTopicRuntimeProperties` API.
getTopicRuntimeProperties(string, OperationOptions)	Restituisce un oggetto che rappresenta le informazioni di runtime dell'argomento, ad esempio il conteggio delle sottoscrizioni.
listQueues(OperationOptions)	Restituisce un iteratore iteratore asincrono per elencare tutte le code. .byPage() restituisce un iteratore iteratore asincrono per elencare le code nelle pagine.
listQueuesRuntimeProperties(OperationOptions)	Restituisce un iteratore iteratore asincrono per elencare le informazioni di runtime delle code. .byPage() restituisce un iteratore iteratore asincrono per elencare le informazioni di runtime delle code nelle pagine.
listRules(string, string, OperationOptions)	Restituisce un iteratore iteratore asincrono per elencare tutte le regole nella sottoscrizione specificata. .byPage() restituisce un iteratore iteratore iterabile asincrono per elencare le regole nelle pagine.
listSubscriptions(string, OperationOptions)	Restituisce un iteratore iteratore asincrono per elencare tutte le sottoscrizioni nell'argomento specificato. .byPage() restituisce un iteratore iteratore asincrono per elencare le sottoscrizioni nelle pagine.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Restituisce un iteratore iteratore asincrono per elencare le informazioni di runtime delle sottoscrizioni nell'argomento specificato. .byPage() restituisce un iteratore iteratore asincrono per elencare le informazioni di runtime delle sottoscrizioni nelle pagine.
listTopics(OperationOptions)	Restituisce un iteratore iteratore asincrono per elencare tutti gli argomenti. .byPage() restituisce un iteratore iteratore asincrono per elencare gli argomenti nelle pagine.
listTopicsRuntimeProperties(OperationOptions)	Restituisce un iteratore iteratore asincrono per elencare le informazioni di runtime degli argomenti. .byPage() restituisce un iteratore iteratore asincrono per elencare le informazioni di runtime degli argomenti nelle pagine.
queueExists(string, OperationOptions)	Controlla se una determinata coda esiste o meno.
ruleExists(string, string, string, OperationOptions)	Controlla se una determinata regola esiste o meno.
subscriptionExists(string, string, OperationOptions)	Verifica se una determinata sottoscrizione esiste o meno nell'argomento.
topicExists(string, OperationOptions)	Controlla se un determinato argomento esiste o meno.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Aggiorna la coda in base alle proprietà della coda fornite. Tutte le proprietà della coda devono essere impostate anche se solo un sottoinsieme è effettivamente aggiornabile. Di conseguenza, il flusso suggerito consiste nell'usare l'output di `getQueue()`, aggiornare le proprietà desiderate e quindi passare l'oggetto modificato a `updateQueue()`. Le proprietà che non possono essere aggiornate vengono contrassegnate come readonly nell'interfaccia `QueueProperties`.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Aggiorna le proprietà della regola in base al nome specificato in base alle opzioni specificate. Tutte le proprietà della regola devono essere impostate anche se ne viene aggiornata una. Di conseguenza, il flusso suggerito consiste nell'usare l'output di `getRule()`, aggiornare le proprietà desiderate e quindi passare l'oggetto modificato a `updateRule()`.
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Aggiorna la sottoscrizione in base alle proprietà della sottoscrizione fornite. Tutte le proprietà della sottoscrizione devono essere impostate anche se solo un sottoinsieme è effettivamente aggiornabile. Di conseguenza, il flusso suggerito consiste nell'usare l'output di `getSubscription()`, aggiornare le proprietà desiderate e quindi passare l'oggetto modificato a `updateSubscription()`. Le proprietà che non possono essere aggiornate vengono contrassegnate come readonly nell'interfaccia `SubscriptionProperties`.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Aggiorna l'argomento in base alle proprietà dell'argomento fornite. Tutte le proprietà dell'argomento devono essere impostate anche se solo un sottoinsieme è effettivamente aggiornabile. Di conseguenza, il flusso suggerito consiste nell'usare l'output di `getTopic()`, aggiornare le proprietà desiderate e quindi passare l'oggetto modificato a `updateTopic()`. Le proprietà che non possono essere aggiornate vengono contrassegnate come readonly nell'interfaccia `TopicProperties`.

Metodi ereditati

sendOperationRequest<T>(OperationArguments, OperationSpec)	Inviare una richiesta HTTP popolata usando operationSpec fornito.
sendRequest(PipelineRequest)	Inviare l'oggetto httpRequest fornito.

Dettagli costruttore

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Inizializza una nuova istanza della classe ServiceBusAdministrationClient.

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

Parametri

connectionString: string

Stringa di connessione necessaria per la connessione del client ad Azure.

options: ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

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

Parametri

fullyQualifiedNamespace: string

Spazio dei nomi completo dell'istanza del bus di servizio, probabilmente simile a .servicebus.windows.net.

credential: TokenCredential | NamedKeyCredential

Oggetto credenziale usato dal client per ottenere il token per autenticare la connessione con il bus di servizio di Azure. Vedere @azure/identità per la creazione delle credenziali. Se si usa la propria implementazione dell'interfaccia TokenCredential su AAD, impostare gli "ambiti" per il bus di servizio in modo che sia ["https://servicebus.azure.net//user_impersonation"] per ottenere il token appropriato. Usare il AzureNamedKeyCredential da @azure/core-auth se si vuole passare un SharedAccessKeyName e SharedAccessKey senza usare una stringa di connessione. Questi campi eseguono il mapping rispettivamente al campo name e key in AzureNamedKeyCredential.

options: ServiceBusAdministrationClientOptions

PipelineOptions

Dettagli proprietà ereditate

pipeline

Pipeline usata da questo client per effettuare richieste

pipeline: Pipeline

Valore della proprietà

Pipeline

Ereditato da ServiceClient.pipeline

Dettagli metodo

createQueue(string, CreateQueueOptions)

Crea una coda con il nome specificato, configurata usando le opzioni specificate

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

Parametri

queueName: string

options: CreateQueueOptions

Opzioni per configurare la coda in fase di creazione(ad esempio, è possibile configurare una coda per supportare partizioni o sessioni) e le opzioni di operazione che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<QueueProperties>>

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

Crea una regola con il nome specificato, configurata usando le opzioni specificate.

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

Parametri

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

Definisce l'espressione di filtro valutata dalla regola.

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<RuleProperties>>

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

Crea una regola con il nome specificato, configurata usando le opzioni specificate.

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

Parametri

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

Definisce l'espressione di filtro valutata dalla regola.

ruleAction: SqlRuleAction

L'espressione simile a SQL che può essere eseguita nel messaggio deve essere applicata al filtro associato.

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Crea una sottoscrizione con il nome specificato, configurata usando le opzioni specificate

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

Parametri

topicName: string

subscriptionName: string

options: CreateSubscriptionOptions

Opzioni per configurare la sottoscrizione in fase di creazione(ad esempio, è possibile configurare una sottoscrizione per supportare partizioni o sessioni) e le opzioni di operazione che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Crea un argomento con il nome specificato, configurato usando le opzioni specificate

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

Parametri

topicName: string

options: CreateTopicOptions

Opzioni per configurare l'argomento creato(ad esempio, è possibile configurare un argomento per supportare le partizioni) e le opzioni di operazione che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Elimina una coda.

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

Parametri

queueName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Elimina una regola.

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

Parametri

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Elimina una sottoscrizione.

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

Parametri

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Elimina un argomento.

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

Parametri

topicName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Restituisce un oggetto che rappresenta i metadati correlati a uno spazio dei nomi del bus di servizio.

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

Parametri

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Restituisce

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Restituisce un oggetto che rappresenta la coda e le relative proprietà. Per ottenere informazioni sul runtime della coda, ad esempio i dettagli del conteggio dei messaggi, usare getQueueRuntimeProperties API.

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

Parametri

queueName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Restituisce un oggetto che rappresenta le informazioni di runtime della coda, ad esempio i dettagli del conteggio dei messaggi.

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

Parametri

queueName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Restituisce un oggetto che rappresenta la regola con il nome specificato insieme a tutte le relative proprietà.

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

Parametri

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Restituisce un oggetto che rappresenta la sottoscrizione e le relative proprietà. Per ottenere informazioni sul runtime della sottoscrizione, ad esempio i dettagli del conteggio dei messaggi, usare getSubscriptionRuntimeProperties API.

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

Parametri

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Restituisce un oggetto che rappresenta le informazioni di runtime della sottoscrizione, ad esempio i dettagli del conteggio dei messaggi.

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

Parametri

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Restituisce un oggetto che rappresenta l'argomento e le relative proprietà. Per ottenere informazioni sul runtime dell'argomento, ad esempio i dettagli del conteggio delle sottoscrizioni, usare getTopicRuntimeProperties API.

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

Parametri

topicName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Restituisce un oggetto che rappresenta le informazioni di runtime dell'argomento, ad esempio il conteggio delle sottoscrizioni.

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

Parametri

topicName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

Restituisce un iteratore iteratore asincrono per elencare tutte le code.

.byPage() restituisce un iteratore iteratore asincrono per elencare le code nelle pagine.

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

Parametri

options: OperationOptions

Restituisce

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

AsyncIterableIterator che supporta il paging.

listQueuesRuntimeProperties(OperationOptions)

Restituisce un iteratore iteratore asincrono per elencare le informazioni di runtime delle code.

.byPage() restituisce un iteratore iteratore asincrono per elencare le informazioni di runtime delle code nelle pagine.

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

Parametri

options: OperationOptions

Restituisce

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

AsyncIterableIterator che supporta il paging.

listRules(string, string, OperationOptions)

Restituisce un iteratore iteratore asincrono per elencare tutte le regole nella sottoscrizione specificata.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare le regole nelle pagine.

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

Parametri

topicName: string

subscriptionName: string

options: OperationOptions

Restituisce

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

AsyncIterableIterator che supporta il paging.

listSubscriptions(string, OperationOptions)

Restituisce un iteratore iteratore asincrono per elencare tutte le sottoscrizioni nell'argomento specificato.

.byPage() restituisce un iteratore iteratore asincrono per elencare le sottoscrizioni nelle pagine.

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

Parametri

topicName: string

options: OperationOptions

Restituisce

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

AsyncIterableIterator che supporta il paging.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Restituisce un iteratore iteratore asincrono per elencare le informazioni di runtime delle sottoscrizioni nell'argomento specificato.

.byPage() restituisce un iteratore iteratore asincrono per elencare le informazioni di runtime delle sottoscrizioni nelle pagine.

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

Parametri

topicName: string

options: OperationOptions

Restituisce

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

AsyncIterableIterator che supporta il paging.

listTopics(OperationOptions)

Restituisce un iteratore iteratore asincrono per elencare tutti gli argomenti.

.byPage() restituisce un iteratore iteratore asincrono per elencare gli argomenti nelle pagine.

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

Parametri

options: OperationOptions

Restituisce

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

AsyncIterableIterator che supporta il paging.

listTopicsRuntimeProperties(OperationOptions)

Restituisce un iteratore iteratore asincrono per elencare le informazioni di runtime degli argomenti.

.byPage() restituisce un iteratore iteratore asincrono per elencare le informazioni di runtime degli argomenti nelle pagine.

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

Parametri

options: OperationOptions

Restituisce

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

AsyncIterableIterator che supporta il paging.

queueExists(string, OperationOptions)

Controlla se una determinata coda esiste o meno.

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

Parametri

queueName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Restituisce

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Controlla se una determinata regola esiste o meno.

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

Parametri

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Restituisce

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Verifica se una determinata sottoscrizione esiste o meno nell'argomento.

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

Parametri

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Restituisce

Promise<boolean>

topicExists(string, OperationOptions)

Controlla se un determinato argomento esiste o meno.

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

Parametri

topicName: string

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Restituisce

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Aggiorna la coda in base alle proprietà della coda fornite. Tutte le proprietà della coda devono essere impostate anche se solo un sottoinsieme è effettivamente aggiornabile. Di conseguenza, il flusso suggerito consiste nell'usare l'output di getQueue(), aggiornare le proprietà desiderate e quindi passare l'oggetto modificato a updateQueue().

Le proprietà che non possono essere aggiornate vengono contrassegnate come readonly nell'interfaccia QueueProperties.

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

Parametri

queue: WithResponse<QueueProperties>

Oggetto che rappresenta le proprietà della coda e la risposta non elaborata. requiresSession, requiresDuplicateDetection, enablePartitioninge non è possibile aggiornare name dopo la creazione della coda.

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<QueueProperties>>

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

Aggiorna le proprietà della regola in base al nome specificato in base alle opzioni specificate. Tutte le proprietà della regola devono essere impostate anche se ne viene aggiornata una. Di conseguenza, il flusso suggerito consiste nell'usare l'output di getRule(), aggiornare le proprietà desiderate e quindi passare l'oggetto modificato a updateRule().

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

Parametri

topicName: string

subscriptionName: string

rule: WithResponse<RuleProperties>

Opzioni per configurare la regola da aggiornare e la risposta non elaborata. Ad esempio, è possibile configurare il filtro da applicare per argomento/sottoscrizione associato.

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Aggiorna la sottoscrizione in base alle proprietà della sottoscrizione fornite. Tutte le proprietà della sottoscrizione devono essere impostate anche se solo un sottoinsieme è effettivamente aggiornabile. Di conseguenza, il flusso suggerito consiste nell'usare l'output di getSubscription(), aggiornare le proprietà desiderate e quindi passare l'oggetto modificato a updateSubscription().

Le proprietà che non possono essere aggiornate vengono contrassegnate come readonly nell'interfaccia SubscriptionProperties.

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

Parametri

subscription: WithResponse<SubscriptionProperties>

Oggetto che rappresenta le proprietà della sottoscrizione e la risposta non elaborata. subscriptionName, topicNamee non è possibile aggiornare requiresSession dopo la creazione della sottoscrizione.

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Aggiorna l'argomento in base alle proprietà dell'argomento fornite. Tutte le proprietà dell'argomento devono essere impostate anche se solo un sottoinsieme è effettivamente aggiornabile. Di conseguenza, il flusso suggerito consiste nell'usare l'output di getTopic(), aggiornare le proprietà desiderate e quindi passare l'oggetto modificato a updateTopic().

Le proprietà che non possono essere aggiornate vengono contrassegnate come readonly nell'interfaccia TopicProperties.

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

Parametri

topic: WithResponse<TopicProperties>

Oggetto che rappresenta le proprietà dell'argomento e la risposta non elaborata. non è possibile aggiornare requiresDuplicateDetection, enablePartitioninge name dopo la creazione dell'argomento.

operationOptions: OperationOptions

Opzioni che possono essere usate per interrompere, tracciare e controllare altre configurazioni nella richiesta HTTP.

Di seguito sono riportati gli errori che possono essere previsti da questa operazione

Restituisce

Promise<WithResponse<TopicProperties>>

Dettagli dei metodi ereditati

sendOperationRequest<T>(OperationArguments, OperationSpec)

Inviare una richiesta HTTP popolata usando operationSpec fornito.

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

Parametri

operationArguments: OperationArguments

Gli argomenti da cui verranno popolati i valori basato su modelli della richiesta HTTP.

operationSpec: OperationSpec

OperationSpec da usare per popolare httpRequest.

Restituisce

Promise<T>

Ereditato da ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Inviare l'oggetto httpRequest fornito.

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

Parametri

request: PipelineRequest

Restituisce

Promise<PipelineResponse>

Ereditato da ServiceClient.sendRequest

Condividi tramite

ServiceBusAdministrationClient class

Costruttori

Proprietà ereditate

Metodi

Metodi ereditati

Dettagli costruttore

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Parametri

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Parametri

Dettagli proprietà ereditate

pipeline

Valore della proprietà

Dettagli metodo

createQueue(string, CreateQueueOptions)

Parametri

Restituisce

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

Parametri

Restituisce

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

Parametri

Restituisce

createSubscription(string, string, CreateSubscriptionOptions)

Parametri

Restituisce

createTopic(string, CreateTopicOptions)

Parametri

Restituisce

deleteQueue(string, OperationOptions)

Parametri

Restituisce

deleteRule(string, string, string, OperationOptions)

Parametri

Restituisce

deleteSubscription(string, string, OperationOptions)

Parametri

Restituisce

deleteTopic(string, OperationOptions)

Parametri

Restituisce

getNamespaceProperties(OperationOptions)

Parametri

Restituisce

getQueue(string, OperationOptions)

Parametri

Restituisce

getQueueRuntimeProperties(string, OperationOptions)

Parametri

Restituisce

getRule(string, string, string, OperationOptions)

Parametri

Restituisce

getSubscription(string, string, OperationOptions)

Parametri

Restituisce

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Parametri

Restituisce

getTopic(string, OperationOptions)

Parametri

Restituisce

getTopicRuntimeProperties(string, OperationOptions)

Parametri

Restituisce

listQueues(OperationOptions)

Parametri

Restituisce

listQueuesRuntimeProperties(OperationOptions)

Parametri

Restituisce

listRules(string, string, OperationOptions)

Parametri

Restituisce

listSubscriptions(string, OperationOptions)

Parametri

Restituisce

listSubscriptionsRuntimeProperties(string, OperationOptions)

Parametri