Skip to content

Commit

Permalink
added missing help texts
Browse files Browse the repository at this point in the history
  • Loading branch information
Akshay Neema committed Aug 31, 2021
1 parent a8419dd commit d58ca3b
Show file tree
Hide file tree
Showing 11 changed files with 29 additions and 28 deletions.
15 changes: 8 additions & 7 deletions src/dataprotection/azext_dataprotection/generated/_params.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ def load_arguments(self, _):
with self.argument_context('dataprotection backup-policy show') as c:
c.argument('vault_name', type=str, help='The name of the backup vault.', id_part='name')
c.argument('resource_group_name', resource_group_name_type)
c.argument('backup_policy_name', options_list=['--name', '-n', '--backup-policy-name'], type=str, help='',
id_part='child_name_1')
c.argument('backup_policy_name', options_list=['--name', '-n', '--backup-policy-name'], type=str, help='Name '
'of the policy', id_part='child_name_1')

with self.argument_context('dataprotection backup-policy create') as c:
c.argument('vault_name', type=str, help='The name of the backup vault.')
Expand All @@ -83,8 +83,8 @@ def load_arguments(self, _):
with self.argument_context('dataprotection backup-policy delete') as c:
c.argument('vault_name', type=str, help='The name of the backup vault.', id_part='name')
c.argument('resource_group_name', resource_group_name_type)
c.argument('backup_policy_name', options_list=['--name', '-n', '--backup-policy-name'], type=str, help='',
id_part='child_name_1')
c.argument('backup_policy_name', options_list=['--name', '-n', '--backup-policy-name'], type=str, help='Name '
'of the policy', id_part='child_name_1')

with self.argument_context('dataprotection backup-instance list') as c:
c.argument('vault_name', type=str, help='The name of the backup vault.')
Expand Down Expand Up @@ -124,8 +124,9 @@ def load_arguments(self, _):
c.argument('resource_group_name', resource_group_name_type)
c.argument('backup_instance_name', options_list=['--name', '-n', '--backup-instance-name'], type=str,
help='The name of the backup instance', id_part='child_name_1')
c.argument('rule_name', type=str, help='', arg_group='Backup Rule Options')
c.argument('retention_tag_override', type=str, help='', arg_group='Backup Rule Options Trigger Option')
c.argument('rule_name', type=str, help='Specify backup policy rule name.', arg_group='Backup Rule Options')
c.argument('retention_tag_override', type=str, help='Specify retention override tag.', arg_group='Backup Rule '
'Options Trigger Option')

with self.argument_context('dataprotection backup-instance restore trigger') as c:
c.argument('vault_name', type=str, help='The name of the backup vault.', id_part='name')
Expand Down Expand Up @@ -176,7 +177,7 @@ def load_arguments(self, _):
c.argument('vault_name', type=str, help='The name of the backup vault.', id_part='name')
c.argument('resource_group_name', resource_group_name_type)
c.argument('backup_instance_name', type=str, help='The name of the backup instance', id_part='child_name_1')
c.argument('recovery_point_id', type=str, help='', id_part='child_name_2')
c.argument('recovery_point_id', type=str, help='Id of the recovery point.', id_part='child_name_2')

with self.argument_context('dataprotection job list') as c:
c.argument('resource_group_name', resource_group_name_type)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,4 +145,4 @@ def __init__(self, *args, **kwargs):
super(DataprotectionScenarioTest, self).__init__(*args, **kwargs)

