ServiceBusAdministrationClient class

Odwołanie

Pakiet:: @azure/service-bus

Wszystkie operacje zwracają obietnice rozpoznające obiekt, który ma odpowiednie dane wyjściowe. Te obiekty mają również właściwość o nazwie _response , której można użyć, jeśli chcesz uzyskać dostęp do bezpośredniej odpowiedzi z usługi.

Extends: ServiceClient

Konstruktory

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	Inicjuje nowe wystąpienie klasy ServiceBusAdministrationClient.
ServiceBusAdministrationClient(string, TokenCredential \| NamedKeyCredential, ServiceBusAdministrationClientOptions)

Właściwości dziedziczone

pipeline

Potok używany przez tego klienta do tworzenia żądań

Metody

createQueue(string, CreateQueueOptions)	Tworzy kolejkę o podanej nazwie skonfigurowanej przy użyciu podanych opcji
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, OperationOptions)	Tworzy regułę o podanej nazwie skonfigurowanej przy użyciu podanych opcji.
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, SqlRuleAction, OperationOptions)	Tworzy regułę o podanej nazwie skonfigurowanej przy użyciu podanych opcji.
createSubscription(string, string, CreateSubscriptionOptions)	Tworzy subskrypcję o podanej nazwie skonfigurowanej przy użyciu podanych opcji
createTopic(string, CreateTopicOptions)	Tworzy temat o podanej nazwie skonfigurowany przy użyciu podanych opcji
deleteQueue(string, OperationOptions)	Usuwa kolejkę.
deleteRule(string, string, string, OperationOptions)	Usuwa regułę.
deleteSubscription(string, string, OperationOptions)	Usuwa subskrypcję.
deleteTopic(string, OperationOptions)	Usuwa temat.
getNamespaceProperties(OperationOptions)	Zwraca obiekt reprezentujący metadane związane z przestrzenią nazw usługi Service Bus.
getQueue(string, OperationOptions)	Zwraca obiekt reprezentujący kolejkę i jego właściwości. Jeśli chcesz uzyskać informacje o środowisku uruchomieniowym kolejki, takie jak szczegóły liczby komunikatów, użyj `getQueueRuntimeProperties` interfejsu API.
getQueueRuntimeProperties(string, OperationOptions)	Zwraca obiekt reprezentujący informacje o środowisku uruchomieniowym kolejki, takie jak szczegóły liczby komunikatów.
getRule(string, string, string, OperationOptions)	Zwraca obiekt reprezentujący regułę o podanej nazwie wraz ze wszystkimi jego właściwościami.
getSubscription(string, string, OperationOptions)	Zwraca obiekt reprezentujący subskrypcję i jego właściwości. Jeśli chcesz uzyskać informacje o środowisku uruchomieniowym subskrypcji, takie jak szczegóły liczby komunikatów, użyj interfejsu `getSubscriptionRuntimeProperties` API.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Zwraca obiekt reprezentujący informacje o środowisku uruchomieniowym subskrypcji, takie jak szczegóły liczby komunikatów.
getTopic(string, OperationOptions)	Zwraca obiekt reprezentujący temat i jego właściwości. Jeśli chcesz uzyskać informacje o środowisku uruchomieniowym tematu, takie jak szczegóły liczby subskrypcji, użyj `getTopicRuntimeProperties` interfejsu API.
getTopicRuntimeProperties(string, OperationOptions)	Zwraca obiekt reprezentujący informacje o czasie wykonywania tematu, takie jak liczba subskrypcji.
listQueues(OperationOptions)	Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich kolejek. Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę kolejek na stronach.
listQueuesRuntimeProperties(OperationOptions)	Zwraca iterator asynchroniczny, aby wyświetlić informacje o czasie wykonywania kolejek. Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić informacje o czasie wykonywania kolejek na stronach.
listRules(string, string, OperationOptions)	Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich reguł w ramach określonej subskrypcji. Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę reguł na stronach.
listSubscriptions(string, OperationOptions)	Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich subskrypcji w określonym temacie. Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę subskrypcji na stronach.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Zwraca iterator asynchroniczny, aby wyświetlić informacje o środowisku uruchomieniowym subskrypcji w określonym temacie. Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę informacji o środowisku uruchomieniowym subskrypcji na stronach.
listTopics(OperationOptions)	Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich tematów. Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę tematów na stronach.
listTopicsRuntimeProperties(OperationOptions)	Zwraca iterator asynchroniczny, aby wyświetlić informacje o środowisku uruchomieniowym tematów. Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić informacje o środowisku uruchomieniowym tematów na stronach.
queueExists(string, OperationOptions)	Sprawdza, czy dana kolejka istnieje, czy nie.
ruleExists(string, string, string, OperationOptions)	Sprawdza, czy dana reguła istnieje, czy nie.
subscriptionExists(string, string, OperationOptions)	Sprawdza, czy dana subskrypcja istnieje w temacie, czy nie.
topicExists(string, OperationOptions)	Sprawdza, czy dany temat istnieje, czy nie.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Aktualizacje kolejki na podstawie podanych właściwości kolejki. Wszystkie właściwości kolejki muszą być ustawione, mimo że tylko ich podzbiór jest rzeczywiście aktualizowalny. W związku z tym sugerowany przepływ polega na użyciu danych wyjściowych z `getQueue()`, zaktualizowania żądanych właściwości, a następnie przekazania zmodyfikowanego obiektu do `updateQueue()`. Właściwości, których nie można zaktualizować, są oznaczone jako tylko do odczytu w interfejsie `QueueProperties` .
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Aktualizacje właściwości reguły według podanej nazwy na podstawie podanych opcji. Wszystkie właściwości reguły muszą być ustawione nawet wtedy, gdy jedna z nich jest aktualizowana. W związku z tym sugerowany przepływ polega na użyciu danych wyjściowych z `getRule()`, zaktualizowania żądanych właściwości, a następnie przekazania zmodyfikowanego obiektu do `updateRule()`.
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Aktualizacje subskrypcji na podstawie podanych właściwości subskrypcji. Wszystkie właściwości subskrypcji muszą być ustawione, mimo że tylko ich podzbiór jest rzeczywiście aktualizowalny. W związku z tym sugerowany przepływ polega na użyciu danych wyjściowych z `getSubscription()`, zaktualizowania żądanych właściwości, a następnie przekazania zmodyfikowanego obiektu do `updateSubscription()`. Właściwości, których nie można zaktualizować, są oznaczone jako tylko do odczytu w interfejsie `SubscriptionProperties` .
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Aktualizacje temat na podstawie podanych właściwości tematu. Wszystkie właściwości tematu muszą być ustawione, mimo że tylko ich podzbiór jest rzeczywiście aktualizowalny. W związku z tym sugerowany przepływ polega na użyciu danych wyjściowych z `getTopic()`, zaktualizowania żądanych właściwości, a następnie przekazania zmodyfikowanego obiektu do `updateTopic()`. Właściwości, których nie można zaktualizować, są oznaczone jako tylko do odczytu w interfejsie `TopicProperties` .

