ServiceBusAdministrationClient class

Referentie

Pakket:: @azure/service-bus

Alle bewerkingen retourneren beloften die worden omgezet in een object met de relevante uitvoer. Deze objecten hebben ook een eigenschap met de naam _response die u kunt gebruiken als u toegang wilt krijgen tot het directe antwoord van de service.

Extends: ServiceClient

Constructors

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	Initialiseert een nieuw exemplaar van de klasse ServiceBusAdministrationClient.
ServiceBusAdministrationClient(string, TokenCredential \| NamedKeyCredential, ServiceBusAdministrationClientOptions)	Initialiseert een nieuw exemplaar van de klasse ServiceBusAdministrationClient.

Overgenomen eigenschappen

pipeline

De pijplijn die door deze client wordt gebruikt om aanvragen te doen

Methoden

createQueue(string, CreateQueueOptions)	Hiermee maakt u een wachtrij met een bepaalde naam, geconfigureerd met behulp van de opgegeven opties
createRule(string, string, string, SqlRuleFilter \| CorrelationRuleFilter, OperationOptions)	Hiermee maakt u een regel met een bepaalde naam, geconfigureerd met behulp van de opgegeven opties.
createRule(string, string, string, SqlRuleFilter \| CorrelationRuleFilter, SqlRuleAction, OperationOptions)	Hiermee maakt u een regel met een bepaalde naam, geconfigureerd met behulp van de opgegeven opties.
createSubscription(string, string, CreateSubscriptionOptions)	Hiermee maakt u een abonnement met een bepaalde naam, geconfigureerd met behulp van de opgegeven opties
createTopic(string, CreateTopicOptions)	Hiermee maakt u een onderwerp met een bepaalde naam, geconfigureerd met behulp van de opgegeven opties
deleteQueue(string, OperationOptions)	Hiermee verwijdert u een wachtrij.
deleteRule(string, string, string, OperationOptions)	Hiermee verwijdert u een regel.
deleteSubscription(string, string, OperationOptions)	Hiermee verwijdert u een abonnement.
deleteTopic(string, OperationOptions)	Hiermee verwijdert u een onderwerp.
getNamespaceProperties(OperationOptions)	Retourneert een object dat de metagegevens vertegenwoordigt die betrekking hebben op een Service Bus-naamruimte.
getQueue(string, OperationOptions)	Retourneert een object dat de wachtrij en de bijbehorende eigenschappen vertegenwoordigt. Als u de informatie over de wachtrijruntime wilt ophalen, zoals details van het aantal berichten, gebruikt u `getQueueRuntimeProperties` API.
getQueueRuntimeProperties(string, OperationOptions)	Retourneert een object dat de runtimegegevens van de wachtrij vertegenwoordigt, zoals details van het aantal berichten.
getRule(string, string, string, OperationOptions)	Retourneert een object dat de regel vertegenwoordigt met de opgegeven naam, samen met alle bijbehorende eigenschappen.
getSubscription(string, string, OperationOptions)	Retourneert een object dat het abonnement en de bijbehorende eigenschappen vertegenwoordigt. Als u de runtimegegevens van het abonnement wilt ophalen, zoals details van het aantal berichten, gebruikt `getSubscriptionRuntimeProperties` u DE API.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Retourneert een object dat de runtimegegevens van het abonnement vertegenwoordigt, zoals details van het aantal berichten.
getTopic(string, OperationOptions)	Retourneert een object dat het onderwerp en de bijbehorende eigenschappen vertegenwoordigt. Als u de informatie over de onderwerpruntime wilt ophalen, zoals details over het aantal abonnementen, gebruikt u `getTopicRuntimeProperties` API.
getTopicRuntimeProperties(string, OperationOptions)	Retourneert een object dat de runtimegegevens van het onderwerp vertegenwoordigt, zoals het aantal abonnementen.
listQueues(OperationOptions)	Retourneert een asynchrone iterator om alle wachtrijen weer te geven. .byPage() retourneert een asynchrone iterator om de wachtrijen op pagina's weer te geven.
listQueuesRuntimeProperties(OperationOptions)	Retourneert een asynchrone iterator om runtime-informatie van de wachtrijen weer te geven. .byPage() retourneert een asynchrone iterator om runtime-informatie van de wachtrijen op pagina's weer te geven.
listRules(string, string, OperationOptions)	Retourneert een asynchrone iterator om alle regels onder het opgegeven abonnement weer te geven. .byPage() retourneert een asynchrone iterator om de regels op pagina's weer te geven.
listSubscriptions(string, OperationOptions)	Retourneert een asynchrone iterator om alle abonnementen onder het opgegeven onderwerp weer te geven. .byPage() retourneert een asynchrone iterator om de abonnementen op pagina's weer te geven.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Retourneert een asynchrone iterator om runtimegegevens van de abonnementen onder het opgegeven onderwerp weer te geven. .byPage() retourneert een asynchrone iterator om runtimegegevens van abonnementen op pagina's weer te geven.
listTopics(OperationOptions)	Retourneert een asynchrone iterator om alle onderwerpen weer te geven. .byPage() retourneert een asynchrone iterator om de onderwerpen op pagina's weer te geven.
listTopicsRuntimeProperties(OperationOptions)	Retourneert een asynchrone iterator om runtime-informatie van de onderwerpen weer te geven. .byPage() retourneert een asynchrone iterator om runtime-informatie van de onderwerpen op pagina's weer te geven.
queueExists(string, OperationOptions)	Controleert of een bepaalde wachtrij bestaat of niet.
ruleExists(string, string, string, OperationOptions)	Hiermee wordt gecontroleerd of een bepaalde regel al dan niet bestaat.
subscriptionExists(string, string, OperationOptions)	Controleert of een bepaald abonnement in het onderwerp voorkomt of niet.
topicExists(string, OperationOptions)	Controleert of een bepaald onderwerp bestaat of niet.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Updates de wachtrij op basis van de opgegeven eigenschappen van de wachtrij. Alle eigenschappen van de wachtrij moeten worden ingesteld, zelfs als slechts een subset ervan daadwerkelijk kan worden bijgewerkt. Daarom is de voorgestelde stroom om de uitvoer van `getQueue()`te gebruiken, de gewenste eigenschappen in de stroom bij te werken en het gewijzigde object vervolgens door te geven aan `updateQueue()`. De eigenschappen die niet kunnen worden bijgewerkt, worden gemarkeerd als alleen-lezen in de `QueueProperties` interface.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Updates eigenschappen op de regel op basis van de opgegeven naam op basis van de opgegeven opties. Alle regeleigenschappen moeten worden ingesteld, zelfs als een van deze eigenschappen wordt bijgewerkt. Daarom is de voorgestelde stroom om de uitvoer van `getRule()`te gebruiken, de gewenste eigenschappen in de stroom bij te werken en het gewijzigde object vervolgens door te geven aan `updateRule()`.
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Updates het abonnement op basis van de opgegeven abonnementseigenschappen. Alle abonnementseigenschappen moeten worden ingesteld, zelfs als slechts een subset ervan daadwerkelijk kan worden bijgewerkt. Daarom is de voorgestelde stroom om de uitvoer van `getSubscription()`te gebruiken, de gewenste eigenschappen in de stroom bij te werken en het gewijzigde object vervolgens door te geven aan `updateSubscription()`. De eigenschappen die niet kunnen worden bijgewerkt, worden gemarkeerd als alleen-lezen in de `SubscriptionProperties` interface.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Updates het onderwerp op basis van de opgegeven onderwerpeigenschappen. Alle onderwerpeigenschappen moeten worden ingesteld, zelfs als slechts een subset ervan daadwerkelijk kan worden bijgewerkt. Daarom is de voorgestelde stroom om de uitvoer van `getTopic()`te gebruiken, de gewenste eigenschappen in de stroom bij te werken en het gewijzigde object vervolgens door te geven aan `updateTopic()`. De eigenschappen die niet kunnen worden bijgewerkt, worden gemarkeerd als alleen-lezen in de `TopicProperties` interface.

Overgenomen methoden

sendOperationRequest<T>(OperationArguments, OperationSpec)	Verzend een HTTP-aanvraag die is ingevuld met behulp van de opgegeven OperationSpec.
sendRequest(PipelineRequest)	Verzend de opgegeven httpRequest.

Constructordetails

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Initialiseert een nieuw exemplaar van de klasse ServiceBusAdministrationClient.

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

Parameters

connectionString: string

De connection string nodig voor de client om verbinding te maken met Azure.

options: ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Initialiseert een nieuw exemplaar van de klasse ServiceBusAdministrationClient.

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

Parameters

fullyQualifiedNamespace: string

De volledig gekwalificeerde naamruimte van uw Service Bus-exemplaar die waarschijnlijk vergelijkbaar is met .servicebus.windows.net.

credential: TokenCredential | NamedKeyCredential

Een referentieobject dat door de client wordt gebruikt om het token op te halen om de verbinding met de Azure Service Bus te verifiëren. Zie @azure/identity voor het maken van de referenties. Als u uw eigen implementatie van de TokenCredential interface voor AAD gebruikt, stelt u de 'bereiken' voor Service Bus in op ["https://servicebus.azure.net//user_impersonation"] om het juiste token op te halen. Gebruik de AzureNamedKeyCredential from @azure/core-auth als u een SharedAccessKeyName en SharedAccessKey wilt doorgeven zonder een connection string te gebruiken. Deze velden worden respectievelijk toegewezen aan het name veld en key in AzureNamedKeyCredential.

options: ServiceBusAdministrationClientOptions

PipelineOptions

Details van overgenomen eigenschap

pipeline

De pijplijn die door deze client wordt gebruikt om aanvragen te doen

pipeline: Pipeline

Waarde van eigenschap

Pipeline

Overgenomen van ServiceClient.pipeline

Methodedetails

createQueue(string, CreateQueueOptions)

Hiermee maakt u een wachtrij met een bepaalde naam, geconfigureerd met behulp van de opgegeven opties

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

Parameters

queueName: string

options: CreateQueueOptions

Opties voor het configureren van de wachtrij die wordt gemaakt (u kunt bijvoorbeeld een wachtrij configureren ter ondersteuning van partities of sessies) en de bewerkingsopties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<QueueProperties>>

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

Hiermee maakt u een regel met een bepaalde naam, geconfigureerd met behulp van de opgegeven opties.

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

Parameters

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: SqlRuleFilter | CorrelationRuleFilter

Definieert de filterexpressie die door de regel wordt geëvalueerd.

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<RuleProperties>>

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

Hiermee maakt u een regel met een bepaalde naam, geconfigureerd met behulp van de opgegeven opties.

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

Parameters

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: SqlRuleFilter | CorrelationRuleFilter

Definieert de filterexpressie die door de regel wordt geëvalueerd.

ruleAction: SqlRuleAction

De SQL-achtige expressie die kan worden uitgevoerd op het bericht als het bijbehorende filter van toepassing is.

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Hiermee maakt u een abonnement met een bepaalde naam, geconfigureerd met behulp van de opgegeven opties

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

Parameters

topicName: string

subscriptionName: string

options: CreateSubscriptionOptions

Opties voor het configureren van het abonnement dat wordt gemaakt (u kunt bijvoorbeeld een abonnement configureren om partities of sessies te ondersteunen) en de bewerkingsopties die kunnen worden gebruikt om andere configuraties van de HTTP-aanvraag af te breken, te traceren en te beheren.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Hiermee maakt u een onderwerp met een bepaalde naam, geconfigureerd met behulp van de opgegeven opties

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

Parameters

topicName: string

options: CreateTopicOptions

Opties voor het configureren van het onderwerp dat wordt gemaakt (u kunt bijvoorbeeld een onderwerp configureren om partities te ondersteunen) en de bewerkingsopties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties in de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Hiermee verwijdert u een wachtrij.

function deleteQueue(queueName: string, operationOptions?: OperationOptions): Promise<WithResponse<__type>>

Parameters

queueName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<__type>>

deleteRule(string, string, string, OperationOptions)

Hiermee verwijdert u een regel.

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

Parameters

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<__type>>

deleteSubscription(string, string, OperationOptions)

Hiermee verwijdert u een abonnement.

function deleteSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<WithResponse<__type>>

Parameters

topicName: string

subscriptionName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<__type>>

deleteTopic(string, OperationOptions)

Hiermee verwijdert u een onderwerp.

function deleteTopic(topicName: string, operationOptions?: OperationOptions): Promise<WithResponse<__type>>

Parameters

topicName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<__type>>

getNamespaceProperties(OperationOptions)

Retourneert een object dat de metagegevens vertegenwoordigt die betrekking hebben op een Service Bus-naamruimte.

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

Parameters

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Retouren

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Retourneert een object dat de wachtrij en de bijbehorende eigenschappen vertegenwoordigt. Als u de informatie over de wachtrijruntime wilt ophalen, zoals details van het aantal berichten, gebruikt u getQueueRuntimeProperties API.

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

Parameters

queueName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Retourneert een object dat de runtimegegevens van de wachtrij vertegenwoordigt, zoals details van het aantal berichten.

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

Parameters

queueName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Retourneert een object dat de regel vertegenwoordigt met de opgegeven naam, samen met alle bijbehorende eigenschappen.

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

Parameters

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Retourneert een object dat het abonnement en de bijbehorende eigenschappen vertegenwoordigt. Als u de runtimegegevens van het abonnement wilt ophalen, zoals details van het aantal berichten, gebruikt getSubscriptionRuntimeProperties u DE API.

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

Parameters

topicName: string

subscriptionName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Retourneert een object dat de runtimegegevens van het abonnement vertegenwoordigt, zoals details van het aantal berichten.

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

Parameters

topicName: string

subscriptionName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Retourneert een object dat het onderwerp en de bijbehorende eigenschappen vertegenwoordigt. Als u de informatie over de onderwerpruntime wilt ophalen, zoals details over het aantal abonnementen, gebruikt u getTopicRuntimeProperties API.

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

Parameters

topicName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Retourneert een object dat de runtimegegevens van het onderwerp vertegenwoordigt, zoals het aantal abonnementen.

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

Parameters

topicName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties op de HTTP-aanvraag.

Hieronder vindt u fouten die kunnen worden verwacht van deze bewerking

Retouren

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

Retourneert een asynchrone iterator om alle wachtrijen weer te geven. .byPage() retourneert een asynchrone iterator om de wachtrijen op pagina's weer te geven.

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

Parameters

options: OperationOptions

Retouren

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>>

Een asynchroneIterableIterator die ondersteuning biedt voor paging.

listQueuesRuntimeProperties(OperationOptions)

Retourneert een asynchrone iterator om runtime-informatie van de wachtrijen weer te geven. .byPage() retourneert een asynchrone iterator om runtime-informatie van de wachtrijen op pagina's weer te geven.

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

Parameters

options: OperationOptions

Retouren

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>>

Een asynchroneIterableIterator die paging ondersteunt.

listRules(string, string, OperationOptions)

Retourneert een asynchrone iterator om alle regels onder het opgegeven abonnement weer te geven. .byPage() retourneert een asynchrone iterator om de regels op pagina's weer te geven.

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

Parameters

topicName: string

subscriptionName: string

options: OperationOptions

Retouren

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>>

Een asynchroneIterableIterator die paging ondersteunt.

listSubscriptions(string, OperationOptions)

Retourneert een asynchrone iterator om alle abonnementen onder het opgegeven onderwerp weer te geven. .byPage() retourneert een asynchrone iterator om de abonnementen op pagina's weer te geven.

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

Parameters

topicName: string

options: OperationOptions

Retouren

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>>

Een asynchroneIterableIterator die paging ondersteunt.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Retourneert een asynchrone iterator om runtimegegevens van de abonnementen onder het opgegeven onderwerp weer te geven. .byPage() retourneert een asynchrone iterator om runtimegegevens van abonnementen op pagina's weer te geven.

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