def test_dataprotection_oss(self):
call_scenario(self)
call_scenario(self)
Original file line number Diff line number Diff line change
Expand Up @@ -72,17 +72,17 @@ def call_scenario(test):
test.check('length(@)', 1),
])
step_backup_instance_create(test, checks=[
test.check("friendlyName", "harshitbi2", case_sensitive=False),
test.check("objectType", "BackupInstance", case_sensitive=False),
test.check("policyInfo.policyId", "/subscriptions/{subscription_id}/resourceGroups/{rg_2}/providers/Microsoft.D"
"ataProtection/Backupvaults/{myBackupVault}/backupPolicies/{myBackupPolicy2}",
case_sensitive=False),
test.check("policyInfo.policyParameters.dataStoreParametersList[0].dataStoreType", "OperationalStore",
case_sensitive=False),
test.check("policyInfo.policyParameters.dataStoreParametersList[0].objectType",
"AzureOperationalStoreParameters", case_sensitive=False),
test.check("policyInfo.policyParameters.dataStoreParametersList[0].resourceGroupId",
"/subscriptions/{subscription_id}/resourceGroups/{rg_3}", case_sensitive=False),
test.check("friendlyName", "harshitbi2", case_sensitive=False),
test.check("objectType", "BackupInstance", case_sensitive=False),
test.check("policyInfo.policyId", "/subscriptions/{subscription_id}/resourceGroups/{rg_2}/providers/Microsoft.D"
"ataProtection/Backupvaults/{myBackupVault}/backupPolicies/{myBackupPolicy2}",
case_sensitive=False),
])
step_backup_instance_list(test, checks=[
test.check('length(@)', 1),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ async def get(
:type vault_name: str
:param resource_group_name: The name of the resource group where the backup vault is present.
:type resource_group_name: str
:param backup_policy_name:
:param backup_policy_name: Name of the policy.
:type backup_policy_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: BaseBackupPolicyResource, or the result of cls(response)
Expand Down Expand Up @@ -266,7 +266,7 @@ async def delete(
:type vault_name: str
:param resource_group_name: The name of the resource group where the backup vault is present.
:type resource_group_name: str
:param backup_policy_name:
:param backup_policy_name: Name of the policy.
:type backup_policy_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None, or the result of cls(response)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ async def get(
:type resource_group_name: str
:param backup_instance_name: The name of the backup instance.
:type backup_instance_name: str
:param recovery_point_id:
:param recovery_point_id: Id of the recovery point.
:type recovery_point_id: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: AzureBackupRecoveryPointResource, or the result of cls(response)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ class AdHocBackupRuleOptions(msrest.serialization.Model):
All required parameters must be populated in order to send to Azure.
:param rule_name: Required.
:param rule_name: Required. Specify backup policy rule name.
:type rule_name: str
:param trigger_option: Required. Adhoc backup trigger option.
:type trigger_option: ~data_protection_client.models.AdhocBackupTriggerOption
Expand Down Expand Up @@ -110,7 +110,7 @@ def __init__(
class AdhocBackupTriggerOption(msrest.serialization.Model):
"""Adhoc backup trigger option.
:param retention_tag_override:
:param retention_tag_override: Specify retention override tag.
:type retention_tag_override: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ class AdHocBackupRuleOptions(msrest.serialization.Model):
All required parameters must be populated in order to send to Azure.
:param rule_name: Required.
:param rule_name: Required. Specify backup policy rule name.
:type rule_name: str
:param trigger_option: Required. Adhoc backup trigger option.
:type trigger_option: ~data_protection_client.models.AdhocBackupTriggerOption
Expand Down Expand Up @@ -122,7 +122,7 @@ def __init__(
class AdhocBackupTriggerOption(msrest.serialization.Model):
"""Adhoc backup trigger option.
:param retention_tag_override:
:param retention_tag_override: Specify retention override tag.
:type retention_tag_override: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ def get(
:type vault_name: str
:param resource_group_name: The name of the resource group where the backup vault is present.
:type resource_group_name: str
:param backup_policy_name:
:param backup_policy_name: Name of the policy.
:type backup_policy_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: BaseBackupPolicyResource, or the result of cls(response)
Expand Down Expand Up @@ -274,7 +274,7 @@ def delete(
:type vault_name: str
:param resource_group_name: The name of the resource group where the backup vault is present.
:type resource_group_name: str
:param backup_policy_name:
:param backup_policy_name: Name of the policy.
:type backup_policy_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None, or the result of cls(response)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ def get(
:type resource_group_name: str
:param backup_instance_name: The name of the backup instance.
:type backup_instance_name: str
:param recovery_point_id:
:param recovery_point_id: Id of the recovery point.
:type recovery_point_id: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: AzureBackupRecoveryPointResource, or the result of cls(response)
Expand Down
Binary file modified src/dataprotection/gen.zip
Binary file not shown.
10 changes: 5 additions & 5 deletions src/dataprotection/report.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,8 @@ az dataprotection backup-instance adhoc-backup --name "testInstance1" --rule-nam
|**--vault-name**|string|The name of the backup vault.|vault_name|vaultName|
|**--resource-group-name**|string|The name of the resource group where the backup vault is present.|resource_group_name|resourceGroupName|
|**--backup-instance-name**|string|The name of the backup instance|backup_instance_name|backupInstanceName|
|**--rule-name**|string||rule_name|ruleName|
|**--retention-tag-override**|string||retention_tag_override|retentionTagOverride|
|**--rule-name**|string|Specify backup policy rule name.|rule_name|ruleName|
|**--retention-tag-override**|string|Specify retention override tag.|retention_tag_override|retentionTagOverride|

#### <a name="BackupInstancesTriggerRestore">Command `az dataprotection backup-instance restore trigger`</a>

Expand Down Expand Up @@ -288,7 +288,7 @@ az dataprotection backup-policy show --name "OSSDBPolicy" --resource-group "000p
|------|----|-----------|----------|------------|
|**--vault-name**|string|The name of the backup vault.|vault_name|vaultName|
|**--resource-group-name**|string|The name of the resource group where the backup vault is present.|resource_group_name|resourceGroupName|
|**--backup-policy-name**|string||backup_policy_name|backupPolicyName|
|**--backup-policy-name**|string|Name of the policy|backup_policy_name|backupPolicyName|

#### <a name="BackupPoliciesCreateOrUpdate#Create">Command `az dataprotection backup-policy create`</a>

Expand Down Expand Up @@ -329,7 +329,7 @@ az dataprotection backup-policy delete --name "OSSDBPolicy" --resource-group "00
|------|----|-----------|----------|------------|
|**--vault-name**|string|The name of the backup vault.|vault_name|vaultName|
|**--resource-group-name**|string|The name of the resource group where the backup vault is present.|resource_group_name|resourceGroupName|
|**--backup-policy-name**|string||backup_policy_name|backupPolicyName|
|**--backup-policy-name**|string|Name of the policy|backup_policy_name|backupPolicyName|

### group `az dataprotection backup-vault`
#### <a name="BackupVaultsGet">Command `az dataprotection backup-vault show`</a>
Expand Down Expand Up @@ -456,7 +456,7 @@ az dataprotection recovery-point show --backup-instance-name "testInstance1" --r
|**--vault-name**|string|The name of the backup vault.|vault_name|vaultName|
|**--resource-group-name**|string|The name of the resource group where the backup vault is present.|resource_group_name|resourceGroupName|
|**--backup-instance-name**|string|The name of the backup instance|backup_instance_name|backupInstanceName|
|**--recovery-point-id**|string||recovery_point_id|recoveryPointId|
|**--recovery-point-id**|string|Id of the recovery point.|recovery_point_id|recoveryPointId|

### group `az dataprotection restorable-time-range`
#### <a name="RestorableTimeRangesFind">Command `az dataprotection restorable-time-range find`</a>
Expand Down

0 comments on commit d58ca3b

Please sign in to comment.