in src/azure-cli/azure/cli/command_modules/synapse/manual/_params.py [0:0]
def load_arguments(self, _):
# synapse workspace
for scope in ['show', 'create', 'update', 'delete']:
with self.argument_context('synapse workspace ' + scope) as c:
c.argument('workspace_name', arg_type=name_type, id_part='name', help='The workspace name.')
for scope in ['create', 'update']:
with self.argument_context('synapse workspace ' + scope) as c:
repository_arg_group = 'Git Configuration'
c.argument('sql_admin_login_password', options_list=['--sql-admin-login-password', '-p'],
help='The sql administrator login password.')
c.argument('tags', arg_type=tags_type)
c.argument('allowed_aad_tenant_ids', options_list=['--allowed-tenant-ids'], nargs='+', help="The approved Azure AD tenants which outbound data traffic allowed to. The Azure AD tenant of the current user will be included by default. Use \"\" or '' ('\"\"' in PowerShell) to disable all allowed tenant ids.")
c.argument('key_name', help='The workspace customer-managed key display name. All existing keys can be found using "az synapse workspace key list" cmdlet.')
c.argument('repository_type', arg_group=repository_arg_group, arg_type=get_enum_type(['AzureDevOpsGit', 'GitHub']), validator=validate_repository_type, help='The repository configuration type.')
c.argument('host_name', arg_group=repository_arg_group, help='If using github Enterprise Server, provide sever URL. Do not use this option with GitHub Enterprise Cloud.')
c.argument('account_name', arg_group=repository_arg_group, help='GitHub account name used for the repository or Azure devops organization name')
c.argument('collaboration_branch', arg_group=repository_arg_group, help='The branch name where you will collaborate with others and from which you will publish.')
c.argument('repository_name', arg_group=repository_arg_group, help='The name of the repository to which you are connecting.')
c.argument('root_folder', arg_group=repository_arg_group, help='The name of the folder to the location of your Azure synapse JSON resources are imported. Default is /')
c.argument('project_name', arg_group=repository_arg_group, help='The project name to which you are connecting.')
c.argument('tenant_id', arg_group=repository_arg_group, help='The tenant id used to connect Azure devops')
c.argument('last_commit_id', arg_group=repository_arg_group, help='The last commit ID.')
c.argument('user_assigned_identity_id', options_list=['--uami-id'], nargs='+', help='The list of User-assigned Managed Identity Id for workspace.')
c.argument('user_assigned_identity_in_encryption', options_list=['--uami-id-in-encrypt'], help='User assigned identity resource Id used in Workspace Encryption')
c.argument('use_system_assigned_identity_in_encryption', options_list=['--use-sami-in-encrypt'], help='Whether use System assigned identity in Workspace Encryption. If use uami, please set True.If not, set False')
with self.argument_context('synapse workspace create') as c:
c.argument('location', get_location_type(self.cli_ctx), validator=get_default_location_from_resource_group)
c.argument("storage_account", validator=validate_storage_account,
help='The data lake storage account name or resource id.')
c.argument('file_system', help='The file system of the data lake storage account.')
c.argument('sql_admin_login_user', options_list=['--sql-admin-login-user', '-u'],
help='The sql administrator login user name.')
c.argument('enable_managed_virtual_network', options_list=['--enable-managed-vnet',
'--enable-managed-virtual-network'],
arg_type=get_three_state_flag(),
help='The flag indicates whether enable managed virtual network.')
c.argument('prevent_data_exfiltration', arg_type=get_three_state_flag(),
help='The flag indicates whether enable data exfiltration.', options_list=['--prevent-exfiltration', '--prevent-data-exfiltration'])
c.argument('key_identifier', help='The customer-managed key used to encrypt all data at rest in the workspace. Key identifier should be in the format of: https://{keyvaultname}.vault.azure.net/keys/{keyname}.', options_list=['--key-identifier', '--cmk'])
c.argument('managed_resource_group_name', options_list=['--managed-rg-name'],
help=' Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId.')
with self.argument_context('synapse workspace update') as c:
c.argument('user_assigned_identity_action', options_list=['--uami-action'], arg_type=get_enum_type(['Add', 'Remove', 'Set']), help='Action must be specified when you add/remove/set user assigned managed identities for workspace.The supported actions are:Add,Remove,Set.Add means to add user assigned managed identities for workspace, Remove means to remove user assigned managed identities from workspace, Set can be used when you want to add and remove user assigned managed identities at the same time, current identities will be coverd by specified ones.')
with self.argument_context('synapse workspace check-name') as c:
c.argument('name', arg_type=name_type, help='The name you wanted to check.')
with self.argument_context('synapse workspace activate') as c:
c.argument('workspace_name', id_part='name', help='The workspace name.')
c.argument('key_identifier', help='The Key Vault Url of the workspace encryption key. should be in the format of: https://{keyvaultname}.vault.azure.net/keys/{keyname}.')
c.argument('key_name', arg_type=name_type, id_part='child_name_1', help='The workspace customer-managed key display name. All existing keys can be found using /"az synapse workspace key list/" cmdlet.')
# synapse spark pool
with self.argument_context('synapse spark pool') as c:
c.argument('workspace_name', id_part='name', help='The workspace name.')
with self.argument_context('synapse spark pool list') as c:
c.argument('workspace_name', id_part=None, help='The workspace name.')
for scope in ['show', 'create', 'update', 'delete']:
with self.argument_context('synapse spark pool ' + scope) as c:
c.argument('spark_pool_name', arg_type=name_type, id_part='child_name_1',
help='The name of the Spark pool.')
with self.argument_context('synapse spark pool create') as c:
# Node
c.argument('node_count', type=int, arg_group='Node', help='The number of node.')
c.argument('node_size_family', arg_group='Node', arg_type=get_enum_type(['None', 'MemoryOptimized', 'HardwareAcceleratedFPGA', 'HardwareAcceleratedGPU']),
help='The kind of nodes that the Big Data pool provides')
c.argument('node_size', arg_group='Node', arg_type=get_enum_type(['None', 'Small', 'Medium', 'Large', 'XLarge', 'XXLarge', 'XXXLarge']),
help='The level of compute power that each node in the Big Data pool has..')
# AutoScale
c.argument('enable_auto_scale', arg_type=get_three_state_flag(), arg_group='AutoScale',
help='The flag of enabling auto scale.')
c.argument('max_node_count', type=int, arg_group='AutoScale', help='The max node count.')
c.argument('min_node_count', type=int, arg_group='AutoScale', help='The min node count.')
# AutoPause
c.argument('enable_auto_pause', arg_type=get_three_state_flag(), arg_group='AutoPause',
help='The flag of enabling auto pause.')
c.argument('delay', arg_group='AutoPause', help='The delay time whose unit is minute.')
# Environment Configuration
c.argument('library_requirements', arg_group='Environment Configuration',
help='The library requirements file.')
# Default Folder
c.argument('spark_events_folder', arg_group='Default Folder', help='The Spark events folder.')
c.argument('spark_log_folder', arg_group='Default Folder', help='The default Spark log folder.')
# Component Version
c.argument('spark_version', arg_group='Component Version', help='The supported Spark version is 2.4 now.')
# Spark config file
c.argument('spark_config_file_path', arg_group='Environment Configuration', help='Absolute path of Spark pool properties configuration file.')
# Dynamic executor allocation
c.argument('enable_dynamic_executor_allocation', arg_type=get_three_state_flag(), arg_group='DynamicExecutor',
options_list=['--enable-dynamic-exec'], help='Indicates whether Dynamic Executor Allocation is enabled or not.')
c.argument('max_executors', type=int, arg_group='DynamicExecutor', help='The maximum number of executors alloted.')
c.argument('min_executors', type=int, arg_group='DynamicExecutor', help='The minimum number of executors alloted.')
c.argument('tags', arg_type=tags_type)
with self.argument_context('synapse spark pool update') as c:
c.argument('tags', arg_type=tags_type)
# Node
c.argument('node_count', type=int, arg_group='Node', help='The number of node.')
c.argument('node_size_family', arg_group='Node', arg_type=get_enum_type(['None', 'MemoryOptimized', 'HardwareAcceleratedFPGA', 'HardwareAcceleratedGPU']),
help='The kind of nodes that the Big Data pool provides')
c.argument('node_size', arg_group='Node', arg_type=get_enum_type(['None', 'Small', 'Medium', 'Large', 'XLarge', 'XXLarge', 'XXXLarge']),
help='The level of compute power that each node in the Big Data pool has..')
# AutoScale
c.argument('enable_auto_scale', arg_type=get_three_state_flag(), arg_group='AutoScale',
help='The flag of enabling auto scale.')
c.argument('max_node_count', type=int, arg_group='AutoScale', help='The max node count.')
c.argument('min_node_count', type=int, arg_group='AutoScale', help='The min node count.')
# AutoPause
c.argument('enable_auto_pause', arg_type=get_three_state_flag(), arg_group='AutoPause',
help='The flag of enabling auto pause.')
c.argument('delay', arg_group='AutoPause', help='The delay time whose unit is minute.')
# Environment Configuration
c.argument('library_requirements', arg_group='Environment Configuration',
help='The library requirements file.')
c.argument('force', arg_type=get_three_state_flag(), help='The flag of force operation.')
# Custom Libraries
c.argument('package_action', arg_group='Custom Libraries', arg_type=get_enum_type(['Add', 'Remove']),
help='Package action must be specified when you add or remove a workspace package from a Apache Spark pool.')
c.argument('package', arg_group='Custom Libraries', nargs='+', help='List of workspace packages name.')
# Spark config file
c.argument('spark_config_file_path', arg_group='Environment Configuration', help='Absolute path of Spark pool properties configuration file.')
# Dynamic executor allocation
c.argument('enable_dynamic_executor_allocation', arg_type=get_three_state_flag(), arg_group='DynamicExecutor',
options_list=['--enable-dynamic-exec'], help='Indicates whether Dynamic Executor Allocation is enabled or not.')
c.argument('max_executors', type=int, arg_group='DynamicExecutor', help='The maximum number of executors alloted.')
c.argument('min_executors', type=int, arg_group='DynamicExecutor', help='The minimum number of executors alloted.')
# synapse sql pool
with self.argument_context('synapse sql pool') as c:
c.argument('workspace_name', id_part='name', help='The workspace name.')
with self.argument_context('synapse sql pool list') as c:
c.argument('workspace_name', id_part=None, help='The workspace name.')
with self.argument_context('synapse sql pool list-deleted') as c:
c.argument('workspace_name', id_part=None, help='The workspace name.')
for scope in ['show', 'create', 'delete', 'update', 'pause', 'resume', 'restore', 'show-connection-string']:
with self.argument_context('synapse sql pool ' + scope) as c:
c.argument('sql_pool_name', arg_type=name_type, id_part='child_name_1', help='The SQL pool name.')
with self.argument_context('synapse sql pool create') as c:
c.argument('performance_level', help='The performance level.')
c.argument('source_database_id', help='The source database id.')
c.argument('recoverable_database_id', help='The recoverable database id.')
c.argument('tags', arg_type=tags_type)
c.argument('storage_account_type',
options_list=['--storage-type'],
arg_group=storage_arg_group,
help='The Storage Account Type.',
arg_type=get_enum_type(['GRS', 'LRS']))
c.argument('collation',
help='Collation defines the rules that sort and compare data, and cannot be changed after SQL pool creation. The default collation is "SQL_Latin1_General_CP1_CI_AS".')
with self.argument_context('synapse sql pool update') as c:
c.argument('sku_name', options_list=['--performance-level'], help='The performance level.')
c.argument('tags', arg_type=tags_type)
with self.argument_context('synapse sql pool restore') as c:
c.argument('performance_level', help='The performance level.')
c.argument('destination_name', options_list=['--dest-name', '--destination-name'],
help='Name of the sql pool that will be created as the restore destination.')
c.argument('storage_account_type',
options_list=['--storage-type'],
arg_group=storage_arg_group,
help='The Storage Account Type.',
arg_type=get_enum_type(['GRS', 'LRS']))
c.argument('tags', arg_type=tags_type)
restore_point_arg_group = 'Restore Point'
c.argument('restore_point_in_time',
options_list=['--time', '-t'],
arg_group=restore_point_arg_group,
help='The point in time of the source database that will be restored to create the new database. Must be greater than or equal to the source database\'s earliestRestoreDate value. Either --time or --deleted-time (or both) must be specified. {0}'.format(
time_format_help))
c.argument('source_database_deletion_date',
options_list=['--deleted-time'],
arg_group=restore_point_arg_group,
help='If specified, restore from a deleted database instead of from an existing database. Must match the deleted time of a deleted database in the same server. Either --time or --deleted-time (or both) must be specified. {0}'.format(
time_format_help))
with self.argument_context('synapse sql pool show-connection-string') as c:
c.argument('client_provider',
options_list=['--client', '-c'],
help='Type of client connection provider.',
arg_type=get_enum_type(SqlPoolConnectionClientType))
auth_group = 'Authentication'
c.argument('auth_type',
options_list=['--auth-type', '-a'],
arg_group=auth_group,
help='Type of authentication.',
arg_type=get_enum_type(SqlPoolConnectionClientAuthenticationType))
# synapse sql pool classification
with self.argument_context('synapse sql pool classification') as c:
c.argument('sql_pool_name', arg_type=name_type, id_part='child_name_1', help='The SQL pool name.')
with self.argument_context('synapse sql pool classification list') as c:
c.argument('workspace_name', id_part=None, help='The workspace name.')
with self.argument_context('synapse sql pool classification recommendation list') as c:
c.argument('workspace_name', id_part=None, help='The workspace name.')
c.argument('include_disabled_recommendations', options_list=['--included-disabled'],
arg_type=get_three_state_flag(),
help='Indicates whether the result should include disabled recommendations')
for scope in ['show', 'create', 'update', 'delete', 'recommendation enable', 'recommendation disable']:
with self.argument_context('synapse sql pool classification ' + scope) as c:
c.argument('schema_name', help='The name of schema.', options_list=['--schema'])
c.argument('table_name', help='The name of table.', options_list=['--table'])
c.argument('column_name', help='The name of column.', options_list=['--column'])
c.argument('information_type', help='The information type.')
c.argument('label_name', help='The label name.', options_list=['--label'])
# synapse sql pool tde
with self.argument_context('synapse sql pool tde') as c:
c.argument('sql_pool_name', arg_type=name_type, id_part='child_name_1', help='The SQL pool name.')
c.argument('status', arg_type=get_enum_type(TransparentDataEncryptionStatus),
required=True, help='Status of the transparent data encryption.')
c.argument('transparent_data_encryption_name', options_list=['--transparent-data-encryption-name', '-d'], help='Name of the transparent data encryption.')
# synapse sql pool threat-policy
with self.argument_context('synapse sql pool threat-policy') as c:
c.argument('sql_pool_name', arg_type=name_type, id_part='child_name_1', help='The SQL pool name.')
c.argument('security_alert_policy_name', options_list=['--security-alert-policy-name', '-s'],
help='Name of the security alert policy.')
with self.argument_context('synapse sql pool threat-policy update') as c:
_configure_security_or_audit_policy_storage_params(c)
notification_arg_group = 'Notification'
policy_arg_group = 'Policy'
c.argument('state',
arg_group=policy_arg_group,
help='Threat detection policy state',
arg_type=get_enum_type(SecurityAlertPolicyState))
c.argument('retention_days',
type=int,
arg_group=policy_arg_group,
help='The number of days to retain threat detection logs.')
c.argument('disabled_alerts',
arg_group=policy_arg_group,
help='List of disabled alerts.',
nargs='+')
c.argument('email_addresses',
arg_group=notification_arg_group,
help='List of email addresses that alerts are sent to.',
nargs='+')
c.argument('email_account_admins',
arg_group=notification_arg_group,
help='Whether the alert is sent to the account administrators.',
arg_type=get_three_state_flag())
# synapse sql pool audit-policy
for scope in ['show', 'update']:
with self.argument_context('synapse sql pool audit-policy ' + scope) as c:
c.argument('sql_pool_name', arg_type=name_type, id_part='child_name_1', help='The SQL pool name.')
for scope in ['synapse sql pool audit-policy', 'synapse sql audit-policy']:
with self.argument_context(scope + ' update') as c:
_configure_security_or_audit_policy_storage_params(c)
policy_arg_group = 'Policy'
c.argument('storage_account_subscription_id', arg_group=storage_arg_group,
options_list=['--storage-subscription'],
help='The subscription id of storage account')
c.argument('is_storage_secondary_key_in_use', arg_group=storage_arg_group,
arg_type=get_three_state_flag(), options_list=['--use-secondary-key'],
help='Indicates whether using the secondary storeage key or not')
c.argument('is_azure_monitor_target_enabled', options_list=['--enable-azure-monitor'],
help='Whether enabling azure monitor target or not.',
arg_type=get_three_state_flag())
c.argument('state',
arg_group=policy_arg_group,
help='Auditing policy state',
arg_type=get_enum_type(BlobAuditingPolicyState))
c.argument('audit_actions_and_groups',
options_list=['--actions'],
arg_group=policy_arg_group,
help='List of actions and action groups to audit.',
nargs='+')
c.argument('retention_days',
type=int,
arg_group=policy_arg_group,
help='The number of days to retain audit logs.')
c.argument('blob_storage_target_state',
arg_group=storage_arg_group,
options_list=['--blob-storage-target-state', '--bsts'],
configured_default='sql-server',
help='Indicate whether blob storage is a destination for audit records.',
arg_type=get_enum_type(BlobAuditingPolicyState))
c.argument('log_analytics_target_state',
arg_group=log_analytics_arg_group,
options_list=['--log-analytics-target-state', '--lats'],
configured_default='sql-server',
help='Indicate whether log analytics is a destination for audit records.',
arg_type=get_enum_type(BlobAuditingPolicyState))
c.argument('log_analytics_workspace_resource_id',
arg_group=log_analytics_arg_group,
options_list=['--log-analytics-workspace-resource-id', '--lawri'],
configured_default='sql-server',
help='The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace '
'to which you would like to send Audit Logs.')
c.argument('event_hub_target_state',
arg_group=event_hub_arg_group,
options_list=['--event-hub-target-state', '--ehts'],
configured_default='sql-server',
help='Indicate whether event hub is a destination for audit records.',
arg_type=get_enum_type(BlobAuditingPolicyState))
c.argument('event_hub_authorization_rule_id',
arg_group=event_hub_arg_group,
options_list=['--event-hub-authorization-rule-id', '--ehari'],
configured_default='sql-server',
help='The resource Id for the event hub authorization rule.')
c.argument('event_hub',
arg_group=event_hub_arg_group,
options_list=['--event-hub', '--eh'],
configured_default='sql-server',
help='The name of the event hub. If none is specified '
'when providing event_hub_authorization_rule_id, the default event hub will be selected.'
)
with self.argument_context('synapse sql audit-policy update') as c:
c.argument('queue_delay_milliseconds', type=int,
options_list=['--queue-delay-time', '--queue-delay-milliseconds'],
help='The amount of time in milliseconds that can elapse before audit actions are forced to be processed')
c.argument('storage_account',
options_list=['--storage-account'],
arg_group=storage_arg_group,
help='Name of the storage account.')
c.argument('storage_account_access_key',
options_list=['--storage-key'],
arg_group=storage_arg_group,
help='Access key for the storage account.')
c.argument('storage_endpoint',
arg_group=storage_arg_group,
help='The storage account endpoint.')
_configure_security_policy_storage_params(c)
policy_arg_group = 'Policy'
c.argument('state',
arg_group=policy_arg_group,
help='Auditing policy state',
arg_type=get_enum_type(BlobAuditingPolicyState))
c.argument('audit_actions_and_groups',
options_list=['--actions'],
arg_group=policy_arg_group,
help='List of actions and action groups to audit.',
nargs='+')
c.argument('retention_days',
arg_group=policy_arg_group,
help='The number of days to retain audit logs.')
c.argument('blob_storage_target_state',
arg_group=storage_arg_group,
options_list=['--blob-storage-target-state', '--bsts'],
configured_default='sql-server',
help='Indicate whether blob storage is a destination for audit records.',
arg_type=get_enum_type(BlobAuditingPolicyState))
c.argument('log_analytics_target_state',
arg_group=log_analytics_arg_group,
options_list=['--log-analytics-target-state', '--lats'],
configured_default='sql-server',
help='Indicate whether log analytics is a destination for audit records.',
arg_type=get_enum_type(BlobAuditingPolicyState))
c.argument('log_analytics_workspace_resource_id',
arg_group=log_analytics_arg_group,
options_list=['--log-analytics-workspace-resource-id', '--lawri'],
configured_default='sql-server',
help='The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace '
'to which you would like to send Audit Logs.')
c.argument('event_hub_target_state',
arg_group=event_hub_arg_group,
options_list=['--event-hub-target-state', '--ehts'],
configured_default='sql-server',
help='Indicate whether event hub is a destination for audit records.',
arg_type=get_enum_type(BlobAuditingPolicyState))
c.argument('event_hub_authorization_rule_id',
arg_group=event_hub_arg_group,
options_list=['--event-hub-authorization-rule-id', '--ehari'],
configured_default='sql-server',
help='The resource Id for the event hub authorization rule.')
c.argument('event_hub',
arg_group=event_hub_arg_group,
options_list=['--event-hub', '--eh'],
configured_default='sql-server',
help='The name of the event hub. If none is specified '
'when providing event_hub_authorization_rule_id, the default event hub will be selected.'
)
with self.argument_context('synapse sql audit-policy') as c:
c.argument('workspace_name', help='The workspace name.')
with self.argument_context('synapse sql ad-admin') as c:
c.argument('workspace_name', help='The workspace name.')
for scope in ['create', 'update']:
with self.argument_context('synapse sql ad-admin ' + scope) as c:
c.argument('login_name', options_list=['--display-name', '-u'],
help='Display name of the Azure AD administrator user or group.')
c.argument('object_id', options_list=['--object-id', '-i'],
help='The unique ID of the Azure AD administrator.')
# synapse workspace firewall-rule
with self.argument_context('synapse workspace firewall-rule') as c:
c.argument('workspace_name', id_part='name', help='The workspace name.')
with self.argument_context('synapse workspace firewall-rule list') as c:
c.argument('workspace_name', id_part=None, help='The workspace name.')
for scope in ['show', 'create', 'update', 'delete']:
with self.argument_context('synapse workspace firewall-rule ' + scope) as c:
c.argument('rule_name', arg_type=name_type, id_part='child_name_1', help='The IP firewall rule name')
for scope in ['create', 'update']:
with self.argument_context('synapse workspace firewall-rule ' + scope) as c:
c.argument('start_ip_address', help='The start IP address of the firewall rule. Must be IPv4 format.')
c.argument('end_ip_address', help='The end IP address of the firewall rule. Must be IPv4 format. '
'Must be greater than or equal to startIpAddress.')
# synapse workspace key
with self.argument_context('synapse workspace key') as c:
c.argument('workspace_name', id_part='name', help='The workspace name.')
with self.argument_context('synapse workspace key list') as c:
c.argument('workspace_name', id_part=None, help='The workspace name.')
for scope in ['show', 'create', 'delete']:
with self.argument_context('synapse workspace key ' + scope) as c:
c.argument('key_name', arg_type=name_type, id_part='child_name_1', help='The workspace customer-managed key display name. All existing keys can be found using /"az synapse workspace key list/" cmdlet.')
with self.argument_context('synapse workspace key create') as c:
c.argument('key_identifier', help='The Key Vault Url of the workspace encryption key. should be in the format of: https://{keyvaultname}.vault.azure.net/keys/{keyname}.')
# synapse workspace managed-identity
with self.argument_context('synapse workspace managed-identity') as c:
c.argument('workspace_name', id_part='name', help='The workspace name.')
for scope in ['grant-sql-access', 'revoke-sql-access', ' show-sql-access']:
with self.argument_context('synapse workspace managed-identity ' + scope) as c:
c.argument('workspace_name', id_part='name', help='The workspace name.')
# synapse spark job
for scope in ['job', 'session', 'statement']:
with self.argument_context('synapse spark ' + scope) as c:
c.argument('workspace_name', help='The name of the workspace.')
c.argument('spark_pool_name', help='The name of the Spark pool.')
for scope in ['synapse spark job', 'synapse spark session']:
with self.argument_context(scope + ' list') as c:
c.argument('from_index', help='Optional parameter specifying which index the list should begin from.')
c.argument('size',
help='The size of the returned list.By default it is 20 and that is the maximum.')
with self.argument_context('synapse spark job submit') as c:
c.argument('main_definition_file', help='The main file used for the job.')
c.argument('main_class_name',
help='The fully-qualified identifier or the main class that is in the main definition file.')
c.argument('command_line_arguments', options_list=['--arguments'], type=split, nargs='+',
help='Optional arguments to the job (Note: please use storage URIs for file arguments).')
c.argument('archives', nargs='+', help='The array of archives.')
c.argument('job_name', arg_type=name_type, help='The Spark job name.')
c.argument('python_files', nargs='+',
help='The array of files used for refenence in the main python definition file. Examples include custom whl files and custom python files. May pass multiple files such as `az synapse spark job sumbit <other_args> --python_files abfss://file1 abss://file2`')
c.argument('reference_files', nargs='+',
help='Additional files used for reference in the main definition file.')
c.argument('configuration', type=shell_safe_json_parse, help='The configuration of Spark job.')
c.argument('executors', help='The number of executors.')
c.argument('executor_size', arg_type=get_enum_type(['Small', 'Medium', 'Large']), help='The executor size')
c.argument('tags', arg_type=tags_type)
c.argument('language', arg_type=get_enum_type(SparkBatchLanguage, default=SparkBatchLanguage.Scala),
help='The Spark job language.')
for scope in ['show', 'cancel']:
with self.argument_context('synapse spark job ' + scope) as c:
c.argument('job_id', options_list=['--livy-id'], arg_group='Spark job',
help='The id of the Spark job.')
with self.argument_context('synapse spark session create') as c:
c.argument('job_name', arg_type=name_type, help='The Spark session name.')
c.argument('reference_files', nargs='+',
help='Additional files used for reference in the main definition file.')
c.argument('configuration', type=get_json_object, help='The configuration of Spark session.')
c.argument('executors', help='The number of executors.')
c.argument('executor_size', arg_type=get_enum_type(['Small', 'Medium', 'Large']), help='The executor size')
c.argument('tags', arg_type=tags_type)
for scope in ['show', 'cancel', 'reset-timeout']:
with self.argument_context('synapse spark session ' + scope) as c:
c.argument('session_id', options_list=['--livy-id'], arg_group='Spark Session',
help='The id of the Spark session job.')
with self.argument_context('synapse spark statement') as c:
c.argument('session_id', help='The id of Spark session.')
for scope in ['show', 'cancel']:
with self.argument_context('synapse spark statement ' + scope) as c:
c.argument('statement_id', options_list=['--livy-id'], arg_group="Spark statement",
help='The id of the statement.')
with self.argument_context('synapse spark statement invoke') as c:
c.argument('code', completer=FilesCompleter(),
help='The code of Spark statement. This is either the code contents or use `@<file path>` to load the content from a file')
c.argument('language', arg_type=get_enum_type(SparkStatementLanguage), validator=validate_statement_language,
help='The language of Spark statement.')
# synapse workspace access-control
for scope in ['create', 'list']:
with self.argument_context('synapse role assignment ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('role', arg_type=role_arg_type)
c.argument('assignee', arg_type=assignee_arg_type)
c.argument('assignee_object_id', arg_type=assignee_object_id_arg_type)
c.argument('scope', help='A scope defines the resources or artifacts that the access applies to. Synapse supports hierarchical scopes. '
'Permissions granted at a higher-level scope are inherited by objects at a lower level. '
'In Synapse RBAC, the top-level scope is a workspace. '
'Assigning a role with workspace scope grants permissions to all applicable objects in the workspace.')
c.argument('item', help='Item granted access in the workspace. Using with --item-type to combine the scope of assignment')
c.argument('item_type', arg_type=get_enum_type(ItemType), help='Item type granted access in the workspace. Using with --item to combine the scope of assignment.')
with self.argument_context('synapse role assignment create') as c:
c.argument('assignee_principal_type', options_list=['--assignee-principal-type', '--assignee-type'], arg_type=get_enum_type(PrincipalType),
help='use with --assignee-object-id to avoid errors caused by propagation latency in AAD Graph')
c.argument('assignment_id', help='Custom role assignment id in guid format, if not specified, assignment id will be randomly generated.')
with self.argument_context('synapse role assignment show') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('role_assignment_id', options_list=['--id'],
help='Id of the role that is assigned to the principal.')
with self.argument_context('synapse role assignment delete') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('role', arg_type=role_arg_type)
c.argument('assignee', arg_type=assignee_arg_type)
c.argument('assignee_object_id', arg_type=assignee_object_id_arg_type)
c.argument('scope', help='A scope defines the resources or artifacts that the access applies to. Synapse supports hierarchical scopes. '
'Permissions granted at a higher-level scope are inherited by objects at a lower level. '
'In Synapse RBAC, the top-level scope is a workspace. '
'Using az role assignment with filter condition before executing delete operation '
'to be clearly aware of which assignments will be deleted.')
c.argument('ids', nargs='+',
help='space-separated role assignment ids. You should not provide --role or --assignee when --ids is provided.')
c.argument('item', help='Item granted access in the workspace. Using with --item-type to combine the scope of assignment.'
'Using az role assignment with filter condition before executing delete operation '
'to be clearly aware of which assignments will be deleted.')
c.argument('item_type', arg_type=get_enum_type(ItemType), help='Item type granted access in the workspace. Using with --item to combine the scope of assignment.'
'Using az role assignment with filter condition before executing delete operation '
'to be clearly aware of which assignments will be deleted.')
with self.argument_context('synapse role definition show') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('role', arg_type=role_arg_type)
with self.argument_context('synapse role definition list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('is_built_in', arg_type=get_three_state_flag(), help='Is a Synapse Built-In Role or not.')
with self.argument_context('synapse role scope list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
# synapse artifacts linked-service
for scope in ['create', 'update', 'set']:
with self.argument_context('synapse linked-service ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('linked_service_name', arg_type=name_type, help='The linked service name.')
c.argument('definition_file', arg_type=definition_file_arg_type)
with self.argument_context('synapse linked-service list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
with self.argument_context('synapse linked-service show') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('linked_service_name', arg_type=name_type, help='The linked service name.')
with self.argument_context('synapse linked-service delete') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('linked_service_name', arg_type=name_type, help='The linked service name.')
# synapse artifacts dataset
for scope in ['create', 'update', 'set']:
with self.argument_context('synapse dataset ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('dataset_name', arg_type=name_type, help='The dataset name.')
c.argument('definition_file', arg_type=definition_file_arg_type)
with self.argument_context('synapse dataset list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
with self.argument_context('synapse dataset show') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('dataset_name', arg_type=name_type, help='The dataset name.')
with self.argument_context('synapse dataset delete') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('dataset_name', arg_type=name_type, help='The dataset name.')
# synapse artifacts pipeline
for scope in ['create', 'update', 'set']:
with self.argument_context('synapse pipeline ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('pipeline_name', arg_type=name_type, help='The pipeline name.')
c.argument('definition_file', arg_type=definition_file_arg_type)
with self.argument_context('synapse pipeline list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
with self.argument_context('synapse pipeline show') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('pipeline_name', arg_type=name_type, help='The pipeline name.')
with self.argument_context('synapse pipeline delete') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('pipeline_name', arg_type=name_type, help='The pipeline name.')
with self.argument_context('synapse pipeline create-run') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('pipeline_name', arg_type=name_type, help='The pipeline name.')
c.argument('reference_pipeline_run_id', options_list=['--reference-pipeline-run-id', '--run-id'],
help='The pipeline run ID for rerun. If run ID is specified, the parameters of the specified run will be used to create a new run.')
c.argument('is_recovery', arg_type=get_three_state_flag(),
help='Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.')
c.argument('start_activity_name',
help='In recovery mode, the rerun will start from this activity. If not specified, all activities will run.')
c.argument('parameters', completer=FilesCompleter(), type=shell_safe_json_parse,
help='Parameters for pipeline run. Can be supplied from a JSON file using the `@{path}` syntax or a JSON string.')
# synapse artifacts pipeline run
with self.argument_context('synapse pipeline-run query-by-workspace') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('continuation_token',
help='The continuation token for getting the next page of results. Null for first page.')
c.argument('last_updated_after',
help='The time at or after which the run event was updated in \'ISO 8601\' format.')
c.argument('last_updated_before',
help='The time at or before which the run event was updated in \'ISO 8601\' format.')
c.argument('filters', action=AddFilters, nargs='*', help='List of filters.')
c.argument('order_by', action=AddOrderBy, nargs='*', help='List of OrderBy option.')
with self.argument_context('synapse pipeline-run show') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('run_id', help='The pipeline run identifier.')
with self.argument_context('synapse pipeline-run cancel') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('run_id', help='The pipeline run identifier.')
c.argument('is_recursive', arg_type=get_three_state_flag(),
help='If true, cancel all the Child pipelines that are triggered by the current pipeline.')
with self.argument_context('synapse activity-run query-by-pipeline-run') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('pipeline_name', arg_type=name_type, help='The pipeline name.')
c.argument('run_id', help='The pipeline run identifier.')
c.argument('continuation_token',
help='The continuation token for getting the next page of results. Null for first page.')
c.argument('last_updated_after',
help='The time at or after which the run event was updated in \'ISO 8601\' format.')
c.argument('last_updated_before',
help='The time at or before which the run event was updated in \'ISO 8601\' format.')
c.argument('filters', action=AddFilters, nargs='*', help='List of filters.')
c.argument('order_by', action=AddOrderBy, nargs='*', help='List of OrderBy option.')
# synapse artifacts trigger
for scope in ['create', 'update', 'set']:
with self.argument_context('synapse trigger ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('trigger_name', arg_type=name_type, help='The trigger name.')
c.argument('definition_file', arg_type=definition_file_arg_type)
with self.argument_context('synapse trigger list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
with self.argument_context('synapse trigger show') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('trigger_name', arg_type=name_type, help='The trigger name.')
with self.argument_context('synapse trigger delete') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('trigger_name', arg_type=name_type, help='The trigger name.')
with self.argument_context('synapse trigger subscribe-to-event') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('trigger_name', arg_type=name_type, help='The trigger name.')
with self.argument_context('synapse trigger get-event-subscription-status') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('trigger_name', arg_type=name_type, help='The trigger name.')
with self.argument_context('synapse trigger unsubscribe-from-event') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('trigger_name', arg_type=name_type, help='The trigger name.')
with self.argument_context('synapse trigger start') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('trigger_name', arg_type=name_type, help='The trigger name.')
with self.argument_context('synapse trigger stop') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('trigger_name', arg_type=name_type, help='The trigger name.')
with self.argument_context('synapse trigger wait') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('trigger_name', arg_type=name_type, help='The trigger name.')
# synapse artifacts trigger run
with self.argument_context('synapse trigger-run rerun') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('trigger_name', arg_type=name_type, help='The trigger name.')
c.argument('run_id', help='The trigger run identifier.')
with self.argument_context('synapse trigger-run cancel') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('trigger_name', arg_type=name_type, help='The trigger name.')
c.argument('run_id', help='The trigger run identifier.')
with self.argument_context('synapse trigger-run query-by-workspace') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('continuation_token',
help='The continuation token for getting the next page of results. Null for first page.')
c.argument('last_updated_after',
help='The time at or after which the run event was updated in \'ISO 8601\' format.')
c.argument('last_updated_before',
help='The time at or before which the run event was updated in \'ISO 8601\' format.')
c.argument('filters', action=AddFilters, nargs='*', help='List of filters.')
c.argument('order_by', action=AddOrderBy, nargs='*', help='List of OrderBy option.')
# synapse artifacts data flow
for scope in ['create', 'set']:
with self.argument_context('synapse data-flow ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('data_flow_name', arg_type=name_type, help='The data flow name.')
c.argument('definition_file', arg_type=definition_file_arg_type)
with self.argument_context('synapse data-flow list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
with self.argument_context('synapse data-flow show') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('data_flow_name', arg_type=name_type, help='The data flow name.')
with self.argument_context('synapse data-flow delete') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('data_flow_name', arg_type=name_type, help='The data flow name.')
# synapse artifacts notebook
for scope in ['create', 'set', 'import']:
with self.argument_context('synapse notebook ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('notebook_name', arg_type=name_type, help='The notebook name.')
c.argument('definition_file', arg_type=definition_file_arg_type)
c.argument('spark_pool_name', help='The name of the Spark pool.')
c.argument('executor_size', arg_type=get_enum_type(['Small', 'Medium', 'Large']),
help='Number of core and memory to be used for executors allocated in the specified Spark pool for the job.')
c.argument('executor_count',
help='Number of executors to be allocated in the specified Spark pool for the job.')
c.argument('folder_path',
help='The folder that this notebook is in. If not specified, this notebook will appear at the root level. Eg: folder/subfolder1')
with self.argument_context('synapse notebook list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
with self.argument_context('synapse notebook show') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('notebook_name', arg_type=name_type, help='The notebook name.')
with self.argument_context('synapse notebook export') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('output_folder', help='The folder where the notebook should be placed.')
c.argument('notebook_name', arg_type=name_type, help='The notebook name.')
with self.argument_context('synapse notebook delete') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('notebook_name', arg_type=name_type, help='The notebook name.')
# synapse artifacts library
with self.argument_context('synapse workspace-package') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.ignore('progress_callback')
for scope in ['show', 'delete']:
with self.argument_context('synapse workspace-package ' + scope) as c:
c.argument('package_name', arg_type=name_type, options_list=['--package-name', '--package', '--name', '-n'], help='The workspace package name.')
with self.argument_context('synapse workspace-package upload') as c:
c.argument('package', options_list=('--package', '--file', '-f'), type=file_type, completer=FilesCompleter(),
help='Specifies a local file path for a file to upload as workspace package.')
c.extra('no_progress', progress_type)
with self.argument_context('synapse workspace-package upload-batch') as c:
c.argument('source', options_list=('--source', '-s'), help='The directory where the files to be uploaded are located.')
c.extra('no_progress', progress_type)
# synapse integration runtime
with self.argument_context('synapse integration-runtime') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type, id_part='name')
for scope in ['list', 'list-auth-key', 'wait']:
with self.argument_context('synapse integration-runtime ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type, id_part=None)
for scope in ['list-auth-key', 'wait']:
with self.argument_context('synapse integration-runtime ' + scope) as c:
c.argument('integration_runtime_name', arg_type=name_type, help='The integration runtime name.', id_part=None)
for scope in ['show', 'create', 'managed create', 'self-hosted create', 'delete', 'wait', 'update', 'upgrade', 'regenerate-auth-key', 'get-monitoring-data', 'sync-credentials', 'get-connection-info', 'get-status', 'start', 'stop']:
with self.argument_context('synapse integration-runtime ' + scope) as c:
c.argument('integration_runtime_name', arg_type=name_type, help='The integration runtime name.', id_part='child_name_1')
with self.argument_context('synapse integration-runtime create') as c:
c.argument('integration_runtime_type', options_list=['--type'], arg_type=get_enum_type(['Managed', 'SelfHosted']), help='The integration runtime type.')
c.argument('description', help='The integration runtime description.')
c.argument('if_match', help='ETag of the integration runtime entity. Should only be specified for update, for '
'which it should match existing entity or can be * for unconditional update.')
# Managed
c.argument('location', arg_group='Managed', help='The integration runtime location.')
c.argument('compute_type', arg_group='Managed', arg_type=get_enum_type(['General', 'MemoryOptimized', 'ComputeOptimized']),
help='Compute type of the data flow cluster which will execute data flow job.')
c.argument('core_count', arg_group='Managed', help='Core count of the data flow cluster which will execute data flow job.')
c.argument('time_to_live', arg_group='Managed', help='Time to live (in minutes) setting of the data flow cluster which will execute data flow job.')
with self.argument_context('synapse integration-runtime managed create') as c:
c.argument('description', help='The integration runtime description.')
c.argument('if_match', help='ETag of the integration runtime entity. Should only be specified for update, for '
'which it should match existing entity or can be * for unconditional update.')
c.argument('location', help='The integration runtime location.')
c.argument('compute_type', arg_type=get_enum_type(['General', 'MemoryOptimized', 'ComputeOptimized']),
help='Compute type of the data flow cluster which will execute data flow job.')
c.argument('core_count', help='Core count of the data flow cluster which will execute data flow job.')
c.argument('time_to_live', help='Time to live (in minutes) setting of the data flow cluster which will execute data flow job.')
with self.argument_context('synapse integration-runtime self-hosted create') as c:
c.argument('description', help='The integration runtime description.')
c.argument('if_match', help='ETag of the integration runtime entity. Should only be specified for update, for '
'which it should match existing entity or can be * for unconditional update.')
with self.argument_context('synapse integration-runtime update') as c:
c.argument('auto_update', arg_type=get_enum_type(['On', 'Off']), help='Enable or disable the self-hosted integration runtime auto-update.')
c.argument('update_delay_offset', help='The time of the day for the self-hosted integration runtime auto-update.')
with self.argument_context('synapse integration-runtime regenerate-auth-key') as c:
c.argument('key_name', arg_type=get_enum_type(['authKey1', 'authKey2']), help='The name of the authentication key to regenerate.')
with self.argument_context('synapse integration-runtime-node') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type, id_part='name')
c.argument('integration_runtime_name', arg_type=name_type, help='The integration runtime name.', id_part='child_name_1')
for scope in ['show', 'update', 'delete', 'get-ip-address']:
with self.argument_context('synapse integration-runtime-node ' + scope) as c:
c.argument('node_name', help='The integration runtime node name.')
with self.argument_context('synapse integration-runtime-node update') as c:
c.argument('concurrent_jobs_limit', options_list=['--concurrent-jobs'], help='The number of concurrent jobs permitted to '
'run on the integration runtime node. Values between 1 and maxConcurrentJobs are allowed.')
c.argument('auto_update', arg_type=get_enum_type(['On', 'Off']),
help='Enable or disable the self-hosted integration runtime auto-update.')
c.argument('update_delay_offset',
help='The time of the day for the self-hosted integration runtime auto-update.')
# synapse managed private endpoints
for scope in ['show', 'create', 'delete']:
with self.argument_context('synapse managed-private-endpoints ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type, id_part='name')
c.argument('managed_private_endpoint_name', options_list=['--pe-name'], help='The managed private endpoint name.')
with self.argument_context('synapse managed-private-endpoints list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
with self.argument_context('synapse managed-private-endpoints create') as c:
c.argument('private_Link_Resource_Id',
options_list=['--resource-id'],
help='The ARM resource ID of the resource to which the managed private endpoint is created. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}',
deprecate_info=c.deprecate(hide=True))
c.argument('group_Id',
help='The groupId to which the managed private endpoint is created',
deprecate_info=c.deprecate(hide=True))
c.argument('definition_file', arg_type=definition_file_arg_type)
# synapse artifacts spark job definition
with self.argument_context('synapse spark-job-definition list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
for scope in ['show', 'wait', 'delete']:
with self.argument_context('synapse spark-job-definition ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('spark_job_definition_name', options_list=['--name', '-n'], help='The spark job definition name')
for scope in ['create', 'update']:
with self.argument_context('synapse spark-job-definition ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('spark_job_definition_name', options_list=['--name', '-n'], help='The spark job definition name')
c.argument('definition_file', arg_type=definition_file_arg_type)
c.argument('folder_path',
help='The folder that this spark job definition is in. If not specified, it will appear at the root level. Eg: folder/subfolder1')
# synapse artifacts sql script
for scope in ['create', 'show', 'wait', 'delete', 'export', 'import']:
with self.argument_context('synapse sql-script ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('sql_script_name', options_list=['--name', '-n'], help='The SQL script name')
with self.argument_context('synapse sql-script list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
for scope in ['create', 'import']:
with self.argument_context('synapse sql-script ' + scope) as c:
c.argument('definition_file', options_list=('--file', '-f'), type=file_type, completer=FilesCompleter(), help='The SQL query file path')
c.argument('result_limit', arg_type=get_enum_type([5000, -1]), help="The SQL query results limit. Default is 5000. '-1' is no limit.")
c.argument('folder_name', help='The folder that this SQL script is in. If not specified, this SQL script will appear at the root level. Eg: folder/subfolder1')
c.argument('description', help='The SQL script description')
c.argument('sql_pool_name', help='The SQL pool name')
c.argument('sql_database_name', help='The SQL database name')
c.argument('additional_properties', help='The SQL script additional properties')
with self.argument_context('synapse sql-script export') as c:
c.argument('output_folder', help='The SQL script export path')
c.argument('folder_path',
help='The folder that this spark job definition is in. If not specified, it will appear at the root level. Eg: folder/subfolder1')
# kusto pool
with self.argument_context('synapse kusto pool create') as c:
c.argument('workspace_name', type=str, help='The name of the workspace')
c.argument('resource_group_name', resource_group_name_type)
c.argument('kusto_pool_name', options_list=['--name', '-n', '--kusto-pool-name'], type=str, help='The name of '
'the Kusto pool.')
c.argument('if_match', type=str, help='The ETag of the Kusto Pool. Omit this value to always overwrite the '
'current Kusto Pool. Specify the last-seen ETag value to prevent accidentally overwriting '
'concurrent changes.')
c.argument('if_none_match', type=str, help='Set to \'*\' to allow a new Kusto Pool to be created, but to '
'prevent updating an existing Kusto Pool. Other values will result in a 412 Pre-condition Failed '
'response.')
c.argument('tags', tags_type)
c.argument('location', arg_type=get_location_type(self.cli_ctx), required=False,
validator=get_default_location_from_resource_group)
c.argument('sku', action=AddSku, nargs='+', help='The SKU of the kusto pool.')
c.argument('optimized_autoscale', action=AddOptimizedAutoscale, nargs='+', help='Optimized auto scale '
'definition.')
c.argument('enable_streaming_ingest', options_list=['--enable-streaming-ingest', '--esig'],
arg_type=get_three_state_flag(), help='A boolean value that indicates if '
'the streaming ingest is enabled.')
c.argument('enable_purge', arg_type=get_three_state_flag(), help='A boolean value that indicates if the purge '
'operations are enabled.')
c.argument('workspace_uid', type=str, help='The workspace unique identifier.')
with self.argument_context('synapse kusto pool update') as c:
c.argument('workspace_name', type=str, help='The name of the workspace', id_part='name')
c.argument('resource_group_name', resource_group_name_type)
c.argument('kusto_pool_name', options_list=['--name', '-n', '--kusto-pool-name'], type=str, help='The name of '
'the Kusto pool.', id_part='child_name_1')
c.argument('if_match', type=str, help='The ETag of the Kusto Pool. Omit this value to always overwrite the '
'current Kusto Pool. Specify the last-seen ETag value to prevent accidentally overwriting '
'concurrent changes.')
c.argument('tags', tags_type)
c.argument('sku', action=AddSku, nargs='+', help='The SKU of the kusto pool.')
c.argument('optimized_autoscale', action=AddOptimizedAutoscale, nargs='+', help='Optimized auto scale '
'definition.')
c.argument('enable_streaming_ingest', options_list=['--enable-streaming-ingest', '--esig'],
arg_type=get_three_state_flag(), help='A boolean value that indicates if '
'the streaming ingest is enabled.')
c.argument('enable_purge', arg_type=get_three_state_flag(), help='A boolean value that indicates if the purge '
'operations are enabled.')
c.argument('workspace_uid', type=str, help='The workspace unique identifier.')
with self.argument_context('synapse kusto pool add-language-extension') as c:
c.argument('workspace_name', type=str, help='The name of the workspace', id_part='name')
c.argument('kusto_pool_name', options_list=['--name', '-n', '--kusto-pool-name'], type=str, help='The name of '
'the Kusto pool.', id_part='child_name_1')
c.argument('resource_group_name', resource_group_name_type)
c.argument('value', action=AddValue, nargs='+', help='The list of language extensions.')
with self.argument_context('synapse kusto pool remove-language-extension') as c:
c.argument('workspace_name', type=str, help='The name of the workspace', id_part='name')
c.argument('kusto_pool_name', options_list=['--name', '-n', '--kusto-pool-name'], type=str, help='The name of '
'the Kusto pool.', id_part='child_name_1')
c.argument('resource_group_name', resource_group_name_type)
c.argument('value', action=AddValue, nargs='+', help='The list of language extensions.')
with self.argument_context('synapse kusto pool list-language-extension') as c:
c.argument('workspace_name', type=str, help='The name of the workspace')
c.argument('kusto_pool_name', options_list=['--name', '-n', '--kusto-pool-name'], type=str, help='The name of '
'the Kusto pool.')
c.argument('resource_group_name', resource_group_name_type)
with self.argument_context('synapse kusto pool detach-follower-database') as c:
c.argument('workspace_name', type=str, help='The name of the workspace', id_part='name')
c.argument('kusto_pool_name', options_list=['--name', '-n', '--kusto-pool-name'], type=str, help='The name of '
'the Kusto pool.', id_part='child_name_1')
c.argument('resource_group_name', resource_group_name_type)
c.argument('kusto_pool_resource_id', type=str, help='Resource id of the cluster that follows a database owned '
'by this cluster.')
c.argument('attached_database_configuration_name',
options_list=['--attached-database-configuration-name', '--adcn'],
type=str, help='Resource name of the attached database '
'configuration in the follower cluster.')
for scope in ['import', 'create']:
with self.argument_context('synapse kql-script ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type, help='The name of the workspace')
c.argument('kusto_pool_name', type=str, help='The name of the Kusto pool.')
c.argument('kusto_database_name', type=str, help='The name of the Kusto database.')
c.argument('script_name', arg_type=name_type, help='The name of the KQL script.')
c.argument('definition_file', options_list=['--file', '-f'], type=file_type, completer=FilesCompleter(),
help='The KQL query file path')
for scope in ['show', 'wait', 'delete']:
with self.argument_context('synapse kql-script ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type, help='The name of the workspace')
c.argument('script_name', arg_type=name_type,
help='The name of the KQL script.')
with self.argument_context('synapse kql-script list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type, help='The name of the workspace')
with self.argument_context('synapse kql-script export') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type, help='The name of the workspace')
c.argument('output_folder', type=str, help='The name of the output folder')
c.argument('script_name', arg_type=name_type, help='The name of the KQL script.')
for scope in ['enable', 'disable']:
with self.argument_context('synapse ad-only-auth ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type, help='The name of the workspace')
c.argument('resource_group_name', resource_group_name_type)
# synapse link connections
with self.argument_context('synapse link-connection list') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
for scope in ['create', 'update']:
with self.argument_context('synapse link-connection ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('link_connection_name', arg_type=name_type, help='The link connection name.')
c.argument('definition_file', arg_type=definition_file_arg_type)
for scope in ['show', 'delete', 'get-status', 'start', 'stop']:
with self.argument_context('synapse link-connection ' + scope) as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('link_connection_name', arg_type=name_type, help='The link connection name.')
with self.argument_context('synapse link-connection list-link-tables') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('link_connection_name', arg_type=name_type, help='The link connection name.')
with self.argument_context('synapse link-connection edit-link-tables') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('link_connection_name', arg_type=name_type, help='The link connection name.')
c.argument('definition_file', arg_type=definition_file_arg_type, options_list=['--file', '-f'], type=shell_safe_json_parse,
help='The Edit link-tables file path, The file format can be viewed using --help.')
with self.argument_context('synapse link-connection get-link-tables-status') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('link_connection_name', arg_type=name_type, help='The link connection name.')
c.argument('max_segment_count', help='Max segment count to query table status.')
c.argument('continuation_token', help='Continuation token to query table status.')
with self.argument_context('synapse link-connection update-landing-zone-credential') as c:
c.argument('workspace_name', arg_type=workspace_name_arg_type)
c.argument('link_connection_name', arg_type=name_type, help='The link connection name.')
c.argument('sas_token', help='Value of secure string.')