Parameters

topicName: string

options: OperationOptions

Retouren

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>>

Een asynchroneIterableIterator die paging ondersteunt.

listTopics(OperationOptions)

Retourneert een asynchrone iterator om alle onderwerpen weer te geven. .byPage() retourneert een asynchrone iterator om de onderwerpen op pagina's weer te geven.

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

Parameters

options: OperationOptions

Retouren

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>>

Een asynchroneIterableIterator die paging ondersteunt.

listTopicsRuntimeProperties(OperationOptions)

Retourneert een asynchrone iterator om runtime-informatie van de onderwerpen weer te geven. .byPage() retourneert een asynchrone iterator om runtime-informatie van de onderwerpen op pagina's weer te geven.

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

Parameters

options: OperationOptions

Retouren

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>>

Een asynchroneIterableIterator die paging ondersteunt.

queueExists(string, OperationOptions)

Controleert of een bepaalde wachtrij bestaat of niet.

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

Parameters

queueName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties in de HTTP-aanvraag.

Retouren

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Hiermee wordt gecontroleerd of een bepaalde regel al dan niet bestaat.

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

Parameters

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Retouren

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Controleert of een bepaald abonnement in het onderwerp voorkomt of niet.

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

Parameters

topicName: string

subscriptionName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties in de HTTP-aanvraag.

Retouren

Promise<boolean>

topicExists(string, OperationOptions)

Controleert of een bepaald onderwerp bestaat of niet.

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

Parameters

topicName: string

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties in de HTTP-aanvraag.

Retouren

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Updates de wachtrij op basis van de opgegeven eigenschappen van de wachtrij. Alle eigenschappen van de wachtrij moeten worden ingesteld, zelfs als slechts een subset ervan daadwerkelijk kan worden bijgewerkt. Daarom is de voorgestelde stroom om de uitvoer van getQueue()te gebruiken, de gewenste eigenschappen in de stroom bij te werken en het gewijzigde object vervolgens door te geven aan updateQueue(). De eigenschappen die niet kunnen worden bijgewerkt, worden gemarkeerd als alleen-lezen in de QueueProperties interface.

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

Parameters

queue: WithResponse<QueueProperties>

Object dat de eigenschappen van de wachtrij en het onbewerkte antwoord vertegenwoordigt. requiresSession, requiresDuplicateDetection, enablePartitioningen name kan niet worden bijgewerkt nadat de wachtrij is gemaakt.

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties in de HTTP-aanvraag.

Hieronder vindt u fouten die van deze bewerking kunnen worden verwacht

Retouren

Promise<WithResponse<QueueProperties>>

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

Updates eigenschappen op de regel op basis van de opgegeven naam op basis van de opgegeven opties. Alle regeleigenschappen moeten worden ingesteld, zelfs als een van deze eigenschappen wordt bijgewerkt. Daarom is de voorgestelde stroom om de uitvoer van getRule()te gebruiken, de gewenste eigenschappen in de stroom bij te werken en het gewijzigde object vervolgens door te geven aan updateRule().

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

Parameters

topicName: string

subscriptionName: string

rule: WithResponse<RuleProperties>

Opties voor het configureren van de regel die wordt bijgewerkt en het onbewerkte antwoord. U kunt bijvoorbeeld het filter configureren om toe te passen op het bijbehorende onderwerp/abonnement.

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties in de HTTP-aanvraag.

Hieronder vindt u fouten die van deze bewerking kunnen worden verwacht

Retouren

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Updates het abonnement op basis van de opgegeven abonnementseigenschappen. Alle abonnementseigenschappen moeten worden ingesteld, zelfs als slechts een subset ervan daadwerkelijk kan worden bijgewerkt. Daarom is de voorgestelde stroom om de uitvoer van getSubscription()te gebruiken, de gewenste eigenschappen in de stroom bij te werken en het gewijzigde object vervolgens door te geven aan updateSubscription(). De eigenschappen die niet kunnen worden bijgewerkt, worden gemarkeerd als alleen-lezen in de SubscriptionProperties interface.

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

