cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update azure_rm_servicebus related document (#58105)

Browse source 
* Update azure_rm_servicebus related document
This commit is contained in:
Fred-sun 2019-06-21 23:59:07 +08:00 • committed by Sandra McCann
parent 7e70184f10
commit 1c49a9110a
2 changed files with 89 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
lib/ansible/modules/cloud/azure/azure_rm_servicebus.py
View file

@ -17,45 +17,43 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_servicebus module: azure_rm_servicebus
version_added: "2.8" version_added: "2.8"
short_description: Manage Azure Service Bus. short_description: Manage Azure Service Bus
description: description:
- Create, update or delete an Azure Service Bus namespaces. - Create, update or delete an Azure Service Bus namespaces.
options: options:
resource_group: resource_group:
description: description:
- name of resource group. - Name of resource group.
required: true required: true
name: name:
description: description:
- name of the servicebus namespace - Name of the servicebus namespace.
required: true required: true
state: state:
description: description:
- Assert the state of the route. Use 'present' to create or update and - Assert the state of the servicebus. Use C(present) to create or update and use C(absen) to delete.
'absent' to delete.
default: present default: present
choices: choices:
- absent - absent
- present - present
location: location:
description: description:
- Namespace location. - The servicebus's location.
sku: sku:
description: description:
- Namespace sku. - Namespace SKU.
choices: choices:
- standard - standard
- basic - basic
- premium - premium
default: default: standard
standard
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
- azure_tags - azure_tags
author: author:
- "Yuwei Zhou (@yuwzho)" - Yuwei Zhou (@yuwzho)
''' '''
@ -67,9 +65,11 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
id: id:
description: Current state of the service bus. description:
- Current state of the service bus.
returned: success returned: success
type: str type: str
sample: "/subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myServicebus"
''' '''
try: try:

114
lib/ansible/modules/cloud/azure/azure_rm_servicebus_facts.py
View file

@ -19,7 +19,7 @@ module: azure_rm_servicebus_facts
version_added: "2.8" version_added: "2.8"
short_description: Get servicebus facts. short_description: Get servicebus facts
description: description:
- Get facts for a specific servicebus or all servicebus in a resource group or subscription. - Get facts for a specific servicebus or all servicebus in a resource group or subscription.
@ -39,7 +39,7 @@ options:
- Servicebus namespace name. - Servicebus namespace name.
- A namespace is a scoping container for all messaging components. - A namespace is a scoping container for all messaging components.
- Multiple queues and topics can reside within a single namespace, and namespaces often serve as application containers. - Multiple queues and topics can reside within a single namespace, and namespaces often serve as application containers.
- Required when C(type) is not C(namespace). - Required when I(type=namespace).
type: type:
description: description:
- Type of the resource. - Type of the resource.
@ -51,18 +51,18 @@ options:
topic: topic:
description: description:
- Topic name. - Topic name.
- Required when C(type) is C(subscription). - Required when I(type=subscription).
show_sas_policies: show_sas_policies:
description: description:
- Whether to show the SAS policies. - Whether to show the SAS policies.
- Not support when C(type) is C(subscription). - Not support when I(type=subscription).
- Note if enable this option, the facts module will raise two more HTTP call for each resources, need more network overhead. - Note if enable this option, the facts module will raise two more HTTP call for each resources, need more network overhead.
type: bool type: bool
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
author: author:
- "Yuwei Zhou (@yuwzho)" - Yuwei Zhou (@yuwzho)
''' '''
@ -95,148 +95,176 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
servicebuses: servicebuses:
description: List of servicebus dicts. description:
- List of servicebus dicts.
returned: always returned: always
type: list type: complex
contains: contains:
id: id:
description: description:
- Resource Id - Resource ID.
returned: always
type: str type: str
sample: "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/foo/providers/Microsoft.ServiceBus/ sample: "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/foo/providers/Microsoft.ServiceBus/
namespaces/bar/topics/baz/subscriptions/qux" namespaces/bar/topics/baz/subscriptions/qux"
name: name:
description: description:
- Resource name - Resource name.
returned: always
type: str type: str
sample: qux sample: qux
location: location:
description: description:
- The Geo-location where the resource lives. - The Geo-location where the resource lives.
returned: always
type: str type: str
sample: eastus sample: eastus
namespace: namespace:
description: description:
- Namespace name of the queue or topic, subscription. - I(namespace) name of the C(queue) or C(topic), C(subscription).
returned: always
type: str type: str
sample: bar sample: bar
topic: topic:
description: description:
- Topic name of a subscription. - Topic name of a subscription.
returned: always
type: str type: str
sample: baz sample: baz
tags: tags:
description: description:
- Resource tags. - Resource tags.
type: str returned: always
type: dict
sample: {env: sandbox} sample: {env: sandbox}
sku: sku:
description: description:
- Properties of namespace's sku. - Properties of namespace's SKU.
returned: always
type: str type: str
sample: Standard sample: Standard
provisioning_state: provisioning_state:
description: description:
- Provisioning state of the namespace. - Provisioning state of the namespace.
returned: always
type: str type: str
sample: Succeeded sample: Succeeded
service_bus_endpoint: service_bus_endpoint:
description: description:
- Endpoint you can use to perform Service Bus operations. - Endpoint you can use to perform Service Bus operations.
returned: always
type: str type: str
sample: "https://bar.servicebus.windows.net:443/" sample: "https://bar.servicebus.windows.net:443/"
metric_id: metric_id:
description: description:
- Identifier for Azure Insights metrics of namespace. - Identifier for Azure Insights metrics of namespace.
returned: always
type: str type: str
sample: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:bar" sample: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:bar"
type: type:
description: description:
- Resource type - Resource type.
- Namespace is a scoping container for all messaging components. - Namespace is a scoping container for all messaging components.
- Queue enables you to store messages until the receiving application is available to receive and process them. - Queue enables you to store messages until the receiving application is available to receive and process them.
- Topic and subscriptions enable 1:n relationships between publishers and subscribers. - Topic and subscriptions enable 1:n relationships between publishers and subscribers.
sample: "Microsoft.ServiceBus/Namespaces/Topics" returned: always
type: str type: str
sample: "Microsoft.ServiceBus/Namespaces/Topics"
created_at: created_at:
description: description:
- Exact time the message was created. - Exact time the message was created.
sample: "2019-01-25 02:46:55.543953+00:00" returned: always
type: str type: str
sample: "2019-01-25 02:46:55.543953+00:00"
updated_at: updated_at:
description: description:
- The exact time the message was updated. - The exact time the message was updated.
returned: always
type: str type: str
sample: "2019-01-25 02:46:55.543953+00:00" sample: "2019-01-25 02:46:55.543953+00:00"
accessed_at: accessed_at:
description: description:
- Last time the message was sent, or a request was received, for this topic. - Last time the message was sent, or a request was received for this topic.
returned: always
type: str type: str
sample: "2019-01-25 02:46:55.543953+00:00" sample: "2019-01-25 02:46:55.543953+00:00"
subscription_count: subscription_count:
description: description:
- Number of subscriptions under a topic. - Number of subscriptions under a topic.
returned: always
type: int type: int
sample: 1 sample: 1
count_details: count_details:
description: description:
- Message count deatils. - Message count deatils.
type: dict returned: always
type: complex
contains: contains:
active_message_count: active_message_count:
description: description:
- Number of active messages in the queue, topic, or subscription. - Number of active messages in the C(queue), C(topic), or C(subscription).
returned: always
type: int type: int
sample: 0 sample: 0
dead_letter_message_count: dead_letter_message_count:
description: description:
- Number of messages that are dead lettered. - Number of messages that are dead lettered.
returned: always
type: int type: int
sample: 0 sample: 0
scheduled_message_count: scheduled_message_count:
description: description:
- Number of scheduled messages. - Number of scheduled messages.
returned: always
type: int type: int
sample: 0 sample: 0
transfer_message_count: transfer_message_count:
description: description:
- Number of messages transferred to another queue, topic, or subscription. - Number of messages transferred to another C(queue), C(topic), or C(subscription).
returned: always
type: int type: int
sample: 0 sample: 0
transfer_dead_letter_message_count: transfer_dead_letter_message_count:
description: description:
- Number of messages transferred into dead letters. - Number of messages transferred into dead letters.
returned: always
type: int type: int
sample: 0 sample: 0
support_ordering: support_ordering:
description: description:
- Value that indicates whether the topic supports ordering. - Value that indicates whether the C(topic) supports ordering.
returned: always
type: bool type: bool
sample: true sample: true
status: status:
description: description:
- The status of a messaging entity. - The status of a messaging entity.
returned: always
type: str type: str
sample: active sample: active
requires_session: requires_session:
description: description:
- A value that indicates whether the queue or topic supports the concept of sessions. - A value that indicates whether the C(queue) or C(topic) supports the concept of sessions.
returned: always
type: bool type: bool
sample: true sample: true
requires_duplicate_detection: requires_duplicate_detection:
description: description:
- A value indicating if this queue or topic requires duplicate detection. - A value indicating if this C(queue) or C(topic) requires duplicate detection.
returned: always
type: bool type: bool
sample: true sample: true
max_size_in_mb: max_size_in_mb:
description: description:
- Maximum size of the queue or topic in megabytes, which is the size of the memory allocated for the topic. - Maximum size of the C(queue) or C(topic) in megabytes, which is the size of the memory allocated for the C(topic).
returned: always
type: int type: int
sample: 5120 sample: 5120
max_delivery_count: max_delivery_count:
description: description:
- The maximum delivery count. - The maximum delivery count.
- A message is automatically deadlettered after this number of deliveries. - A message is automatically deadlettered after this number of deliveries.
returned: always
type: int type: int
sample: 10 sample: 10
lock_duration_in_seconds: lock_duration_in_seconds:
@ -244,37 +272,44 @@ servicebuses:
- ISO 8601 timespan duration of a peek-lock. - ISO 8601 timespan duration of a peek-lock.
- The amount of time that the message is locked for other receivers. - The amount of time that the message is locked for other receivers.
- The maximum value for LockDuration is 5 minutes. - The maximum value for LockDuration is 5 minutes.
returned: always
type: int type: int
sample: 60 sample: 60
forward_to: forward_to:
description: description:
- Queue or topic name to forward the messages - C(queue) or C(topic) name to forward the messages.
returned: always
type: str type: str
sample: quux sample: quux
forward_dead_lettered_messages_to: forward_dead_lettered_messages_to:
description: description:
- Queue or topic name to forward the Dead Letter message - C(queue) or C(topic) name to forward the Dead Letter message.
returned: always
type: str type: str
sample: corge sample: corge
enable_partitioning: enable_partitioning:
description: description:
- Value that indicates whether the queue or topic to be partitioned across multiple message brokers is enabled. - Value that indicates whether the C(queue) or C(topic) to be partitioned across multiple message brokers is enabled.
returned: always
type: bool type: bool
sample: true sample: true
enable_express: enable_express:
description: description:
- Value that indicates whether Express Entities are enabled. - Value that indicates whether Express Entities are enabled.
- An express topic holds a message in memory temporarily before writing it to persistent storage. - An express topic holds a message in memory temporarily before writing it to persistent storage.
returned: always
type: bool type: bool
sample: true sample: true
enable_batched_operations: enable_batched_operations:
description: description:
- Value that indicates whether server-side batched operations are enabled. - Value that indicates whether server-side batched operations are enabled.
returned: always
type: bool type: bool
sample: true sample: true
duplicate_detection_time_in_seconds: duplicate_detection_time_in_seconds:
description: description:
- ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. - ISO 8601 timeSpan structure that defines the duration of the duplicate detection history.
returned: always
type: int type: int
sample: 600 sample: 600
default_message_time_to_live_seconds: default_message_time_to_live_seconds:
@ -282,40 +317,47 @@ servicebuses:
- ISO 8061 Default message timespan to live value. - ISO 8061 Default message timespan to live value.
- This is the duration after which the message expires, starting from when the message is sent to Service Bus. - This is the duration after which the message expires, starting from when the message is sent to Service Bus.
- This is the default value used when TimeToLive is not set on a message itself. - This is the default value used when TimeToLive is not set on a message itself.
returned: always
type: int type: int
sample: 0 sample: 0
dead_lettering_on_message_expiration: dead_lettering_on_message_expiration:
description: description:
- A value that indicates whether this queue or topic has dead letter support when a message expires. - A value that indicates whether this C(queue) or C(topic) has dead letter support when a message expires.
returned: always
type: int type: int
sample: 0 sample: 0
dead_lettering_on_filter_evaluation_exceptions: dead_lettering_on_filter_evaluation_exceptions:
description: description:
- Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. - Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.
returned: always
type: int type: int
sample: 0 sample: 0
auto_delete_on_idle_in_seconds: auto_delete_on_idle_in_seconds:
description: description:
- ISO 8061 timeSpan idle interval after which the queue or topic is automatically deleted. - ISO 8061 timeSpan idle interval after which the queue or topic is automatically deleted.
- The minimum duration is 5 minutes. - The minimum duration is 5 minutes.
returned: always
type: int type: int
sample: true sample: true
size_in_bytes: size_in_bytes:
description: description:
- The size of the queue or topic, in bytes. - The size of the C(queue) or C(topic) in bytes.
returned: always
type: int type: int
sample: 0 sample: 0
message_count: message_count:
description: description:
- Number of messages. - Number of messages.
returned: always
type: int type: int
sample: 10 sample: 10
sas_policies: sas_policies:
description: description:
- Dict of SAS policies. - Dict of SAS policies.
- Will not be returned until C(show_sas_policy) set - Will not be returned until I(show_sas_policy) set.
returned: always
type: dict type: dict
sample: '{ sample: {
"testpolicy1": { "testpolicy1": {
"id": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/ "id": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/
foo/providers/Microsoft.ServiceBus/namespaces/bar/queues/qux/authorizationRules/testpolicy1", foo/providers/Microsoft.ServiceBus/namespaces/bar/queues/qux/authorizationRules/testpolicy1",
@ -332,7 +374,7 @@ servicebuses:
"rights": "listen_send", "rights": "listen_send",
"type": "Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules" "type": "Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules"
} }
}' }
''' '''
try: try: