ansible / ansible.builtin / v2.9.17 / module / azure_rm_servicebussaspolicy Manage Azure Service Bus SAS policy | "added in version" 2.8 of ansible.builtin" Authors: Yuwei Zhou (@yuwzho) preview | supported by communityansible.builtin.azure_rm_servicebussaspolicy (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Create, update or delete an Azure Service Bus SAS policy.
- name: Create a namespace azure_rm_servicebussaspolicy: name: deadbeef queue: qux namespace: bar resource_group: myResourceGroup rights: send
name: description: - Name of the SAS policy. required: true tags: description: - 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. type: dict queue: description: - Type of the messaging queue. - Cannot set C(topc) when this field set. state: choices: - absent - present default: present description: - Assert the state of the route. Use C(present) to create or update and C(absent) to delete. topic: description: - Name of the messaging topic. - Cannot set C(queue) when this field set. rights: choices: - manage - listen - send - listen_send description: - Claim rights of the SAS policy. required: true secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str namespace: description: - Manage SAS policy for a namespace without C(queue) or C(topic) set. - Manage SAS policy for a queue or topic under this namespace. required: true api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection append_tags: default: true description: - 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. type: bool auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection resource_group: description: - Name of resource group. required: true subscription_id: description: - Your Azure subscription Id. type: str cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection regenerate_primary_key: default: false description: - Regenerate the SAS policy primary key. type: bool regenerate_secondary_key: default: false description: - Regenerate the SAS policy secondary key. type: bool
id: description: - Current state of the SAS policy. returned: Successed sample: /subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/ namespaces/nsb57dc95979/topics/topicb57dc95979/authorizationRules/testpolicy type: str keys: contains: key_name: description: - Name of the SAS policy. returned: Successed sample: testpolicy type: str primary_connection_string: description: - Primary connection string. returned: Successed sample: Endpoint=sb://nsb57dc95979.servicebus.windows.net/;SharedAccessKeyName=testpolicy; SharedAccessKey=r+HD3es/9aOOq0XjQtkx5KXROH1MIHDs0WxCgR23gMc=;EntityPath=topicb57dc95979 type: str primary_key: description: - Primary key. returned: Successed sample: r+HD3es/9aOOq0XjQtkx5KXROH1MIHDs0WxCgR23gMc= type: str secondary_connection_string: description: - Secondary connection string. returned: Successed sample: Endpoint=sb://nsb57dc95979.servicebus.windows.net/;SharedAccessKeyName=testpolicy; SharedAccessKey=/EcGztJBv72VD0Dy14bdsxi30rl+pSZMtKcs4KV3JWU=;EntityPath=topicb57dc95979 type: str secondary_key: description: - Secondary key. returned: Successed sample: /EcGztJBv72VD0Dy14bdsxi30rl+pSZMtKcs4KV3JWU= type: str description: - Key dict of the SAS policy. returned: Successed type: complex name: description: - Name of the SAS policy. returned: Successed sample: testpolicy type: str rights: description: - Priviledge of the SAS policy. returned: Successed sample: manage type: str type: description: - Type of the SAS policy. returned: Successed sample: Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules type: str