Update azure_rm_batchaccount's document (#64490)
This commit is contained in:
parent
1e4230c0e7
commit
beaf9c25d8
1 changed files with 29 additions and 24 deletions
|
@ -28,58 +28,63 @@ DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: azure_rm_batchaccount
|
module: azure_rm_batchaccount
|
||||||
version_added: "2.9"
|
version_added: "2.9"
|
||||||
short_description: Manages a Batch Account on Azure.
|
short_description: Manages a Batch Account on Azure
|
||||||
description:
|
description:
|
||||||
- Create, update and delete instance of Azure Batch Account.
|
- Create, update and delete instance of Azure Batch Account.
|
||||||
|
|
||||||
options:
|
options:
|
||||||
resource_group:
|
resource_group:
|
||||||
description:
|
description:
|
||||||
- The name of the resource group in which to create the Batch Account.
|
- The name of the resource group in which to create the Batch Account.
|
||||||
required: true
|
required: true
|
||||||
|
type: str
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- The name of the Batch Account.
|
- The name of the Batch Account.
|
||||||
required: true
|
required: true
|
||||||
|
type: str
|
||||||
location:
|
location:
|
||||||
description:
|
description:
|
||||||
- Specifies the supported Azure location where the resource exists.
|
- Specifies the supported Azure location where the resource exists.
|
||||||
|
type: str
|
||||||
auto_storage_account:
|
auto_storage_account:
|
||||||
description:
|
description:
|
||||||
- Existing storage account with which to associate the Batch Account.
|
- Existing storage account with which to associate the Batch Account.
|
||||||
- It can be the storage account name which is in the same resource group.
|
- It can be the storage account name which is in the same resource group.
|
||||||
- "It can be the storage account ID. e.g.,
|
- It can be the storage account ID. Fox example "/subscriptions/{subscription_id}/resourceGroups/
|
||||||
/subscriptions/{subscription_id}/resourceGroups/{resource_group}/providers/Microsoft.Storage/storageAccounts/{name}."
|
{resource_group}/providers/Microsoft.Storage/storageAccounts/{name}".
|
||||||
- It can be a dict which contains C(name) and C(resource_group) of the storage account.
|
- It can be a dict which contains I(name) and I(resource_group) of the storage account.
|
||||||
key_vault:
|
key_vault:
|
||||||
description:
|
description:
|
||||||
- Existing key vault with which to associate the Batch Account.
|
- Existing key vault with which to associate the Batch Account.
|
||||||
- It can be the key vault name which is in the same resource group.
|
- It can be the key vault name which is in the same resource group.
|
||||||
- "It can be the key vault ID. e.g.,
|
- It can be the key vault ID. For example "/subscriptions/{subscription_id}/resourceGroups/
|
||||||
/subscriptions/{subscription_id}/resourceGroups/{resource_group}/providers/Microsoft.KeyVault/vaults/{name}."
|
{resource_group}/providers/Microsoft.KeyVault/vaults/{name}".
|
||||||
- It can be a dict which contains C(name) and C(resource_group) of the key vault.
|
- It can be a dict which contains I(name) and I(resource_group) of the key vault.
|
||||||
pool_allocation_mode:
|
pool_allocation_mode:
|
||||||
description:
|
description:
|
||||||
- The pool acclocation mode of the Batch Account.
|
- The pool acclocation mode of the Batch Account.
|
||||||
default: batch_service
|
default: batch_service
|
||||||
choices:
|
choices:
|
||||||
- batch_service
|
- batch_service
|
||||||
- user_subscription
|
- user_subscription
|
||||||
|
type: str
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Assert the state of the Batch Account.
|
- Assert the state of the Batch Account.
|
||||||
- Use 'present' to create or update a Batch Account and 'absent' to delete it.
|
- Use C(present) to create or update a Batch Account and C(absent) to delete it.
|
||||||
default: present
|
default: present
|
||||||
|
type: str
|
||||||
choices:
|
choices:
|
||||||
- present
|
- present
|
||||||
- absent
|
- absent
|
||||||
|
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- azure
|
- azure
|
||||||
- azure_tags
|
- azure_tags
|
||||||
|
|
||||||
author:
|
author:
|
||||||
- "Junyi Yi (@JunyiYi)"
|
- Junyi Yi (@JunyiYi)
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
@ -96,13 +101,13 @@ EXAMPLES = '''
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
id:
|
id:
|
||||||
description:
|
description:
|
||||||
- The ID of the Batch account.
|
- The ID of the Batch account.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Batch/batchAccounts/sampleacct"
|
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Batch/batchAccounts/sampleacct"
|
||||||
account_endpoint:
|
account_endpoint:
|
||||||
description:
|
description:
|
||||||
- The account endpoint used to interact with the Batch service.
|
- The account endpoint used to interact with the Batch service.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: sampleacct.westus.batch.azure.com
|
sample: sampleacct.westus.batch.azure.com
|
||||||
|
|
Loading…
Reference in a new issue