ServiceBusAdministrationClient class

Paquet:

@azure/service-bus

Toutes les opérations retournent des promesses qui se résolvent en un objet qui a la sortie appropriée. Ces objets ont également une propriété appelée _response que vous pouvez utiliser si vous souhaitez accéder à la réponse directe à partir du service.

Extends

ServiceClient

Constructeurs

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	Initialise une nouvelle instance de la classe ServiceBusAdministrationClient.
ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Propriétés héritées

pipeline

Pipeline utilisé par ce client pour effectuer des demandes

Méthodes

createQueue(string, CreateQueueOptions)	Crée une file d’attente avec un nom donné, configurée à l’aide des options données
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)	Crée une règle avec un nom donné, configurée à l’aide des options fournies.
createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)	Crée une règle avec un nom donné, configurée à l’aide des options fournies.
createSubscription(string, string, CreateSubscriptionOptions)	Crée un abonnement avec un nom donné, configuré à l’aide des options fournies
createTopic(string, CreateTopicOptions)	Crée une rubrique avec un nom donné, configurée à l’aide des options fournies
deleteQueue(string, OperationOptions)	Supprime une file d'attente.
deleteRule(string, string, string, OperationOptions)	Supprime une règle.
deleteSubscription(string, string, OperationOptions)	Supprime un abonnement.
deleteTopic(string, OperationOptions)	Supprime une rubrique.
getNamespaceProperties(OperationOptions)	Retourne un objet représentant les métadonnées liées à un espace de noms Service Bus.
getQueue(string, OperationOptions)	Retourne un objet représentant la file d’attente et ses propriétés. Si vous souhaitez obtenir les informations d’exécution de la file d’attente, telles que le nombre de messages, utilisez l’API getQueueRuntimeProperties .
getQueueRuntimeProperties(string, OperationOptions)	Retourne un objet représentant les informations d’exécution de la file d’attente, comme les détails du nombre de messages.
getRule(string, string, string, OperationOptions)	Retourne un objet représentant la règle avec le nom donné avec toutes ses propriétés.
getSubscription(string, string, OperationOptions)	Retourne un objet représentant l’abonnement et ses propriétés. Si vous souhaitez obtenir les informations du runtime d’abonnement, comme les détails du nombre de messages, utilisez l’API getSubscriptionRuntimeProperties .
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Retourne un objet qui représente les informations du runtime d’abonnement, comme les détails du nombre de messages.
getTopic(string, OperationOptions)	Retourne un objet représentant la rubrique et ses propriétés. Si vous souhaitez obtenir les informations du runtime de la rubrique, telles que les détails du nombre d’abonnements, utilisez l’API getTopicRuntimeProperties .
getTopicRuntimeProperties(string, OperationOptions)	Retourne un objet qui représente les informations d’exécution de la rubrique, comme le nombre d’abonnements.
listQueues(OperationOptions)	Retourne un itérateur itérable asynchrone pour répertorier toutes les files d’attente. .byPage() retourne un itérateur itérable asynchrone pour répertorier les files d’attente dans les pages.
listQueuesRuntimeProperties(OperationOptions)	Retourne un itérateur itérable asynchrone pour répertorier les informations d’exécution des files d’attente. .byPage() retourne un itérateur itérable asynchrone pour répertorier les informations d’exécution des files d’attente dans les pages.
listRules(string, string, OperationOptions)	Retourne un itérateur itérable asynchrone pour répertorier toutes les règles sous l’abonnement spécifié. .byPage() retourne un itérateur itérable asynchrone pour répertorier les règles dans les pages.
listSubscriptions(string, OperationOptions)	Retourne un itérateur asynchrone itérable pour répertorier tous les abonnements sous la rubrique spécifiée. .byPage() retourne un itérateur itérateur asynchrone pour répertorier les abonnements dans les pages.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Retourne un itérateur asynchrone itérable pour répertorier les informations d’exécution des abonnements sous la rubrique spécifiée. .byPage() retourne un itérateur itérateur asynchrone pour répertorier les informations d’exécution des abonnements dans les pages.
listTopics(OperationOptions)	Retourne un itérateur asynchrone itérable pour répertorier toutes les rubriques. .byPage() retourne un itérateur asynchrone itérateur pour répertorier les rubriques dans les pages.
listTopicsRuntimeProperties(OperationOptions)	Retourne un itérateur asynchrone itérable pour répertorier les informations d’exécution des rubriques. .byPage() retourne un itérateur itérateur asynchrone pour répertorier les informations d’exécution des rubriques dans les pages.
queueExists(string, OperationOptions)	Vérifie si une file d’attente donnée existe ou non.
ruleExists(string, string, string, OperationOptions)	Vérifie si une règle donnée existe ou non.
subscriptionExists(string, string, OperationOptions)	Vérifie si un abonnement donné existe dans la rubrique ou non.
topicExists(string, OperationOptions)	Vérifie si une rubrique donnée existe ou non.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Mises à jour la file d’attente en fonction des propriétés de file d’attente fournies. Toutes les propriétés de file d’attente doivent être définies même si seul un sous-ensemble d’entre eux peut être mis à jour. Par conséquent, le flux suggéré consiste à utiliser la sortie de getQueue(), à mettre à jour les propriétés souhaitées dans celui-ci, puis à passer l’objet modifié à updateQueue(). Les propriétés qui ne peuvent pas être mises à jour sont marquées comme en lecture seule dans l’interface QueueProperties .
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Mises à jour propriétés sur la règle par le nom donné en fonction des options données. Toutes les propriétés de règle doivent être définies même si l’une d’elles est mise à jour. Par conséquent, le flux suggéré consiste à utiliser la sortie de getRule(), à mettre à jour les propriétés souhaitées dans celui-ci, puis à passer l’objet modifié à updateRule().
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Mises à jour l’abonnement en fonction des propriétés de l’abonnement fournies. Toutes les propriétés d’abonnement doivent être définies, même si seul un sous-ensemble d’entre eux est réellement mis à jour. Par conséquent, le flux suggéré consiste à utiliser la sortie de getSubscription(), à mettre à jour les propriétés souhaitées dans celui-ci, puis à passer l’objet modifié à updateSubscription(). Les propriétés qui ne peuvent pas être mises à jour sont marquées comme en lecture seule dans l’interface SubscriptionProperties .
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Mises à jour la rubrique en fonction des propriétés de rubrique fournies. Toutes les propriétés de rubrique doivent être définies même si seul un sous-ensemble d’entre eux peut être mis à jour. Par conséquent, le flux suggéré consiste à utiliser la sortie de getTopic(), à mettre à jour les propriétés souhaitées dans celui-ci, puis à passer l’objet modifié à updateTopic(). Les propriétés qui ne peuvent pas être mises à jour sont marquées comme en lecture seule dans l’interface TopicProperties .