Parameters

subscription: WithResponse<SubscriptionProperties>

Object dat de eigenschappen van het abonnement en het onbewerkte antwoord vertegenwoordigt. subscriptionName, topicNameen requiresSession kan niet worden bijgewerkt nadat het abonnement is gemaakt.

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties in de HTTP-aanvraag.

Hieronder vindt u fouten die van deze bewerking kunnen worden verwacht

Retouren

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Updates het onderwerp op basis van de opgegeven onderwerpeigenschappen. Alle onderwerpeigenschappen moeten worden ingesteld, zelfs als slechts een subset ervan daadwerkelijk kan worden bijgewerkt. Daarom is de voorgestelde stroom om de uitvoer van getTopic()te gebruiken, de gewenste eigenschappen in de stroom bij te werken en het gewijzigde object vervolgens door te geven aan updateTopic(). De eigenschappen die niet kunnen worden bijgewerkt, worden gemarkeerd als alleen-lezen in de TopicProperties interface.

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

Parameters

topic: WithResponse<TopicProperties>

Object dat de eigenschappen van het onderwerp en het onbewerkte antwoord vertegenwoordigt. requiresDuplicateDetection, enablePartitioningen name kan niet worden bijgewerkt nadat het onderwerp is gemaakt.

operationOptions: OperationOptions

De opties die kunnen worden gebruikt voor het afbreken, traceren en beheren van andere configuraties in de HTTP-aanvraag.

Hieronder vindt u fouten die van deze bewerking kunnen worden verwacht

Retouren

Promise<WithResponse<TopicProperties>>

Details overgenomen methode

sendOperationRequest<T>(OperationArguments, OperationSpec)

Verzend een HTTP-aanvraag die is ingevuld met behulp van de opgegeven OperationSpec.

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

Parameters

operationArguments: OperationArguments

De argumenten waaruit de sjabloonwaarden van de HTTP-aanvraag worden ingevuld.

operationSpec: OperationSpec

De OperationSpec die moet worden gebruikt om de httpRequest in te vullen.

Retouren

Promise<T>

Overgenomen van ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Verzend de opgegeven httpRequest.

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

Parameters

request: PipelineRequest

Retouren

Promise<PipelineResponse>

Overgenomen van ServiceClient.sendRequest

Delen via

ServiceBusAdministrationClient class

Constructors

Overgenomen eigenschappen

Methoden

Overgenomen methoden

Constructordetails

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Parameters

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Parameters

Details van overgenomen eigenschap

pipeline

Waarde van eigenschap

Methodedetails

createQueue(string, CreateQueueOptions)

Parameters

Retouren

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

Parameters

Retouren

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

Parameters

Retouren

createSubscription(string, string, CreateSubscriptionOptions)

Parameters

Retouren

createTopic(string, CreateTopicOptions)

Parameters

Retouren

deleteQueue(string, OperationOptions)

Parameters

Retouren

deleteRule(string, string, string, OperationOptions)

Parameters

Retouren

deleteSubscription(string, string, OperationOptions)

Parameters

Retouren

deleteTopic(string, OperationOptions)

Parameters

Retouren

getNamespaceProperties(OperationOptions)

Parameters

Retouren

getQueue(string, OperationOptions)

Parameters

Retouren

getQueueRuntimeProperties(string, OperationOptions)

Parameters

Retouren

getRule(string, string, string, OperationOptions)

Parameters

Retouren

getSubscription(string, string, OperationOptions)

Parameters

Retouren

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Parameters

Retouren

getTopic(string, OperationOptions)

Parameters

Retouren

getTopicRuntimeProperties(string, OperationOptions)

Parameters

Retouren

listQueues(OperationOptions)

Parameters

Retouren

listQueuesRuntimeProperties(OperationOptions)

Parameters

Retouren

listRules(string, string, OperationOptions)

Parameters

Retouren

listSubscriptions(string, OperationOptions)

Parameters

Retouren

listSubscriptionsRuntimeProperties(string, OperationOptions)

Parameters