Metody dziedziczone

sendOperationRequest<T>(OperationArguments, OperationSpec)	Wyślij żądanie HTTP wypełnione przy użyciu podanego elementu OperationSpec.
sendRequest(PipelineRequest)	Wyślij podany element httpRequest.

Szczegóły konstruktora

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Inicjuje nowe wystąpienie klasy ServiceBusAdministrationClient.

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

Parametry

connectionString: string

Parametry połączenia potrzebne klientowi do nawiązania połączenia z platformą Azure.

options: ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

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

Parametry

fullyQualifiedNamespace: string

W pełni kwalifikowana przestrzeń nazw wystąpienia usługi Service Bus, która prawdopodobnie będzie podobna do .servicebus.windows.net.

credential: TokenCredential | NamedKeyCredential

Obiekt poświadczeń używany przez klienta do uzyskiwania tokenu w celu uwierzytelnienia połączenia z Azure Service Bus. Zobacz @azure/tożsamość, aby utworzyć poświadczenia. Jeśli używasz własnej implementacji interfejsu TokenCredential względem usługi AAD, ustaw wartość "zakresy" dla usługi Service Bus, aby ["https://servicebus.azure.net//user_impersonation"] uzyskać odpowiedni token. Użyj polecenia AzureNamedKeyCredential from @azure/core-auth, jeśli chcesz przekazać SharedAccessKeyNameSharedAccessKey parametry połączenia i bez użycia parametrów połączenia. Te pola są mapowanie odpowiednio na name pola i key w elemecie AzureNamedKeyCredential.

