ServiceBusAdministrationClient Classe
Utilize este cliente para criar, atualizar, listar e eliminar recursos de um espaço de nomes do ServiceBus.
- Herança
-
builtins.objectServiceBusAdministrationClient
Construtor
ServiceBusAdministrationClient(fully_qualified_namespace: str, credential: TokenCredential, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any)Parâmetros
- fully_qualified_namespace
- str
O nome de anfitrião completamente qualificado para o espaço de nomes do Service Bus.
- credential
- <xref:TokenCredential>
Para autenticar para gerir as entidades do espaço de nomes do ServiceBus.
- api_version
- str ou ApiVersion
A versão da API do Service Bus a utilizar para pedidos. O valor predefinido é a versão de serviço mais recente compatível com o SDK atual. Definir para uma versão mais antiga pode resultar numa compatibilidade de funcionalidades reduzida.
Métodos
| close | |
| create_queue |
Criar uma fila. |
| create_rule |
Crie uma regra para uma subscrição de tópico. |
| create_subscription |
Criar uma subscrição de tópico. |
| create_topic |
Criar um tópico. |
| delete_queue |
Eliminar uma fila. |
| delete_rule |
Eliminar uma regra de subscrição de tópico. |
| delete_subscription |
Eliminar uma subscrição de tópico. |
| delete_topic |
Eliminar um tópico. |
| from_connection_string |
Crie um cliente a partir da cadeia de ligação. |
| get_namespace_properties |
Obter as propriedades do espaço de nomes |
| get_queue |
Obtenha as propriedades de uma fila. |
| get_queue_runtime_properties |
Obtenha as informações de runtime de uma fila. |
| get_rule |
Obtenha as propriedades de uma regra de subscrição de tópico. |
| get_subscription |
Obtenha as propriedades de uma subscrição de tópico. |
| get_subscription_runtime_properties |
Obtenha informações sobre o runtime da subscrição do tópico. |
| get_topic |
Obtenha as propriedades de um tópico. |
| get_topic_runtime_properties |
Obtenha as informações de runtime de um tópico. |
| list_queues |
Listar as filas de um espaço de nomes do ServiceBus. |
| list_queues_runtime_properties |
Liste as informações de runtime das filas num espaço de nomes do ServiceBus. |
| list_rules |
Listar as regras de uma subscrição de tópico. |
| list_subscriptions |
Liste as subscrições de um Tópico do ServiceBus. |
| list_subscriptions_runtime_properties |
Liste as informações de runtime das subscrições de um Tópico do ServiceBus. |
| list_topics |
Liste os tópicos de um espaço de nomes do ServiceBus. |
| list_topics_runtime_properties |
Liste as informações de runtime de tópicos de um espaço de nomes do ServiceBus. |
| update_queue |
Atualizar uma fila. Antes de chamar este método, deve utilizar get_queue, create_queue ou list_queues para obter uma instância QueueProperties e, em seguida, atualizar as propriedades. Apenas uma parte das propriedades pode ser atualizada. https://docs.microsoft.com/en-us/rest/api/servicebus/update-queueVeja . Também pode transmitir argumentos de palavra-chave para atualizar propriedades sob a forma de <property_name>=<property_value> que substituirão o que foi especificado na instância QueueProperties . Consulte ~azure.servicebus.management.QueueProperties para obter nomes de propriedades. |
| update_rule |
Atualizar uma regra. Antes de chamar este método, deve utilizar get_rule, create_rule ou list_rules para obter uma instância RuleProperties e, em seguida, atualizar as propriedades. Também pode transmitir argumentos de palavra-chave para atualizar propriedades sob a forma de <property_name>=<property_value> que substituirão o que foi especificado na instância RuleProperties . Consulte ~azure.servicebus.management.RuleProperties para obter nomes de propriedades. |
| update_subscription |
Atualizar uma subscrição. Antes de chamar este método, deve utilizar get_subscription, update_subscription ou list_subscription para obter uma instância SubscriptionProperties e, em seguida, atualizar as propriedades. Também pode transmitir argumentos de palavra-chave para atualizar propriedades sob a forma de <property_name>=<property_value> que substituirão o que foi especificado na instância SubscriptionProperties . Consulte ~azure.servicebus.management.SubscriptionProperties para obter nomes de propriedades. |
| update_topic |
Atualizar um tópico. Antes de chamar este método, deve utilizar get_topic, create_topic ou list_topics para obter uma instância TopicProperties e, em seguida, atualizar as propriedades. Apenas uma parte das propriedades pode ser atualizada. https://docs.microsoft.com/en-us/rest/api/servicebus/update-topicVeja . Também pode transmitir argumentos de palavra-chave para atualizar propriedades sob a forma de <property_name>=<property_value> que substituirão o que foi especificado na instância TopicProperties . Consulte ~azure.servicebus.management.TopicProperties para obter nomes de propriedades. |
close
close() -> Nonecreate_queue
Criar uma fila.
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) -> QueuePropertiesParâmetros
- authorization_rules
- list[AuthorizationRule]
Regras de autorização para o recurso.
ISO 8601 timeSpan idle interval after which the queue is automatically deleted. A duração mínima é 5 minutos. O valor de entrada do tipo ~datetime.timedelta ou da cadeia no formato de duração ISO 8601, como "PT300S" é aceite.
- dead_lettering_on_message_expiration
- bool
Um valor que indica se esta fila tem suporte para mensagens não entregues quando uma mensagem expira.
ISO 8601 período de tempo de mensagem predefinido para valor ativo. Esta é a duração após a qual a mensagem expira, começando a partir do momento em que a mensagem é enviada para o Service Bus. Este é o valor predefinido utilizado quando TimeToLive não está definido numa mensagem propriamente dita. O valor de entrada do tipo ~datetime.timedelta ou da cadeia no formato de duração ISO 8601, como "PT300S" é aceite.
IsO 8601 timeSpan structure that define the duration of the duplicate detection history. O valor predefinido é 10 minutos. O valor de entrada do tipo ~datetime.timedelta ou da cadeia no formato de duração ISO 8601, como "PT300S" é aceite.
- enable_batched_operations
- bool
Valor que indica se as operações em lotes do lado do servidor estão ativadas.
- enable_express
- bool
Um valor que indica se as Entidades Express estão ativadas. Uma fila rápida contém temporariamente uma mensagem na memória antes de a escrever no armazenamento persistente.
- enable_partitioning
- bool
Um valor que indica se a fila deve ser particionada em vários mediadores de mensagens.
ISO 8601 duração do intervalo de tempo de um bloqueio de pré-visualização; ou seja, a quantidade de tempo que a mensagem está bloqueada para outros recetores. O valor máximo para LockDuration é de 5 minutos; o valor predefinido é 1 minuto. O valor de entrada do tipo ~datetime.timedelta ou da cadeia no formato de duração ISO 8601, como "PT300S" é aceite.
- max_delivery_count
- int
O número máximo de entregas. Uma mensagem é automaticamente inativa após este número de entregas. O valor predefinido é 10.
- max_size_in_megabytes
- int
O tamanho máximo da fila em megabytes, que é o tamanho da memória alocada para a fila.
- requires_duplicate_detection
- bool
Um valor que indica se esta fila requer deteção de duplicados.
- requires_session
- bool
Um valor que indica se a fila suporta o conceito de sessões.
- forward_to
- str
O nome da entidade do destinatário para a qual todas as mensagens enviadas para a fila são reencaminhadas.
- user_metadata
- str
Metdata personalizado que o utilizador pode associar à descrição. O comprimento máximo é de 1024 carateres.
- forward_dead_lettered_messages_to
- str
O nome da entidade do destinatário para a qual todas as mensagens não entregues desta subscrição são reencaminhadas.
- max_message_size_in_kilobytes
- int
O tamanho máximo em quilobytes do payload de mensagens que pode ser aceite pela fila. Esta funcionalidade só está disponível quando utiliza um espaço de nomes Premium e a versão da API do Service Bus "2021-05" ou superior. O valor mínimo permitido é 1024, enquanto o valor máximo permitido é 102400. O valor predefinido é 1024.
Tipo de retorno
create_rule
Crie uma regra para uma subscrição de tópico.
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) -> RulePropertiesParâmetros
- filter
- Union[CorrelationRuleFilter, SqlRuleFilter]
O filtro da regra. O valor predefinido é ~azure.servicebus.management.TrueRuleFilter
- action
- Optional[SqlRuleAction]
A ação da regra.
Tipo de retorno
create_subscription
Criar uma subscrição de tópico.
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) -> SubscriptionPropertiesParâmetros
ISO 8601 duração do intervalo de tempo de um bloqueio de pré-visualização; ou seja, a quantidade de tempo que a mensagem está bloqueada para outros recetores. O valor máximo para LockDuration é de 5 minutos; o valor predefinido é 1 minuto. O valor de entrada do tipo ~datetime.timedelta ou da cadeia no formato de duração ISO 8601, como "PT300S" é aceite.
- requires_session
- bool
Um valor que indica se a fila suporta o conceito de sessões.
ISO 8601 período de tempo de mensagem predefinido para valor ativo. Esta é a duração após a qual a mensagem expira, começando a partir do momento em que a mensagem é enviada para o Service Bus. Este é o valor predefinido utilizado quando TimeToLive não está definido numa mensagem propriamente dita. O valor de entrada do tipo ~datetime.timedelta ou da cadeia no formato de duração ISO 8601, como "PT300S" é aceite.
- dead_lettering_on_message_expiration
- bool
Um valor que indica se esta subscrição tem suporte de mensagens não entregues quando uma mensagem expira.
- dead_lettering_on_filter_evaluation_exceptions
- bool
Um valor que indica se esta subscrição tem suporte de mensagens não entregues quando uma mensagem expira.
- max_delivery_count
- int
O número máximo de entregas. Uma mensagem é automaticamente inativa após este número de entregas. O valor predefinido é 10.
- enable_batched_operations
- bool
Valor que indica se as operações em lotes do lado do servidor estão ativadas.
- forward_to
- str
O nome da entidade do destinatário para a qual todas as mensagens enviadas para a subscrição são reencaminhadas.
- user_metadata
- str
Metadados associados à subscrição. O número máximo de carateres é 1024.
- forward_dead_lettered_messages_to
- str
O nome da entidade do destinatário para a qual todas as mensagens enviadas para a subscrição são reencaminhadas.
Intervalo de inatividade iso 8601 timeSpan após o qual a subscrição é eliminada automaticamente. A duração mínima é 5 minutos. O valor de entrada do tipo ~datetime.timedelta ou da cadeia no formato de duração ISO 8601, como "PT300S" é aceite.
Tipo de retorno
create_topic
Criar um tópico.
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) -> TopicPropertiesParâmetros
ISO 8601 período de tempo de mensagem predefinido para valor ativo. Esta é a duração após a qual a mensagem expira, começando a partir do momento em que a mensagem é enviada para o Service Bus. Este é o valor predefinido utilizado quando TimeToLive não está definido numa mensagem propriamente dita. O valor de entrada do tipo ~datetime.timedelta ou da cadeia no formato de duração ISO 8601, como "PT300S" é aceite.
- max_size_in_megabytes
- int
O tamanho máximo do tópico em megabytes, que é o tamanho da memória alocada para o tópico.
- requires_duplicate_detection
- bool
Um valor que indica se este tópico requer deteção de duplicados.
IsO 8601 timeSpan structure that define the duration of the duplicate detection history. O valor predefinido é 10 minutos. O valor de entrada do tipo ~datetime.timedelta ou da cadeia no formato de duração ISO 8601, como "PT300S" é aceite.
- enable_batched_operations
- bool
Valor que indica se as operações em lotes do lado do servidor estão ativadas.
- size_in_bytes
- int
O tamanho do tópico, em bytes.
- filtering_messages_before_publishing
- bool
Filtrar mensagens antes de publicar.
- authorization_rules
- list[AuthorizationRule]
Regras de autorização para o recurso.
- support_ordering
- bool
Um valor que indica se o tópico suporta a ordenação.
IsO 8601 timeSpan idle interval after which the topic is automatically deleted. A duração mínima é 5 minutos. O valor de entrada do tipo ~datetime.timedelta ou da cadeia no formato de duração ISO 8601, como "PT300S" é aceite.
- enable_partitioning
- bool
Um valor que indica se o tópico deve ser particionado em vários mediadores de mensagens.
- enable_express
- bool
Um valor que indica se as Entidades Express estão ativadas. Uma fila rápida contém temporariamente uma mensagem na memória antes de a escrever no armazenamento persistente.
- user_metadata
- str
Metadados associados ao tópico.
- max_message_size_in_kilobytes
- int
O tamanho máximo em quilobytes do payload de mensagens que pode ser aceite pela fila. Esta funcionalidade só está disponível quando utiliza um espaço de nomes Premium e a versão da API do Service Bus "2021-05" ou superior. O valor mínimo permitido é 1024, enquanto o valor máximo permitido é 102400. O valor predefinido é 1024.
Tipo de retorno
delete_queue
Eliminar uma fila.
delete_queue(queue_name: str, **kwargs: Any) -> NoneParâmetros
Tipo de retorno
delete_rule
Eliminar uma regra de subscrição de tópico.
delete_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> NoneParâmetros
Tipo de retorno
delete_subscription
Eliminar uma subscrição de tópico.
delete_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> NoneParâmetros
Tipo de retorno
delete_topic
Eliminar um tópico.
delete_topic(topic_name: str, **kwargs: Any) -> NoneParâmetros
Tipo de retorno
from_connection_string
Crie um cliente a partir da cadeia de ligação.
from_connection_string(conn_str: str, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any) -> ServiceBusAdministrationClientParâmetros
- api_version
- str ou ApiVersion
A versão da API do Service Bus a utilizar para pedidos. O valor predefinido é a versão de serviço mais recente compatível com o SDK atual. Definir para uma versão mais antiga pode resultar numa compatibilidade de funcionalidades reduzida.
Tipo de retorno
get_namespace_properties
Obter as propriedades do espaço de nomes
get_namespace_properties(**kwargs: Any) -> NamespacePropertiesDevoluções
As propriedades do espaço de nomes.
Tipo de retorno
get_queue
Obtenha as propriedades de uma fila.
get_queue(queue_name: str, **kwargs: Any) -> QueuePropertiesParâmetros
Devoluções
As propriedades da fila.
Tipo de retorno
get_queue_runtime_properties
Obtenha as informações de runtime de uma fila.
get_queue_runtime_properties(queue_name: str, **kwargs: Any) -> QueueRuntimePropertiesParâmetros
Devoluções
As informações de runtime da fila.
Tipo de retorno
get_rule
Obtenha as propriedades de uma regra de subscrição de tópico.
get_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> RulePropertiesParâmetros
Devoluções
As propriedades da regra especificada.
Tipo de retorno
get_subscription
Obtenha as propriedades de uma subscrição de tópico.
get_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionPropertiesParâmetros
Devoluções
Uma instância de SubscriptionProperties
Tipo de retorno
get_subscription_runtime_properties
Obtenha informações sobre o runtime da subscrição do tópico.
get_subscription_runtime_properties(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionRuntimePropertiesParâmetros
Devoluções
Uma instância de SubscriptionRuntimeProperties
Tipo de retorno
get_topic
Obtenha as propriedades de um tópico.
get_topic(topic_name: str, **kwargs: Any) -> TopicPropertiesParâmetros
Devoluções
As propriedades do tópico.
Tipo de retorno
get_topic_runtime_properties
Obtenha as informações de runtime de um tópico.
get_topic_runtime_properties(topic_name: str, **kwargs: Any) -> TopicRuntimePropertiesParâmetros
Devoluções
As informações de runtime do tópico.
Tipo de retorno
list_queues
Listar as filas de um espaço de nomes do ServiceBus.
list_queues(**kwargs: Any) -> ItemPaged[QueueProperties]Devoluções
Uma resposta iterável (paginação automática) de QueueProperties.
Tipo de retorno
list_queues_runtime_properties
Liste as informações de runtime das filas num espaço de nomes do ServiceBus.
list_queues_runtime_properties(**kwargs: Any) -> ItemPaged[QueueRuntimeProperties]Devoluções
Uma resposta iterável (paginação automática) de QueueRuntimeProperties.
Tipo de retorno
list_rules
Listar as regras de uma subscrição de tópico.
list_rules(topic_name: str, subscription_name: str, **kwargs: Any) -> ItemPaged[RuleProperties]Parâmetros
Devoluções
Uma resposta iterável (paginação automática) de RuleProperties.
Tipo de retorno
list_subscriptions
Liste as subscrições de um Tópico do ServiceBus.
list_subscriptions(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionProperties]Parâmetros
Devoluções
Uma resposta iterável (paginação automática) de SubscriptionProperties.
Tipo de retorno
list_subscriptions_runtime_properties
Liste as informações de runtime das subscrições de um Tópico do ServiceBus.
list_subscriptions_runtime_properties(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionRuntimeProperties]Parâmetros
Devoluções
Uma resposta iterável (paginação automática) de SubscriptionRuntimeProperties.
Tipo de retorno
list_topics
Liste os tópicos de um espaço de nomes do ServiceBus.
list_topics(**kwargs: Any) -> ItemPaged[TopicProperties]Devoluções
Uma resposta iterável (paginação automática) de TopicProperties.
Tipo de retorno
list_topics_runtime_properties
Liste as informações de runtime de tópicos de um espaço de nomes do ServiceBus.
list_topics_runtime_properties(**kwargs: Any) -> ItemPaged[TopicRuntimeProperties]Devoluções
Uma resposta iterável (paginação automática) de TopicRuntimeProperties.
Tipo de retorno
update_queue
Atualizar uma fila.
Antes de chamar este método, deve utilizar get_queue, create_queue ou list_queues para obter uma instância QueueProperties e, em seguida, atualizar as propriedades. Apenas uma parte das propriedades pode ser atualizada. https://docs.microsoft.com/en-us/rest/api/servicebus/update-queueVeja . Também pode transmitir argumentos de palavra-chave para atualizar propriedades sob a forma de <property_name>=<property_value> que substituirão o que foi especificado na instância QueueProperties . Consulte ~azure.servicebus.management.QueueProperties para obter nomes de propriedades.
update_queue(queue: QueueProperties | Mapping[str, Any], **kwargs: Any) -> NoneParâmetros
- queue
- QueueProperties
A fila devolvida a partir de get_queue, create_queue ou list_queues e tem as propriedades atualizadas.
Tipo de retorno
update_rule
Atualizar uma regra.
Antes de chamar este método, deve utilizar get_rule, create_rule ou list_rules para obter uma instância RuleProperties e, em seguida, atualizar as propriedades. Também pode transmitir argumentos de palavra-chave para atualizar propriedades sob a forma de <property_name>=<property_value> que substituirão o que foi especificado na instância RuleProperties . Consulte ~azure.servicebus.management.RuleProperties para obter nomes de propriedades.
update_rule(topic_name: str, subscription_name: str, rule: RuleProperties | Mapping[str, Any], **kwargs: Any) -> NoneParâmetros
- rule
- RuleProperties
A regra devolvida a partir de get_rule, create_rule ou list_rules e tem as propriedades atualizadas.
Tipo de retorno
update_subscription
Atualizar uma subscrição.
Antes de chamar este método, deve utilizar get_subscription, update_subscription ou list_subscription para obter uma instância SubscriptionProperties e, em seguida, atualizar as propriedades. Também pode transmitir argumentos de palavra-chave para atualizar propriedades sob a forma de <property_name>=<property_value> que substituirão o que foi especificado na instância SubscriptionProperties . Consulte ~azure.servicebus.management.SubscriptionProperties para obter nomes de propriedades.
update_subscription(topic_name: str, subscription: SubscriptionProperties | Mapping[str, Any], **kwargs: Any) -> NoneParâmetros
- subscription
- SubscriptionProperties
A subscrição devolvida a partir de get_subscription, update_subscription ou list_subscription e tem as propriedades atualizadas.
Tipo de retorno
update_topic
Atualizar um tópico.
Antes de chamar este método, deve utilizar get_topic, create_topic ou list_topics para obter uma instância TopicProperties e, em seguida, atualizar as propriedades. Apenas uma parte das propriedades pode ser atualizada. https://docs.microsoft.com/en-us/rest/api/servicebus/update-topicVeja . Também pode transmitir argumentos de palavra-chave para atualizar propriedades sob a forma de <property_name>=<property_value> que substituirão o que foi especificado na instância TopicProperties . Consulte ~azure.servicebus.management.TopicProperties para obter nomes de propriedades.
update_topic(topic: TopicProperties | Mapping[str, Any], **kwargs: Any) -> NoneParâmetros
- topic
- TopicProperties
O tópico que é devolvido a partir de get_topic, create_topic ou list_topics e tem as propriedades atualizadas.
Tipo de retorno
Azure SDK for Python