community.azure.azure_rm_servicebus_info – Get servicebus facts¶
Note
This plugin is part of the community.azure collection (version 1.0.0).
To install it use: ansible-galaxy collection install community.azure
.
To use it in a playbook, specify: community.azure.azure_rm_servicebus_info
.
Synopsis¶
Get facts for a specific servicebus or all servicebus in a resource group or subscription.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.7
azure >= 2.0.0
Parameters¶
Notes¶
Note
For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login
.Authentication is also possible using a service principal or Active Directory user.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
See Also¶
See also
- Sign in with Azure CLI
How to authenticate using the
az login
command.
Examples¶
- name: Get all namespaces under a resource group
community.azure.azure_rm_servicebus_info:
resource_group: myResourceGroup
type: namespace
- name: Get all topics under a namespace
community.azure.azure_rm_servicebus_info:
resource_group: myResourceGroup
namespace: bar
type: topic
- name: Get a single queue with SAS policies
community.azure.azure_rm_servicebus_info:
resource_group: myResourceGroup
namespace: bar
type: queue
name: sbqueue
show_sas_policies: true
- name: Get all subscriptions under a resource group
community.azure.azure_rm_servicebus_info:
resource_group: myResourceGroup
type: subscription
namespace: bar
topic: sbtopic
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Yuwei Zhou (@yuwzho)