options: ServiceBusAdministrationClientOptions

PipelineOptions

Szczegóły właściwości dziedziczonej

pipeline

Potok używany przez tego klienta do tworzenia żądań

pipeline: Pipeline

Wartość właściwości

Pipeline

Dziedziczone z ServiceClient.pipeline

Szczegóły metody

createQueue(string, CreateQueueOptions)

Tworzy kolejkę o podanej nazwie skonfigurowanej przy użyciu podanych opcji

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

Parametry

queueName: string

options: CreateQueueOptions

Opcje konfigurowania tworzonej kolejki (na przykład można skonfigurować kolejkę do obsługi partycji lub sesji) oraz opcje operacji, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<QueueProperties>>

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

Tworzy regułę o podanej nazwie skonfigurowanej przy użyciu podanych opcji.

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

Parametry

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

Definiuje wyrażenie filtru, które oblicza reguła.

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<RuleProperties>>

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

Tworzy regułę o podanej nazwie skonfigurowanej przy użyciu podanych opcji.

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

Parametry

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

Definiuje wyrażenie filtru, które oblicza reguła.

ruleAction: SqlRuleAction

Wyrażenie podobne do języka SQL, które można wykonać w komunikacie, powinno dotyczyć skojarzonego filtru.

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Tworzy subskrypcję o podanej nazwie skonfigurowanej przy użyciu podanych opcji

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

Parametry

topicName: string

subscriptionName: string

options: CreateSubscriptionOptions

Opcje konfigurowania tworzonej subskrypcji (na przykład można skonfigurować subskrypcję do obsługi partycji lub sesji) oraz opcje operacji, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Tworzy temat o podanej nazwie skonfigurowany przy użyciu podanych opcji

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

Parametry

topicName: string

options: CreateTopicOptions

Opcje konfigurowania tworzonego tematu (na przykład można skonfigurować temat do obsługi partycji) oraz opcje operacji, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Usuwa kolejkę.

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

Parametry

queueName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Usuwa regułę.

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

Parametry

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Usuwa subskrypcję.

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

Parametry

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Usuwa temat.

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

Parametry

topicName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Zwraca obiekt reprezentujący metadane związane z przestrzenią nazw usługi Service Bus.

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

Parametry

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Zwraca

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Zwraca obiekt reprezentujący kolejkę i jego właściwości. Jeśli chcesz uzyskać informacje o środowisku uruchomieniowym kolejki, takie jak szczegóły liczby komunikatów, użyj getQueueRuntimeProperties interfejsu API.

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

Parametry

queueName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Zwraca obiekt reprezentujący informacje o środowisku uruchomieniowym kolejki, takie jak szczegóły liczby komunikatów.

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

Parametry

queueName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Zwraca obiekt reprezentujący regułę o podanej nazwie wraz ze wszystkimi jego właściwościami.

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

Parametry

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Zwraca obiekt reprezentujący subskrypcję i jego właściwości. Jeśli chcesz uzyskać informacje o środowisku uruchomieniowym subskrypcji, takie jak szczegóły liczby komunikatów, użyj interfejsu getSubscriptionRuntimeProperties API.

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

Parametry

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Zwraca obiekt reprezentujący informacje o środowisku uruchomieniowym subskrypcji, takie jak szczegóły liczby komunikatów.

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

Parametry

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Zwraca obiekt reprezentujący temat i jego właściwości. Jeśli chcesz uzyskać informacje o środowisku uruchomieniowym tematu, takie jak szczegóły liczby subskrypcji, użyj getTopicRuntimeProperties interfejsu API.

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

Parametry

topicName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Zwraca obiekt reprezentujący informacje o czasie wykonywania tematu, takie jak liczba subskrypcji.

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

Parametry

topicName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich kolejek.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę kolejek na stronach.

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

Parametry

options: OperationOptions

Zwraca

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

