ServiceBusAdministrationClient class

ServiceBusAdministrationClient 클래스의 새 인스턴스를 초기화합니다.

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

매개 변수

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

매개 변수

이 클라이언트가 요청을 만드는 데 사용하는 파이프라인

pipeline: Pipeline

속성 값

상속된 From ServiceClient.pipeline

지정된 옵션을 사용하여 구성된 지정된 이름의 큐를 만듭니다.

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

매개 변수

반환

지정된 옵션을 사용하여 구성된 지정된 이름의 규칙을 만듭니다.

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

매개 변수

반환

지정된 옵션을 사용하여 구성된 지정된 이름의 규칙을 만듭니다.

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

매개 변수

반환

지정된 옵션을 사용하여 구성된 지정된 이름의 구독을 만듭니다.

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

매개 변수

반환

지정된 옵션을 사용하여 구성된 지정된 이름으로 토픽을 만듭니다.

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

매개 변수

반환

큐를 삭제합니다.

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

매개 변수

반환

규칙을 삭제합니다.

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

매개 변수

반환

구독을 삭제합니다.

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

매개 변수

반환

토픽을 삭제합니다.

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

매개 변수

반환

Service Bus 네임스페이스 관련 메타데이터를 나타내는 개체를 반환합니다.

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

매개 변수

반환

큐 및 해당 속성을 나타내는 개체를 반환합니다. 메시지 수 세부 정보와 같은 큐 런타임 정보를 얻으려면 API를 사용합니다 getQueueRuntimeProperties .

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

매개 변수

반환

메시지 수 세부 정보와 같은 큐 런타임 정보를 나타내는 개체를 반환합니다.

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

매개 변수

반환

모든 속성과 함께 지정된 이름의 Rule을 나타내는 개체를 반환합니다.

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

매개 변수

반환

구독 및 해당 속성을 나타내는 개체를 반환합니다. 메시지 수 세부 정보와 같은 구독 런타임 정보를 얻으려면 API를 사용합니다 getSubscriptionRuntimeProperties .

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

매개 변수

반환

메시지 수 세부 정보와 같은 구독 런타임 정보를 나타내는 개체를 반환합니다.

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

매개 변수

반환

Topic 및 해당 속성을 나타내는 개체를 반환합니다. 구독 수 세부 정보와 같은 토픽 런타임 정보를 얻으려면 API를 사용합니다 getTopicRuntimeProperties .

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

매개 변수

반환

구독 수와 같은 토픽 런타임 정보를 나타내는 개체를 반환합니다.

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

매개 변수

반환

모든 큐를 나열하는 비동기 반복기를 반환합니다.

.byPage()는 비동기 반복 반복기를 반환하여 페이지에 큐를 나열합니다.

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

매개 변수

반환

페이징을 지원하는 asyncIterableIterator입니다.

비동기 반복 반복기를 반환하여 큐의 런타임 정보를 나열합니다.

.byPage()는 비동기 반복 반복기를 반환하여 페이지에 있는 큐의 런타임 정보를 나열합니다.

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

매개 변수

반환

페이징을 지원하는 asyncIterableIterator입니다.

지정된 구독의 모든 규칙을 나열하는 비동기 반복기를 반환합니다.

.byPage()는 비동기 반복 반복기를 반환하여 페이지에 규칙을 나열합니다.

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

매개 변수

반환

페이징을 지원하는 asyncIterableIterator입니다.

지정된 항목 아래의 모든 구독을 나열하는 비동기 반복기를 반환합니다.

.byPage()는 비동기 반복 반복기를 반환하여 페이지에 구독을 나열합니다.

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

매개 변수

반환

페이징을 지원하는 asyncIterableIterator입니다.

지정된 항목에서 구독의 런타임 정보를 나열하는 비동기 반복기를 반환합니다.

.byPage()는 비동기 반복 반복기를 반환하여 페이지에 구독의 런타임 정보를 나열합니다.

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

매개 변수

반환

페이징을 지원하는 asyncIterableIterator입니다.

모든 항목을 나열하는 비동기 반복기 를 반환합니다.

.byPage()는 페이지에 항목을 나열하는 비동기 반복기를 반환합니다.

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

매개 변수

반환

페이징을 지원하는 asyncIterableIterator입니다.

토픽의 런타임 정보를 나열하는 비동기 반복기를 반환합니다.

.byPage()는 페이지에서 토픽의 런타임 정보를 나열하는 비동기 반복기를 반환합니다.

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

매개 변수

반환

페이징을 지원하는 asyncIterableIterator입니다.

지정된 큐가 있는지 여부를 확인합니다.

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

매개 변수

반환

지정된 규칙이 있는지 여부를 확인합니다.

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

매개 변수

반환

지정된 구독이 토픽에 있는지 여부를 확인합니다.

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

매개 변수

반환

지정된 토픽이 있는지 여부를 확인합니다.

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

매개 변수

반환

제공된 큐 속성을 기반으로 큐를 업데이트. 모든 큐 속성은 하위 집합만 실제로 업다이팅할 수 있더라도 설정해야 합니다. 따라서 제안된 흐름은 의 getQueue()출력을 사용하여 원하는 속성을 업데이트한 다음 수정된 개체를 에 전달하는 것입니다 updateQueue().

업데이트할 수 없는 속성은 인터페이스에서 QueueProperties 읽기 전용으로 표시됩니다.

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

매개 변수

반환

지정된 옵션에 따라 지정된 이름으로 규칙의 속성을 업데이트. 규칙 속성 중 하나가 업데이트되더라도 모든 규칙 속성을 설정해야 합니다. 따라서 제안된 흐름은 의 getRule()출력을 사용하여 원하는 속성을 업데이트한 다음 수정된 개체를 에 전달하는 것입니다 updateRule().

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

매개 변수

반환

제공된 구독 속성을 기반으로 구독을 업데이트. 모든 구독 속성은 하위 집합만 실제로 업다이팅할 수 있더라도 설정해야 합니다. 따라서 제안된 흐름은 의 getSubscription()출력을 사용하여 원하는 속성을 업데이트한 다음 수정된 개체를 에 전달하는 것입니다 updateSubscription().

업데이트할 수 없는 속성은 인터페이스에서 SubscriptionProperties 읽기 전용으로 표시됩니다.

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

매개 변수

반환

제공된 토픽 속성을 기반으로 토픽을 업데이트. 모든 토픽 속성은 해당 항목의 하위 집합만 실제로 업다이팅할 수 있더라도 설정해야 합니다. 따라서 제안된 흐름은 의 getTopic()출력을 사용하여 원하는 속성을 업데이트한 다음 수정된 개체를 에 전달하는 것입니다 updateTopic().

업데이트할 수 없는 속성은 인터페이스에서 TopicProperties 읽기 전용으로 표시됩니다.

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

매개 변수

반환

제공된 OperationSpec을 사용하여 채워진 HTTP 요청을 보냅니다.

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

매개 변수

반환

상속된 From ServiceClient.sendOperationRequest

제공된 httpRequest를 보냅니다.

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

매개 변수

반환

상속된 From ServiceClient.sendRequest