ServiceBusAdministrationClient Classe
Use esse cliente para criar, atualizar, listar e excluir recursos de um namespace 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 do host totalmente qualificado para o namespace do Barramento de Serviço.
- credential
- <xref:TokenCredential>
Para autenticar para gerenciar as entidades do namespace ServiceBus.
- api_version
- str ou ApiVersion
A versão da API do Barramento de Serviço a ser usada para solicitações. O valor padrão é a versão de serviço mais recente compatível com o SDK atual. A configuração para uma versão mais antiga pode resultar em compatibilidade de recursos reduzida.
Métodos
close | |
create_queue |
Criar uma fila. |
create_rule |
Crie uma regra para uma assinatura de tópico. |
create_subscription |
Crie uma assinatura de tópico. |
create_topic |
Crie um tópico. |
delete_queue |
Excluir uma fila. |
delete_rule |
Excluir uma regra de assinatura de tópico. |
delete_subscription |
Excluir uma assinatura de tópico. |
delete_topic |
Excluir um tópico. |
from_connection_string |
Crie um cliente com base na cadeia de conexão. |
get_namespace_properties |
Obter as propriedades do namespace |
get_queue |
Obter as propriedades de uma fila. |
get_queue_runtime_properties |
Obtenha as informações de runtime de uma fila. |
get_rule |
Obter as propriedades de uma regra de assinatura de tópico. |
get_subscription |
Obter as propriedades de uma assinatura de tópico. |
get_subscription_runtime_properties |
Obter informações de runtime de assinatura de tópico. |
get_topic |
Obter 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 namespace do ServiceBus. |
list_queues_runtime_properties |
Liste as informações de runtime das filas em um namespace ServiceBus. |
list_rules |
Listar as regras de uma assinatura de tópico. |
list_subscriptions |
Listar as assinaturas de um Tópico do ServiceBus. |
list_subscriptions_runtime_properties |
Liste as informações de runtime de assinaturas de um Tópico do ServiceBus. |
list_topics |
Liste os tópicos de um namespace servicebus. |
list_topics_runtime_properties |
Liste as informações de runtime de tópicos de um namespace ServiceBus. |
update_queue |
Atualizar uma fila. Antes de chamar esse método, você deve usar get_queue, create_queue ou list_queues para obter uma instância queueProperties e atualizar as propriedades. Somente uma parte das propriedades pode ser atualizada. Consulte https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue. Você também pode passar palavra-chave argumentos para atualizar propriedades na forma de <property_name>=<property_value> que substituirá 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 esse método, você deve usar get_rule, create_rule ou list_rules para obter uma instância RuleProperties e atualizar as propriedades. Você também pode passar palavra-chave argumentos para atualizar propriedades na forma de <property_name>=<property_value> que substituirá o que foi especificado na instância RuleProperties. Consulte ~azure.servicebus.management.RuleProperties para obter nomes de propriedades. |
update_subscription |
Atualizar uma assinatura. Antes de chamar esse método, você deve usar get_subscription, update_subscription ou list_subscription para obter uma instância subscriptionProperties e atualizar as propriedades. Você também pode passar palavra-chave argumentos para atualizar propriedades na forma de <property_name>=<property_value> que substituirá 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 esse método, você deve usar get_topic, create_topic ou list_topics para obter uma instância topicProperties e atualizar as propriedades. Somente uma parte das propriedades pode ser atualizada. Consulte https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic. Você também pode passar palavra-chave argumentos para atualizar propriedades na forma de <property_name>=<property_value> que substituirá o que foi especificado na instância TopicProperties. Consulte ~azure.servicebus.management.TopicProperties para obter nomes de propriedades. |
close
close() -> None
create_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) -> QueueProperties
Parâ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 é de 5 minutos. O valor de entrada do tipo ~datetime.timedelta ou string no formato de duração ISO 8601, como "PT300S", é aceito.
- dead_lettering_on_message_expiration
- bool
Um valor que indica se essa fila tem suporte a mensagens mortas quando uma mensagem expira.
Tempo de tempo de mensagem padrão ISO 8601 para valor dinâmico. Essa é a duração após a qual a mensagem expira, começando de quando a mensagem é enviada ao Barramento de Serviço. Esse é o valor padrão usado quando TimeToLive não está definido em uma mensagem em si. O valor de entrada do tipo ~datetime.timedelta ou string no formato de duração ISO 8601, como "PT300S", é aceito.
Estrutura timeSpan iso 8601 que define a duração do histórico de detecção duplicado. O valor padrão é 10 minutos. O valor de entrada do tipo ~datetime.timedelta ou string no formato de duração ISO 8601, como "PT300S", é aceito.
- enable_batched_operations
- bool
Valor que indica se as operações em lote do lado do servidor estão habilitadas.
- enable_express
- bool
Um valor que indica se as Entidades Expressas estão habilitadas. Uma fila expressa mantém uma mensagem na memória temporariamente antes de escrevê-la no armazenamento persistente.
- enable_partitioning
- bool
Um valor que indica se a fila deve ser particionada entre vários agentes de mensagens.
Duração do intervalo de tempo iso 8601 de um peek-lock; ou seja, a quantidade de tempo que a mensagem está bloqueada para outros receptores. O valor máximo para LockDuration é de 5 minutos; o valor padrão é 1 minuto. O valor de entrada do tipo ~datetime.timedelta ou string no formato de duração ISO 8601, como "PT300S", é aceito.
- max_delivery_count
- int
A contagem máxima de entrega. Uma mensagem é automaticamente enviada para a fila de mensagens mortas após esse número de entregas. O valor padrão é 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 essa fila requer detecção duplicada.
- requires_session
- bool
Um valor que indica se a fila dá suporte ao conceito de sessões.
- forward_to
- str
O nome da entidade de destinatário para a qual todas as mensagens enviadas para a fila são encaminhadas.
- user_metadata
- str
Metdata personalizado que o usuário pode associar à descrição. O comprimento máximo é de 1.024 caracteres.
- forward_dead_lettered_messages_to
- str
O nome da entidade de destinatário para a qual todas as mensagens com mensagens mortas dessa assinatura são encaminhadas.
- max_message_size_in_kilobytes
- int
O tamanho máximo em quilobytes de conteúdo de mensagem que pode ser aceito pela fila. Esse recurso só está disponível ao usar um namespace Premium e a versão da API do Barramento de Serviço "2021-05" ou superior. O valor mínimo permitido é 1024, enquanto o valor máximo permitido é 102400. O valor padrão é 1024.
Tipo de retorno
create_rule
Crie uma regra para uma assinatura 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) -> RuleProperties
Parâmetros
- filter
- Union[CorrelationRuleFilter, SqlRuleFilter]
O filtro da regra. O valor padrão é ~azure.servicebus.management.TrueRuleFilter
- action
- Optional[SqlRuleAction]
A ação da regra.
Tipo de retorno
create_subscription
Crie uma assinatura 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) -> SubscriptionProperties
Parâmetros
Duração do intervalo de tempo iso 8601 de um peek-lock; ou seja, a quantidade de tempo que a mensagem está bloqueada para outros receptores. O valor máximo para LockDuration é de 5 minutos; o valor padrão é 1 minuto. O valor de entrada do tipo ~datetime.timedelta ou string no formato de duração ISO 8601, como "PT300S", é aceito.
- requires_session
- bool
Um valor que indica se a fila dá suporte ao conceito de sessões.
Tempo de tempo de mensagem padrão ISO 8601 para valor dinâmico. Essa é a duração após a qual a mensagem expira, começando de quando a mensagem é enviada ao Barramento de Serviço. Esse é o valor padrão usado quando TimeToLive não está definido em uma mensagem em si. O valor de entrada do tipo ~datetime.timedelta ou string no formato de duração ISO 8601, como "PT300S", é aceito.
- dead_lettering_on_message_expiration
- bool
Um valor que indica se essa assinatura tem suporte a mensagens mortas quando uma mensagem expira.
- dead_lettering_on_filter_evaluation_exceptions
- bool
Um valor que indica se essa assinatura tem suporte a mensagens mortas quando uma mensagem expira.
- max_delivery_count
- int
A contagem máxima de entrega. Uma mensagem é automaticamente enviada para a fila de mensagens mortas após esse número de entregas. O valor padrão é 10.
- enable_batched_operations
- bool
Valor que indica se as operações em lote do lado do servidor estão habilitadas.
- forward_to
- str
O nome da entidade de destinatário para a qual todas as mensagens enviadas para a assinatura são encaminhadas.
- user_metadata
- str
Metadados associados à assinatura. O número máximo de caracteres é 1024.
- forward_dead_lettered_messages_to
- str
O nome da entidade de destinatário para a qual todas as mensagens enviadas para a assinatura são encaminhadas.
Iso 8601 timeSpan idle interval after which the subscription is automatically deleted. A duração mínima é de 5 minutos. O valor de entrada do tipo ~datetime.timedelta ou string no formato de duração ISO 8601, como "PT300S", é aceito.
Tipo de retorno
create_topic
Crie 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) -> TopicProperties
Parâmetros
Tempo de tempo de mensagem padrão ISO 8601 para valor dinâmico. Essa é a duração após a qual a mensagem expira, começando de quando a mensagem é enviada ao Barramento de Serviço. Esse é o valor padrão usado quando TimeToLive não está definido em uma mensagem em si. O valor de entrada do tipo ~datetime.timedelta ou string no formato de duração ISO 8601, como "PT300S", é aceito.
- 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 detecção duplicada.
Estrutura timeSpan iso 8601 que define a duração do histórico de detecção duplicado. O valor padrão é 10 minutos. O valor de entrada do tipo ~datetime.timedelta ou string no formato de duração ISO 8601, como "PT300S", é aceito.
- enable_batched_operations
- bool
Valor que indica se as operações em lote do lado do servidor estão habilitadas.
- size_in_bytes
- int
O tamanho do tópico, em bytes.
- filtering_messages_before_publishing
- bool
Filtre mensagens antes da publicação.
- authorization_rules
- list[AuthorizationRule]
Regras de autorização para o recurso.
- support_ordering
- bool
Um valor que indica se o tópico dá suporte à ordenação.
Iso 8601 timeSpan idle interval after which the topic is automatically deleted. A duração mínima é de 5 minutos. O valor de entrada do tipo ~datetime.timedelta ou string no formato de duração ISO 8601, como "PT300S", é aceito.
- enable_partitioning
- bool
Um valor que indica se o tópico deve ser particionado entre vários agentes de mensagens.
- enable_express
- bool
Um valor que indica se as Entidades Expressas estão habilitadas. Uma fila expressa mantém uma mensagem na memória temporariamente antes de escrevê-la no armazenamento persistente.
- user_metadata
- str
Metadados associados ao tópico.
- max_message_size_in_kilobytes
- int
O tamanho máximo em quilobytes de conteúdo de mensagem que pode ser aceito pela fila. Esse recurso só está disponível ao usar um namespace Premium e a versão da API do Barramento de Serviço "2021-05" ou superior. O valor mínimo permitido é 1024, enquanto o valor máximo permitido é 102400. O valor padrão é 1024.
Tipo de retorno
delete_queue
Excluir uma fila.
delete_queue(queue_name: str, **kwargs: Any) -> None
Parâmetros
Tipo de retorno
delete_rule
Excluir uma regra de assinatura de tópico.
delete_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> None
Parâmetros
Tipo de retorno
delete_subscription
Excluir uma assinatura de tópico.
delete_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> None
Parâmetros
Tipo de retorno
delete_topic
Excluir um tópico.
delete_topic(topic_name: str, **kwargs: Any) -> None
Parâmetros
Tipo de retorno
from_connection_string
Crie um cliente com base na cadeia de conexão.
from_connection_string(conn_str: str, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any) -> ServiceBusAdministrationClient
Parâmetros
- api_version
- str ou ApiVersion
A versão da API do Barramento de Serviço a ser usada para solicitações. O valor padrão é a versão de serviço mais recente compatível com o SDK atual. A configuração para uma versão mais antiga pode resultar em redução da compatibilidade de recursos.
Tipo de retorno
get_namespace_properties
Obter as propriedades do namespace
get_namespace_properties(**kwargs: Any) -> NamespaceProperties
Retornos
As propriedades do namespace.
Tipo de retorno
get_queue
Obter as propriedades de uma fila.
get_queue(queue_name: str, **kwargs: Any) -> QueueProperties
Parâmetros
Retornos
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) -> QueueRuntimeProperties
Parâmetros
Retornos
As informações de runtime da fila.
Tipo de retorno
get_rule
Obter as propriedades de uma regra de assinatura de tópico.
get_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> RuleProperties
Parâmetros
Retornos
As propriedades da regra especificada.
Tipo de retorno
get_subscription
Obter as propriedades de uma assinatura de tópico.
get_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionProperties
Parâmetros
Retornos
Uma instância de SubscriptionProperties
Tipo de retorno
get_subscription_runtime_properties
Obter informações de runtime de assinatura de tópico.
get_subscription_runtime_properties(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionRuntimeProperties
Parâmetros
Retornos
Uma instância de SubscriptionRuntimeProperties
Tipo de retorno
get_topic
Obter as propriedades de um tópico.
get_topic(topic_name: str, **kwargs: Any) -> TopicProperties
Parâmetros
Retornos
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) -> TopicRuntimeProperties
Parâmetros
Retornos
As informações de runtime do tópico.
Tipo de retorno
list_queues
Listar as filas de um namespace do ServiceBus.
list_queues(**kwargs: Any) -> ItemPaged[QueueProperties]
Retornos
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 em um namespace ServiceBus.
list_queues_runtime_properties(**kwargs: Any) -> ItemPaged[QueueRuntimeProperties]
Retornos
Uma resposta iterável (paginação automática) de QueueRuntimeProperties.
Tipo de retorno
list_rules
Listar as regras de uma assinatura de tópico.
list_rules(topic_name: str, subscription_name: str, **kwargs: Any) -> ItemPaged[RuleProperties]
Parâmetros
Retornos
Uma resposta iterável (paginação automática) de RuleProperties.
Tipo de retorno
list_subscriptions
Listar as assinaturas de um Tópico do ServiceBus.
list_subscriptions(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionProperties]
Parâmetros
Retornos
Uma resposta iterável (paginação automática) de SubscriptionProperties.
Tipo de retorno
list_subscriptions_runtime_properties
Liste as informações de runtime de assinaturas de um Tópico do ServiceBus.
list_subscriptions_runtime_properties(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionRuntimeProperties]
Parâmetros
Retornos
Uma resposta iterável (paginação automática) de SubscriptionRuntimeProperties.
Tipo de retorno
list_topics
Liste os tópicos de um namespace servicebus.
list_topics(**kwargs: Any) -> ItemPaged[TopicProperties]
Retornos
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 namespace ServiceBus.
list_topics_runtime_properties(**kwargs: Any) -> ItemPaged[TopicRuntimeProperties]
Retornos
Uma resposta iterável (paginação automática) de TopicRuntimeProperties.
Tipo de retorno
update_queue
Atualizar uma fila.
Antes de chamar esse método, você deve usar get_queue, create_queue ou list_queues para obter uma instância queueProperties e atualizar as propriedades. Somente uma parte das propriedades pode ser atualizada. Consulte https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue. Você também pode passar palavra-chave argumentos para atualizar propriedades na forma de <property_name>=<property_value> que substituirá 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) -> None
Parâmetros
- queue
- QueueProperties
A fila retornada de get_queue, create_queue ou list_queues e tem as propriedades atualizadas.
Tipo de retorno
update_rule
Atualizar uma regra.
Antes de chamar esse método, você deve usar get_rule, create_rule ou list_rules para obter uma instância RuleProperties e atualizar as propriedades. Você também pode passar palavra-chave argumentos para atualizar propriedades na forma de <property_name>=<property_value> que substituirá 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) -> None
Parâmetros
- rule
- RuleProperties
A regra retornada de get_rule, create_rule ou list_rules e tem as propriedades atualizadas.
Tipo de retorno
update_subscription
Atualizar uma assinatura.
Antes de chamar esse método, você deve usar get_subscription, update_subscription ou list_subscription para obter uma instância subscriptionProperties e atualizar as propriedades. Você também pode passar palavra-chave argumentos para atualizar propriedades na forma de <property_name>=<property_value> que substituirá 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) -> None
Parâmetros
- subscription
- SubscriptionProperties
A assinatura retornada 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 esse método, você deve usar get_topic, create_topic ou list_topics para obter uma instância topicProperties e atualizar as propriedades. Somente uma parte das propriedades pode ser atualizada. Consulte https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic. Você também pode passar palavra-chave argumentos para atualizar propriedades na forma de <property_name>=<property_value> que substituirá 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) -> None
Parâmetros
- topic
- TopicProperties
O tópico retornado de get_topic, create_topic ou list_topics e tem as propriedades atualizadas.
Tipo de retorno
Azure SDK for Python