azure.azcollection.azure_rm_servicebussaspolicy – Manage Azure Service Bus SAS policy

Note

This plugin is part of the azure.azcollection collection (version 1.5.0).

To install it use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_servicebussaspolicy.

New in version 0.1.2: of azure.azcollection

Synopsis

  • Create, update or delete an Azure Service Bus SAS policy.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults Comments
ad_user
string
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url
string
added in 0.0.1 of azure.azcollection
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
string
added in 0.0.1 of azure.azcollection
Default:
"latest"
Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags
boolean
    Choices:
  • no
  • yes ←
Use to control if tags field is canonical or just appends to existing tags.
When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
auth_source
string
added in 0.0.1 of azure.azcollection
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.
When set to env, the credentials will be read from the environment variables
When set to credential_file, it will read the profile from ~/.azure/credentials.
When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.
When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.
The msi was added in Ansible 2.6.
cert_validation_mode
string
added in 0.0.1 of azure.azcollection
    Choices:
  • ignore
  • validate
Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.
client_id
string
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
string
added in 0.0.1 of azure.azcollection
Default:
"AzureCloud"
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.
name
string / required
Name of the SAS policy.
namespace
string / required
Manage SAS policy for a namespace without queue or topic set.
Manage SAS policy for a queue or topic under this namespace.
password
string
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile
string
Security profile found in ~/.azure/credentials file.
queue
string
Type of the messaging queue.
Cannot set topc when this field set.
regenerate_primary_key
boolean
    Choices:
  • no ←
  • yes
Regenerate the SAS policy primary key.
regenerate_secondary_key
boolean
    Choices:
  • no ←
  • yes
Regenerate the SAS policy secondary key.
resource_group
string / required
Name of resource group.
rights
string / required
    Choices:
  • manage
  • listen
  • send
  • listen_send
Claim rights of the SAS policy.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
state
string
    Choices:
  • absent
  • present ←
Assert the state of the route. Use present to create or update and absent to delete.
subscription_id
string
Your Azure subscription Id.
tags
dictionary
Dictionary of string:string pairs to assign as metadata to the object.
Metadata tags on the object will be updated with any provided values.
To remove tags set append_tags option to false.
Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag.
Azure Front Door doesn't support the use of
Azure Automation and Azure CDN only support 15 tags on resources.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
topic
string
Name of the messaging topic.
Cannot set queue when this field set.

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: Create a namespace
  azure_rm_servicebussaspolicy:
      name: deadbeef
      queue: qux
      namespace: bar
      resource_group: myResourceGroup
      rights: send

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
id
string
Successed
Current state of the SAS policy.

Sample:
/subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/ namespaces/nsb57dc95979/topics/topicb57dc95979/authorizationRules/testpolicy
keys
complex
Successed
Key dict of the SAS policy.
 
key_name
string
Successed
Name of the SAS policy.

Sample:
testpolicy
 
primary_connection_string
string
Successed
Primary connection string.

Sample:
Endpoint=sb://nsb57dc95979.servicebus.windows.net/;SharedAccessKeyName=testpolicy; SharedAccessKey=xxxxxxxxxxxxxxxxxxxxxxxxxxxx
 
primary_key
string
Successed
Primary key.

Sample:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 
secondary_connection_string
string
Successed
Secondary connection string.

Sample:
Endpoint=sb://nsb57dc95979.servicebus.windows.net/;SharedAccessKeyName=testpolicy; SharedAccessKey=xxxxxxxxxxxxxxxxxxxxxxxxx
 
secondary_key
string
Successed
Secondary key.

Sample:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
name
string
Successed
Name of the SAS policy.

Sample:
testpolicy
rights
string
Successed
Priviledge of the SAS policy.

Sample:
manage
type
string
Successed
Type of the SAS policy.

Sample:
Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules


Authors

  • Yuwei Zhou (@yuwzho)