Méthodes héritées

sendOperationRequest<T>(OperationArguments, OperationSpec)	Envoyez une requête HTTP renseignée à l’aide de la spécification OperationSpec fournie.
sendRequest(PipelineRequest)	Envoyez le httpRequest fourni.

Détails du constructeur

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Initialise une nouvelle instance de la classe ServiceBusAdministrationClient.

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

Paramètres

connectionString

string

Chaîne de connexion nécessaire pour que le client se connecte à Azure.

options

ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

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

Paramètres

fullyQualifiedNamespace

string

Espace de noms complet de votre instance Service Bus, qui est susceptible d’être similaire à .servicebus.windows.net.

credential

TokenCredential | NamedKeyCredential

Objet d’informations d’identification utilisé par le client pour obtenir le jeton afin d’authentifier la connexion avec le Azure Service Bus. Consultez @azure/identité pour créer les informations d’identification. Si vous utilisez votre propre implémentation de l’interface TokenCredential sur AAD, définissez les « étendues » pour service-bus sur pour ["https://servicebus.azure.net//user_impersonation"] obtenir le jeton approprié. Utilisez le AzureNamedKeyCredential à partir de @azure/core-auth si vous souhaitez passer un SharedAccessKeyName et SharedAccessKey sans utiliser de chaîne de connexion. Ces champs sont mappés au name champ et key dans AzureNamedKeyCredential.

options

ServiceBusAdministrationClientOptions

PipelineOptions

Détails de la propriété héritée

pipeline

Pipeline utilisé par ce client pour effectuer des demandes

pipeline: Pipeline

Valeur de propriété

Pipeline

Hérité de ServiceClient.pipeline

Détails de la méthode

createQueue(string, CreateQueueOptions)

Crée une file d’attente avec un nom donné, configurée à l’aide des options données

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

Paramètres

queueName

string

options

CreateQueueOptions

Options de configuration de la file d’attente en cours de création (par exemple, vous pouvez configurer une file d’attente pour prendre en charge des partitions ou des sessions) et les options d’opération qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<QueueProperties>>

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

Crée une règle avec un nom donné, configurée à l’aide des options fournies.

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

Paramètres

topicName

string

subscriptionName

string

ruleName

string

ruleFilter

CorrelationRuleFilter | SqlRuleFilter

Définit l’expression de filtre évaluée par la règle.

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<RuleProperties>>

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

Crée une règle avec un nom donné, configurée à l’aide des options fournies.

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

Paramètres

topicName

string

subscriptionName

string

ruleName

string