AsyncIterableIterator, który obsługuje stronicowanie.

listQueuesRuntimeProperties(OperationOptions)

Zwraca iterator asynchroniczny, aby wyświetlić informacje o czasie wykonywania kolejek.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić informacje o czasie wykonywania kolejek na stronach.

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

Parametry

options: OperationOptions

Zwraca

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

AsyncIterableIterator, który obsługuje stronicowanie.

listRules(string, string, OperationOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich reguł w ramach określonej subskrypcji.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę reguł na stronach.

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

Parametry

topicName: string

subscriptionName: string

options: OperationOptions

Zwraca

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

AsyncIterableIterator, który obsługuje stronicowanie.

listSubscriptions(string, OperationOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich subskrypcji w określonym temacie.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę subskrypcji na stronach.

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

Parametry

topicName: string

options: OperationOptions

Zwraca

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

AsyncIterableIterator, który obsługuje stronicowanie.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Zwraca iterator asynchroniczny, aby wyświetlić informacje o środowisku uruchomieniowym subskrypcji w określonym temacie.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę informacji o środowisku uruchomieniowym subskrypcji na stronach.

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

Parametry

topicName: string

options: OperationOptions

Zwraca

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

AsyncIterableIterator, który obsługuje stronicowanie.

listTopics(OperationOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich tematów.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę tematów na stronach.

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

Parametry

options: OperationOptions

Zwraca

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

AsyncIterableIterator, który obsługuje stronicowanie.

listTopicsRuntimeProperties(OperationOptions)

Zwraca iterator asynchroniczny, aby wyświetlić informacje o środowisku uruchomieniowym tematów.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić informacje o środowisku uruchomieniowym tematów na stronach.

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

Parametry

options: OperationOptions

Zwraca

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

AsyncIterableIterator, który obsługuje stronicowanie.

queueExists(string, OperationOptions)

Sprawdza, czy dana kolejka istnieje, czy nie.

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

Parametry

queueName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Zwraca

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Sprawdza, czy dana reguła istnieje, czy nie.

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

Parametry

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Zwraca

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Sprawdza, czy dana subskrypcja istnieje w temacie, czy nie.

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

Parametry

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Zwraca

Promise<boolean>

topicExists(string, OperationOptions)

Sprawdza, czy dany temat istnieje, czy nie.

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

Parametry

topicName: string

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Zwraca

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Aktualizacje kolejki na podstawie podanych właściwości kolejki. Wszystkie właściwości kolejki muszą być ustawione, mimo że tylko ich podzbiór jest rzeczywiście aktualizowalny. W związku z tym sugerowany przepływ polega na użyciu danych wyjściowych z getQueue(), zaktualizowania żądanych właściwości, a następnie przekazania zmodyfikowanego obiektu do updateQueue().

Właściwości, których nie można zaktualizować, są oznaczone jako tylko do odczytu w interfejsie QueueProperties .

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

Parametry

queue: WithResponse<QueueProperties>

Obiekt reprezentujący właściwości kolejki i nieprzetworzonej odpowiedzi. requiresSession, , requiresDuplicateDetectionenablePartitioningi name nie można zaktualizować po utworzeniu kolejki.

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<QueueProperties>>

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

Aktualizacje właściwości reguły według podanej nazwy na podstawie podanych opcji. Wszystkie właściwości reguły muszą być ustawione nawet wtedy, gdy jedna z nich jest aktualizowana. W związku z tym sugerowany przepływ polega na użyciu danych wyjściowych z getRule(), zaktualizowania żądanych właściwości, a następnie przekazania zmodyfikowanego obiektu do updateRule().

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

Parametry

topicName: string

subscriptionName: string

rule: WithResponse<RuleProperties>

Opcje konfigurowania aktualizowanej reguły i nieprzetworzonej odpowiedzi. Na przykład można skonfigurować filtr do zastosowania w skojarzonym temacie/subskrypcji.

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Aktualizacje subskrypcji na podstawie podanych właściwości subskrypcji. Wszystkie właściwości subskrypcji muszą być ustawione, mimo że tylko ich podzbiór jest rzeczywiście aktualizowalny. W związku z tym sugerowany przepływ polega na użyciu danych wyjściowych z getSubscription(), zaktualizowania żądanych właściwości, a następnie przekazania zmodyfikowanego obiektu do updateSubscription().

Właściwości, których nie można zaktualizować, są oznaczone jako tylko do odczytu w interfejsie SubscriptionProperties .

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

Parametry

subscription: WithResponse<SubscriptionProperties>

Obiekt reprezentujący właściwości subskrypcji i nieprzetworzonej odpowiedzi. subscriptionName, topicNamei requiresSession nie można go zaktualizować po utworzeniu subskrypcji.

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Aktualizacje temat na podstawie podanych właściwości tematu. Wszystkie właściwości tematu muszą być ustawione, mimo że tylko ich podzbiór jest rzeczywiście aktualizowalny. W związku z tym sugerowany przepływ polega na użyciu danych wyjściowych z getTopic(), zaktualizowania żądanych właściwości, a następnie przekazania zmodyfikowanego obiektu do updateTopic().

Właściwości, których nie można zaktualizować, są oznaczone jako tylko do odczytu w interfejsie TopicProperties .

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

Parametry

topic: WithResponse<TopicProperties>

Obiekt reprezentujący właściwości tematu i nieprzetworzonej odpowiedzi. requiresDuplicateDetection, enablePartitioningi name nie można go zaktualizować po utworzeniu tematu.

operationOptions: OperationOptions

Opcje, których można użyć do przerwania, śledzenia i kontrolowania innych konfiguracji w żądaniu HTTP.

Poniżej przedstawiono błędy, których można oczekiwać od tej operacji

Zwraca

Promise<WithResponse<TopicProperties>>

Szczegóły metody dziedziczonej

sendOperationRequest<T>(OperationArguments, OperationSpec)

Wyślij żądanie HTTP wypełnione przy użyciu podanego elementu OperationSpec.

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

Parametry

operationArguments: OperationArguments

Argumenty, z których zostaną wypełnione wartości szablonowe żądania HTTP.

operationSpec: OperationSpec

Element OperationSpec używany do wypełniania żądania httpRequest.

Zwraca

Promise<T>

Dziedziczone z ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Wyślij podany element httpRequest.

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

Parametry

request: PipelineRequest

Zwraca

Promise<PipelineResponse>

Dziedziczone z ServiceClient.sendRequest

Udostępnij za pośrednictwem

ServiceBusAdministrationClient class

Konstruktory

Właściwości dziedziczone

Metody

Metody dziedziczone

Szczegóły konstruktora

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Parametry

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Parametry

Szczegóły właściwości dziedziczonej

pipeline

Wartość właściwości

Szczegóły metody

createQueue(string, CreateQueueOptions)

Parametry

Zwraca

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

Parametry

Zwraca

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

Parametry

Zwraca

createSubscription(string, string, CreateSubscriptionOptions)

Parametry

Zwraca

createTopic(string, CreateTopicOptions)

Parametry

Zwraca

deleteQueue(string, OperationOptions)

Parametry

Zwraca

deleteRule(string, string, string, OperationOptions)

Parametry

Zwraca

deleteSubscription(string, string, OperationOptions)

Parametry

Zwraca

deleteTopic(string, OperationOptions)

Parametry

Zwraca

getNamespaceProperties(OperationOptions)

Parametry

Zwraca

getQueue(string, OperationOptions)

Parametry

Zwraca

getQueueRuntimeProperties(string, OperationOptions)

Parametry

Zwraca

getRule(string, string, string, OperationOptions)

Parametry

Zwraca

getSubscription(string, string, OperationOptions)

Parametry

Zwraca

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Parametry

Zwraca

getTopic(string, OperationOptions)

Parametry

Zwraca

getTopicRuntimeProperties(string, OperationOptions)

Parametry

Zwraca

listQueues(OperationOptions)

Parametry

Zwraca

listQueuesRuntimeProperties(OperationOptions)

Parametry

Zwraca

listRules(string, string, OperationOptions)

Parametry

Zwraca

listSubscriptions(string, OperationOptions)

Parametry

Zwraca

listSubscriptionsRuntimeProperties(string, OperationOptions)

Parametry