ServiceBusAdministrationClient 클래스
이 클라이언트를 사용하여 ServiceBus 네임스페이스의 리소스를 만들고, 업데이트하고, 나열하고, 삭제할 수 있습니다.
- 상속
-
builtins.objectServiceBusAdministrationClient
생성자
ServiceBusAdministrationClient(fully_qualified_namespace: str, credential: TokenCredential, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any)
매개 변수
- credential
- <xref:TokenCredential>
인증하여 ServiceBus 네임스페이스의 엔터티를 관리합니다.
- api_version
- str 또는 ApiVersion
요청에 사용할 Service Bus API 버전입니다. 기본값은 현재 SDK와 호환되는 최신 서비스 버전입니다. 이전 버전으로 설정하면 기능 호환성이 저하될 수 있습니다.
메서드
close | |
create_queue |
큐를 만듭니다. |
create_rule |
토픽 구독에 대한 규칙을 만듭니다. |
create_subscription |
토픽 구독을 만듭니다. |
create_topic |
토픽을 만듭니다. |
delete_queue |
큐를 삭제합니다. |
delete_rule |
토픽 구독 규칙을 삭제합니다. |
delete_subscription |
토픽 구독을 삭제합니다. |
delete_topic |
토픽을 삭제합니다. |
from_connection_string |
연결 문자열에서 클라이언트를 만듭니다. |
get_namespace_properties |
네임스페이스 속성 가져오기 |
get_queue |
큐의 속성을 가져옵니다. |
get_queue_runtime_properties |
큐의 런타임 정보를 가져옵니다. |
get_rule |
토픽 구독 규칙의 속성을 가져옵니다. |
get_subscription |
토픽 구독의 속성을 가져옵니다. |
get_subscription_runtime_properties |
토픽 구독 런타임 정보를 가져옵니다. |
get_topic |
토픽의 속성을 가져옵니다. |
get_topic_runtime_properties |
토픽의 런타임 정보를 가져옵니다. |
list_queues |
ServiceBus 네임스페이스의 큐를 나열합니다. |
list_queues_runtime_properties |
ServiceBus 네임스페이스에 있는 큐의 런타임 정보를 나열합니다. |
list_rules |
토픽 구독의 규칙을 나열합니다. |
list_subscriptions |
ServiceBus 토픽의 구독을 나열합니다. |
list_subscriptions_runtime_properties |
ServiceBus 토픽의 구독 런타임 정보를 나열합니다. |
list_topics |
ServiceBus 네임스페이스의 topics 나열합니다. |
list_topics_runtime_properties |
ServiceBus 네임스페이스의 topics 런타임 정보를 나열합니다. |
update_queue |
큐를 업데이트합니다. 이 메서드를 호출하기 전에 get_queue, create_queue 또는 list_queues 사용하여 QueueProperties instance 가져와 속성을 업데이트해야 합니다. 속성의 일부만 업데이트할 수 있습니다. https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue을 참조하세요. property_name=<property_value 형식으로 속성을 업데이트하기 위한 키워드(keyword)>> 인수를 전달할 수도 있습니다. 이 인수는 QueueProperties instance 지정된 항목을 재정의<합니다. 속성 이름은 ~azure.servicebus.management.QueueProperties를 참조하세요. |
update_rule |
규칙을 업데이트합니다. 이 메서드를 호출하기 전에 get_rule, create_rule 또는 list_rules 사용하여 RuleProperties instance 가져와 속성을 업데이트해야 합니다. RuleProperties instance 지정된 항목을 재정의하는 property_name>=<property_value> 형식으로< 속성을 업데이트하기 위한 키워드(keyword) 인수를 전달할 수도 있습니다. 속성 이름은 ~azure.servicebus.management.RuleProperties를 참조하세요. |
update_subscription |
구독을 업데이트합니다. 이 메서드를 호출하기 전에 get_subscription, update_subscription 또는 list_subscription 사용하여 SubscriptionProperties instance 다운로드 한 다음 속성을 업데이트해야 합니다. subscriptionProperties instance 지정된 내용을 재정의하는 property_name>=<property_value> 형식으로< 속성을 업데이트하기 위한 키워드(keyword) 인수를 전달할 수도 있습니다. 속성 이름은 ~azure.servicebus.management.SubscriptionProperties를 참조하세요. |
update_topic |
토픽을 업데이트합니다. 이 메서드를 호출하기 전에 get_topic, create_topic 또는 list_topics 사용하여 TopicProperties instance 다운로드한 다음 속성을 업데이트해야 합니다. 속성의 일부만 업데이트할 수 있습니다. https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic을 참조하세요. property_name=<property_value 형식으로 속성을 업데이트하기 위한 키워드(keyword)> 인수를 전달하여 TopicProperties instance> 지정된 항목을 재정의<할 수도 있습니다. 속성 이름은 ~azure.servicebus.management.TopicProperties를 참조하세요. |
close
close() -> None
create_queue
큐를 만듭니다.
create_queue(queue_name: str, *, authorization_rules: List[AuthorizationRule] | None = None, auto_delete_on_idle: timedelta | str | None = None, dead_lettering_on_message_expiration: bool | None = None, default_message_time_to_live: timedelta | str | None = None, duplicate_detection_history_time_window: timedelta | str | None = None, enable_batched_operations: bool | None = None, enable_express: bool | None = None, enable_partitioning: bool | None = None, lock_duration: timedelta | str | None = None, max_delivery_count: int | None = None, max_size_in_megabytes: int | None = None, requires_duplicate_detection: bool | None = None, requires_session: bool | None = None, forward_to: str | None = None, user_metadata: str | None = None, forward_dead_lettered_messages_to: str | None = None, max_message_size_in_kilobytes: int | None = None, **kwargs: Any) -> QueueProperties
매개 변수
- authorization_rules
- list[AuthorizationRule]
리소스에 대한 권한 부여 규칙입니다.
ISO 8601 timeSpan 유휴 간격 후 큐가 자동으로 삭제됩니다. 최소 기간은 5분입니다. "PT300S"와 같은 ISO 8601 기간 형식의 ~datetime.timedelta 형식 또는 문자열의 입력 값이 허용됩니다.
- dead_lettering_on_message_expiration
- bool
메시지가 만료되면 이 큐에 배달 못 한 편지 지원이 있는지 여부를 나타내는 값입니다.
ISO 8601 기본 메시지 시간 범위를 라이브 값으로 설정합니다. 메시지가 Service Bus로 전송되는 시점부터 시작하여 메시지가 만료되는 기간입니다. TimeToLive가 메시지 자체에 설정되지 않은 경우 사용되는 기본값입니다. "PT300S"와 같은 ISO 8601 기간 형식의 ~datetime.timedelta 형식 또는 문자열의 입력 값이 허용됩니다.
중복 검색 기록의 기간을 정의하는 ISO 8601 timeSpan 구조체입니다. 기본값은 10분입니다. "PT300S"와 같은 ISO 8601 기간 형식의 ~datetime.timedelta 형식 또는 문자열의 입력 값이 허용됩니다.
- enable_batched_operations
- bool
서버 쪽 일괄 처리 작업을 사용할 수 있는지 여부를 나타내는 값입니다.
- enable_express
- bool
Express 엔터티를 사용할 수 있는지 여부를 나타내는 값입니다. 빠른 큐는 영구 스토리지에 쓰기 전에 일시적으로 메모리에 메시지를 보관합니다.
- enable_partitioning
- bool
큐를 여러 메시지 브로커 간에 분할할지 여부를 나타내는 값입니다.
피킹 잠금의 ISO 8601 시간 범위 기간; 즉, 다른 수신기에 대해 메시지가 잠긴 시간입니다. LockDuration의 최대값은 5분입니다. 기본값은 1분입니다. "PT300S"와 같은 ISO 8601 기간 형식의 ~datetime.timedelta 형식 또는 문자열의 입력 값이 허용됩니다.
- max_delivery_count
- int
최대 배달 수입니다. 메시지는 이 배달 횟수가 지난 후 자동으로 배달 못한 편지로 설정됩니다. 기본값은 10입니다.
- max_size_in_megabytes
- int
큐의 최대 크기(MB)로, 큐에 할당된 메모리 크기입니다.
- requires_duplicate_detection
- bool
이 큐에 중복 검색이 필요한지 여부를 나타내는 값입니다.
- requires_session
- bool
큐가 세션 개념을 지원하는지 여부를 나타내는 값입니다.
- forward_to
- str
큐에 전송된 모든 메시지가 전달되는 받는 사람 엔터티의 이름입니다.
- user_metadata
- str
사용자가 설명과 연결할 수 있는 사용자 지정 metdata입니다. 최대 길이는 1024자입니다.
- forward_dead_lettered_messages_to
- str
이 구독의 배달 못한 편지 메시지를 모두 전달할 받는 사람 엔터티의 이름입니다.
- max_message_size_in_kilobytes
- int
큐에서 수락할 수 있는 메시지 페이로드의 최대 크기(킬로바이트)입니다. 이 기능은 프리미엄 네임스페이스 및 Service Bus API 버전 "2021-05" 이상을 사용하는 경우에만 사용할 수 있습니다. 허용되는 최소값은 1024이고 허용되는 최대 값은 102400입니다. 기본값은 1024입니다.
반환 형식
create_rule
토픽 구독에 대한 규칙을 만듭니다.
create_rule(topic_name: str, subscription_name: str, rule_name: str, *, filter: ~azure.servicebus.management._models.CorrelationRuleFilter | ~azure.servicebus.management._models.SqlRuleFilter = <azure.servicebus.management._models.TrueRuleFilter object>, action: ~azure.servicebus.management._models.SqlRuleAction | None = None, **kwargs: ~typing.Any) -> RuleProperties
매개 변수
- filter
- Union[CorrelationRuleFilter, SqlRuleFilter]
규칙의 필터입니다. 기본값은 ~azure.servicebus.management.TrueRuleFilter입니다.
- action
- Optional[SqlRuleAction]
규칙의 동작입니다.
반환 형식
create_subscription
토픽 구독을 만듭니다.
create_subscription(topic_name: str, subscription_name: str, *, lock_duration: timedelta | str | None = None, requires_session: bool | None = None, default_message_time_to_live: timedelta | str | None = None, dead_lettering_on_message_expiration: bool | None = None, dead_lettering_on_filter_evaluation_exceptions: bool | None = None, max_delivery_count: int | None = None, enable_batched_operations: bool | None = None, forward_to: str | None = None, user_metadata: str | None = None, forward_dead_lettered_messages_to: str | None = None, auto_delete_on_idle: timedelta | str | None = None, **kwargs: Any) -> SubscriptionProperties
매개 변수
피킹 잠금의 ISO 8601 시간 범위 기간; 즉, 다른 수신기에 대해 메시지가 잠긴 시간입니다. LockDuration의 최대값은 5분입니다. 기본값은 1분입니다. "PT300S"와 같은 ISO 8601 기간 형식의 ~datetime.timedelta 형식 또는 문자열의 입력 값이 허용됩니다.
- requires_session
- bool
큐가 세션 개념을 지원하는지 여부를 나타내는 값입니다.
ISO 8601 기본 메시지 시간 범위를 라이브 값으로 설정합니다. 메시지가 Service Bus로 전송되는 시점부터 시작하여 메시지가 만료되는 기간입니다. TimeToLive가 메시지 자체에 설정되지 않은 경우 사용되는 기본값입니다. "PT300S"와 같은 ISO 8601 기간 형식의 ~datetime.timedelta 형식 또는 문자열의 입력 값이 허용됩니다.
- dead_lettering_on_message_expiration
- bool
메시지가 만료되면 이 구독에 배달 못 한 편지 지원이 있는지 여부를 나타내는 값입니다.
- dead_lettering_on_filter_evaluation_exceptions
- bool
메시지가 만료되면 이 구독에 배달 못 한 편지 지원이 있는지 여부를 나타내는 값입니다.
- max_delivery_count
- int
최대 배달 수입니다. 메시지는 이 배달 횟수가 지난 후 자동으로 배달 못한 편지로 설정됩니다. 기본값은 10입니다.
- enable_batched_operations
- bool
서버 쪽 일괄 처리 작업을 사용할 수 있는지 여부를 나타내는 값입니다.
- forward_to
- str
구독으로 전송된 모든 메시지가 전달되는 받는 사람 엔터티의 이름입니다.
- user_metadata
- str
구독과 연결된 메타데이터입니다. 최대 문자 수는 1,024자입니다.
- forward_dead_lettered_messages_to
- str
구독으로 전송된 모든 메시지가 전달되는 받는 사람 엔터티의 이름입니다.
ISO 8601 timeSpan 유휴 간격 이후에 구독이 자동으로 삭제됩니다. 최소 기간은 5분입니다. "PT300S"와 같은 ISO 8601 기간 형식의 ~datetime.timedelta 형식 또는 문자열의 입력 값이 허용됩니다.
반환 형식
create_topic
토픽을 만듭니다.
create_topic(topic_name: str, *, default_message_time_to_live: timedelta | str | None = None, max_size_in_megabytes: int | None = None, requires_duplicate_detection: bool | None = None, duplicate_detection_history_time_window: timedelta | str | None = None, enable_batched_operations: bool | None = None, size_in_bytes: int | None = None, filtering_messages_before_publishing: bool | None = None, authorization_rules: List[AuthorizationRule] | None = None, support_ordering: bool | None = None, auto_delete_on_idle: timedelta | str | None = None, enable_partitioning: bool | None = None, enable_express: bool | None = None, user_metadata: str | None = None, max_message_size_in_kilobytes: int | None = None, **kwargs: Any) -> TopicProperties
매개 변수
ISO 8601 기본 메시지 시간 범위를 라이브 값으로 설정합니다. 메시지가 Service Bus로 전송되는 시점부터 시작하여 메시지가 만료되는 기간입니다. TimeToLive가 메시지 자체에 설정되지 않은 경우 사용되는 기본값입니다. "PT300S"와 같은 ISO 8601 기간 형식의 ~datetime.timedelta 형식 또는 문자열의 입력 값이 허용됩니다.
- max_size_in_megabytes
- int
토픽의 최대 크기(토픽에 할당된 메모리 크기)입니다.
- requires_duplicate_detection
- bool
이 항목에 중복 검색이 필요한지 여부를 나타내는 값입니다.
중복 검색 기록의 기간을 정의하는 ISO 8601 timeSpan 구조체입니다. 기본값은 10분입니다. "PT300S"와 같은 ISO 8601 기간 형식의 ~datetime.timedelta 형식 또는 문자열의 입력 값이 허용됩니다.
- enable_batched_operations
- bool
서버 쪽 일괄 처리 작업을 사용할 수 있는지 여부를 나타내는 값입니다.
- size_in_bytes
- int
토픽의 크기(바이트)입니다.
- filtering_messages_before_publishing
- bool
게시하기 전에 메시지를 필터링합니다.
- authorization_rules
- list[AuthorizationRule]
리소스에 대한 권한 부여 규칙입니다.
- support_ordering
- bool
토픽이 순서 지정을 지원하는지 여부를 나타내는 값입니다.
ISO 8601 timeSpan 유휴 간격 이후에 토픽이 자동으로 삭제됩니다. 최소 기간은 5분입니다. "PT300S"와 같은 ISO 8601 기간 형식의 ~datetime.timedelta 형식 또는 문자열의 입력 값이 허용됩니다.
- enable_partitioning
- bool
토픽을 여러 메시지 브로커 간에 분할할지 여부를 나타내는 값입니다.
- enable_express
- bool
Express 엔터티를 사용할 수 있는지 여부를 나타내는 값입니다. 빠른 큐는 영구 스토리지에 쓰기 전에 일시적으로 메모리에 메시지를 보관합니다.
- user_metadata
- str
토픽과 연결된 메타데이터입니다.
- max_message_size_in_kilobytes
- int
큐에서 수락할 수 있는 메시지 페이로드의 최대 크기(킬로바이트)입니다. 이 기능은 프리미엄 네임스페이스 및 Service Bus API 버전 "2021-05" 이상을 사용하는 경우에만 사용할 수 있습니다. 허용되는 최소값은 1024이고 허용되는 최대 값은 102400입니다. 기본값은 1024입니다.
반환 형식
delete_queue
큐를 삭제합니다.
delete_queue(queue_name: str, **kwargs: Any) -> None
매개 변수
반환 형식
delete_rule
토픽 구독 규칙을 삭제합니다.
delete_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> None
매개 변수
반환 형식
delete_subscription
토픽 구독을 삭제합니다.
delete_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> None
매개 변수
반환 형식
delete_topic
토픽을 삭제합니다.
delete_topic(topic_name: str, **kwargs: Any) -> None
매개 변수
반환 형식
from_connection_string
연결 문자열에서 클라이언트를 만듭니다.
from_connection_string(conn_str: str, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any) -> ServiceBusAdministrationClient
매개 변수
- api_version
- str 또는 ApiVersion
요청에 사용할 Service Bus API 버전입니다. 기본값은 현재 SDK와 호환되는 최신 서비스 버전입니다. 이전 버전으로 설정하면 기능 호환성이 저하될 수 있습니다.
반환 형식
get_namespace_properties
네임스페이스 속성 가져오기
get_namespace_properties(**kwargs: Any) -> NamespaceProperties
반환
네임스페이스 속성입니다.
반환 형식
get_queue
큐의 속성을 가져옵니다.
get_queue(queue_name: str, **kwargs: Any) -> QueueProperties
매개 변수
반환
큐의 속성입니다.
반환 형식
get_queue_runtime_properties
큐의 런타임 정보를 가져옵니다.
get_queue_runtime_properties(queue_name: str, **kwargs: Any) -> QueueRuntimeProperties
매개 변수
반환
큐의 런타임 정보입니다.
반환 형식
get_rule
토픽 구독 규칙의 속성을 가져옵니다.
get_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> RuleProperties
매개 변수
반환
지정된 규칙의 속성입니다.
반환 형식
get_subscription
토픽 구독의 속성을 가져옵니다.
get_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionProperties
매개 변수
반환
SubscriptionProperties의 instance
반환 형식
get_subscription_runtime_properties
토픽 구독 런타임 정보를 가져옵니다.
get_subscription_runtime_properties(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionRuntimeProperties
매개 변수
반환
SubscriptionRuntimeProperties의 instance
반환 형식
get_topic
토픽의 속성을 가져옵니다.
get_topic(topic_name: str, **kwargs: Any) -> TopicProperties
매개 변수
반환
토픽의 속성입니다.
반환 형식
get_topic_runtime_properties
토픽의 런타임 정보를 가져옵니다.
get_topic_runtime_properties(topic_name: str, **kwargs: Any) -> TopicRuntimeProperties
매개 변수
반환
토픽의 런타임 정보입니다.
반환 형식
list_queues
ServiceBus 네임스페이스의 큐를 나열합니다.
list_queues(**kwargs: Any) -> ItemPaged[QueueProperties]
반환
QueueProperties의 반복 가능(자동 페이징) 응답입니다.
반환 형식
list_queues_runtime_properties
ServiceBus 네임스페이스에 있는 큐의 런타임 정보를 나열합니다.
list_queues_runtime_properties(**kwargs: Any) -> ItemPaged[QueueRuntimeProperties]
반환
QueueRuntimeProperties의 반복 가능(자동 페이징) 응답입니다.
반환 형식
list_rules
토픽 구독의 규칙을 나열합니다.
list_rules(topic_name: str, subscription_name: str, **kwargs: Any) -> ItemPaged[RuleProperties]
매개 변수
반환
RuleProperties의 반복 가능(자동 페이징) 응답입니다.
반환 형식
list_subscriptions
ServiceBus 토픽의 구독을 나열합니다.
list_subscriptions(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionProperties]
매개 변수
반환
SubscriptionProperties의 반복 가능(자동 페이징) 응답입니다.
반환 형식
list_subscriptions_runtime_properties
ServiceBus 토픽의 구독 런타임 정보를 나열합니다.
list_subscriptions_runtime_properties(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionRuntimeProperties]
매개 변수
반환
SubscriptionRuntimeProperties의 반복 가능(자동 페이징) 응답입니다.
반환 형식
list_topics
ServiceBus 네임스페이스의 topics 나열합니다.
list_topics(**kwargs: Any) -> ItemPaged[TopicProperties]
반환
TopicProperties의 반복 가능(자동 페이징) 응답입니다.
반환 형식
list_topics_runtime_properties
ServiceBus 네임스페이스의 topics 런타임 정보를 나열합니다.
list_topics_runtime_properties(**kwargs: Any) -> ItemPaged[TopicRuntimeProperties]
반환
TopicRuntimeProperties의 반복 가능(자동 페이징) 응답입니다.
반환 형식
update_queue
큐를 업데이트합니다.
이 메서드를 호출하기 전에 get_queue, create_queue 또는 list_queues 사용하여 QueueProperties instance 가져와 속성을 업데이트해야 합니다. 속성의 일부만 업데이트할 수 있습니다. https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue을 참조하세요. property_name=<property_value 형식으로 속성을 업데이트하기 위한 키워드(keyword)>> 인수를 전달할 수도 있습니다. 이 인수는 QueueProperties instance 지정된 항목을 재정의<합니다. 속성 이름은 ~azure.servicebus.management.QueueProperties를 참조하세요.
update_queue(queue: QueueProperties | Mapping[str, Any], **kwargs: Any) -> None
매개 변수
반환 형식
update_rule
규칙을 업데이트합니다.
이 메서드를 호출하기 전에 get_rule, create_rule 또는 list_rules 사용하여 RuleProperties instance 가져와 속성을 업데이트해야 합니다. RuleProperties instance 지정된 항목을 재정의하는 property_name>=<property_value> 형식으로< 속성을 업데이트하기 위한 키워드(keyword) 인수를 전달할 수도 있습니다. 속성 이름은 ~azure.servicebus.management.RuleProperties를 참조하세요.
update_rule(topic_name: str, subscription_name: str, rule: RuleProperties | Mapping[str, Any], **kwargs: Any) -> None
매개 변수
반환 형식
update_subscription
구독을 업데이트합니다.
이 메서드를 호출하기 전에 get_subscription, update_subscription 또는 list_subscription 사용하여 SubscriptionProperties instance 다운로드 한 다음 속성을 업데이트해야 합니다. subscriptionProperties instance 지정된 내용을 재정의하는 property_name>=<property_value> 형식으로< 속성을 업데이트하기 위한 키워드(keyword) 인수를 전달할 수도 있습니다. 속성 이름은 ~azure.servicebus.management.SubscriptionProperties를 참조하세요.
update_subscription(topic_name: str, subscription: SubscriptionProperties | Mapping[str, Any], **kwargs: Any) -> None
매개 변수
- subscription
- SubscriptionProperties
get_subscription, update_subscription또는list_subscription 반환되고 업데이트된 속성이 있는 구독입니다.
반환 형식
update_topic
토픽을 업데이트합니다.
이 메서드를 호출하기 전에 get_topic, create_topic 또는 list_topics 사용하여 TopicProperties instance 다운로드한 다음 속성을 업데이트해야 합니다. 속성의 일부만 업데이트할 수 있습니다. https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic을 참조하세요. property_name=<property_value 형식으로 속성을 업데이트하기 위한 키워드(keyword)> 인수를 전달하여 TopicProperties instance> 지정된 항목을 재정의<할 수도 있습니다. 속성 이름은 ~azure.servicebus.management.TopicProperties를 참조하세요.
update_topic(topic: TopicProperties | Mapping[str, Any], **kwargs: Any) -> None
매개 변수
반환 형식
Azure SDK for Python