ruleFilter

CorrelationRuleFilter | SqlRuleFilter

Définit l’expression de filtre évaluée par la règle.

ruleAction

SqlRuleAction

Expression de type SQL qui peut être exécutée sur le message si le filtre associé s’applique.

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Crée un abonnement avec un nom donné, configuré à l’aide des options fournies

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

Paramètres

topicName

string

subscriptionName

string

options

CreateSubscriptionOptions

Options de configuration de l’abonnement en cours de création (par exemple, vous pouvez configurer un abonnement pour prendre en charge des partitions ou des sessions) et les options d’opération qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Crée une rubrique avec un nom donné, configurée à l’aide des options fournies

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

Paramètres

topicName

string

options

CreateTopicOptions

Options de configuration de la rubrique en cours de création (par exemple, vous pouvez configurer une rubrique pour prendre en charge les partitions) et les options d’opération qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Supprime une file d'attente.

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

Paramètres

queueName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Supprime une règle.

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

Paramètres

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Supprime un abonnement.

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

Paramètres

topicName

string

subscriptionName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Supprime une rubrique.

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

Paramètres

topicName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Retourne un objet représentant les métadonnées liées à un espace de noms Service Bus.

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

Paramètres

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Retours

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Retourne un objet représentant la file d’attente et ses propriétés. Si vous souhaitez obtenir les informations d’exécution de la file d’attente, telles que le nombre de messages, utilisez l’API getQueueRuntimeProperties .

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

Paramètres

queueName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Retourne un objet représentant les informations d’exécution de la file d’attente, comme les détails du nombre de messages.

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

Paramètres

queueName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Retourne un objet représentant la règle avec le nom donné avec toutes ses propriétés.

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

Paramètres

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Retourne un objet représentant l’abonnement et ses propriétés. Si vous souhaitez obtenir les informations du runtime d’abonnement, comme les détails du nombre de messages, utilisez l’API getSubscriptionRuntimeProperties .

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

Paramètres

topicName

string

subscriptionName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Retourne un objet qui représente les informations du runtime d’abonnement, comme les détails du nombre de messages.

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

Paramètres

topicName

string

subscriptionName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Retourne un objet représentant la rubrique et ses propriétés. Si vous souhaitez obtenir les informations du runtime de la rubrique, telles que les détails du nombre d’abonnements, utilisez l’API getTopicRuntimeProperties .

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

Paramètres

topicName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Retourne un objet qui représente les informations d’exécution de la rubrique, comme le nombre d’abonnements.

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

Paramètres

topicName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

Retourne un itérateur itérable asynchrone pour répertorier toutes les files d’attente.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les files d’attente dans les pages.

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

Paramètres

options

OperationOptions

Retours

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

AsyncIterableIterator qui prend en charge la pagination.

listQueuesRuntimeProperties(OperationOptions)

Retourne un itérateur itérable asynchrone pour répertorier les informations d’exécution des files d’attente.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les informations d’exécution des files d’attente dans les pages.

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

Paramètres

options

OperationOptions

Retours

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

AsyncIterableIterator qui prend en charge la pagination.

listRules(string, string, OperationOptions)

Retourne un itérateur itérable asynchrone pour répertorier toutes les règles sous l’abonnement spécifié.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les règles dans les pages.

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

Paramètres

topicName

string

subscriptionName

string

options

OperationOptions

Retours

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

AsyncIterableIterator qui prend en charge la pagination.

listSubscriptions(string, OperationOptions)

Retourne un itérateur asynchrone itérable pour répertorier tous les abonnements sous la rubrique spécifiée.

.byPage() retourne un itérateur itérateur asynchrone pour répertorier les abonnements dans les pages.

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

Paramètres

topicName

string

options

OperationOptions

Retours

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

AsyncIterableIterator qui prend en charge la pagination.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Retourne un itérateur asynchrone itérable pour répertorier les informations d’exécution des abonnements sous la rubrique spécifiée.

.byPage() retourne un itérateur itérateur asynchrone pour répertorier les informations d’exécution des abonnements dans les pages.

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

Paramètres

topicName

string

options

OperationOptions

Retours

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

AsyncIterableIterator qui prend en charge la pagination.

listTopics(OperationOptions)

Retourne un itérateur asynchrone itérable pour répertorier toutes les rubriques.

.byPage() retourne un itérateur asynchrone itérateur pour répertorier les rubriques dans les pages.

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

Paramètres

options

OperationOptions

Retours

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

AsyncIterableIterator qui prend en charge la pagination.

listTopicsRuntimeProperties(OperationOptions)

Retourne un itérateur asynchrone itérable pour répertorier les informations d’exécution des rubriques.

.byPage() retourne un itérateur itérateur asynchrone pour répertorier les informations d’exécution des rubriques dans les pages.

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

Paramètres

options

OperationOptions

Retours

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

AsyncIterableIterator qui prend en charge la pagination.

queueExists(string, OperationOptions)

Vérifie si une file d’attente donnée existe ou non.

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

Paramètres

queueName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Retours

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Vérifie si une règle donnée existe ou non.

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

Paramètres

topicName

string

subscriptionName

string

ruleName

string

operationOptions

OperationOptions

Retours

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Vérifie si un abonnement donné existe dans la rubrique ou non.

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

Paramètres

topicName

string

subscriptionName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Retours

Promise<boolean>

topicExists(string, OperationOptions)

Vérifie si une rubrique donnée existe ou non.

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

Paramètres

topicName

string

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Retours

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Mises à jour la file d’attente en fonction des propriétés de file d’attente fournies. Toutes les propriétés de file d’attente doivent être définies même si seul un sous-ensemble d’entre eux peut être mis à jour. Par conséquent, le flux suggéré consiste à utiliser la sortie de getQueue(), à mettre à jour les propriétés souhaitées dans celui-ci, puis à passer l’objet modifié à updateQueue().

Les propriétés qui ne peuvent pas être mises à jour sont marquées comme en lecture seule dans l’interface QueueProperties .

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

Paramètres

queue

WithResponse<QueueProperties>

Objet représentant les propriétés de la file d’attente et la réponse brute. requiresSession, requiresDuplicateDetection, enablePartitioninget name ne peuvent pas être mis à jour après la création de la file d’attente.

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<QueueProperties>>

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

Mises à jour propriétés sur la règle par le nom donné en fonction des options données. Toutes les propriétés de règle doivent être définies même si l’une d’elles est mise à jour. Par conséquent, le flux suggéré consiste à utiliser la sortie de getRule(), à mettre à jour les propriétés souhaitées dans celui-ci, puis à passer l’objet modifié à updateRule().

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

Paramètres

topicName

string

subscriptionName

string

rule

WithResponse<RuleProperties>

Options pour configurer la règle en cours de mise à jour et la réponse brute. Par exemple, vous pouvez configurer le filtre pour qu’il s’applique à la rubrique/à l’abonnement associé.

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Mises à jour l’abonnement en fonction des propriétés de l’abonnement fournies. Toutes les propriétés d’abonnement doivent être définies, même si seul un sous-ensemble d’entre eux est réellement mis à jour. Par conséquent, le flux suggéré consiste à utiliser la sortie de getSubscription(), à mettre à jour les propriétés souhaitées dans celui-ci, puis à passer l’objet modifié à updateSubscription().

Les propriétés qui ne peuvent pas être mises à jour sont marquées comme en lecture seule dans l’interface SubscriptionProperties .

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

Paramètres

subscription

WithResponse<SubscriptionProperties>

Objet représentant les propriétés de l’abonnement et la réponse brute. subscriptionName, topicNameet requiresSession ne peuvent pas être mis à jour après la création de l’abonnement.

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Mises à jour la rubrique en fonction des propriétés de rubrique fournies. Toutes les propriétés de rubrique doivent être définies même si seul un sous-ensemble d’entre eux peut être mis à jour. Par conséquent, le flux suggéré consiste à utiliser la sortie de getTopic(), à mettre à jour les propriétés souhaitées dans celui-ci, puis à passer l’objet modifié à updateTopic().

Les propriétés qui ne peuvent pas être mises à jour sont marquées comme en lecture seule dans l’interface TopicProperties .

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

Paramètres

topic

WithResponse<TopicProperties>

Objet représentant les propriétés de la rubrique et la réponse brute. requiresDuplicateDetection, enablePartitioninget name ne peuvent pas être mis à jour après la création de la rubrique.

operationOptions

OperationOptions

Options qui peuvent être utilisées pour abandonner, suivre et contrôler d’autres configurations sur la requête HTTP.

Voici les erreurs qui peuvent être attendues de cette opération

Retours

Promise<WithResponse<TopicProperties>>

Détails de la méthode héritée

sendOperationRequest<T>(OperationArguments, OperationSpec)

Envoyez une requête HTTP renseignée à l’aide de la spécification OperationSpec fournie.

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

Paramètres

operationArguments

OperationArguments

Arguments à partir duquel les valeurs de modèle de la requête HTTP seront remplies.

operationSpec

OperationSpec

OperationSpec à utiliser pour remplir le httpRequest.

Retours

Promise<T>

Hérité de ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Envoyez le httpRequest fourni.

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

Paramètres

request

PipelineRequest

Retours

Promise<PipelineResponse>

Hérité de ServiceClient.sendRequest