desc stringlengths 3 26.7k | decl stringlengths 11 7.89k | bodies stringlengths 8 553k |
|---|---|---|
'Disables automatic scaling for a pool.
:param pool_id: The ID of the pool on which to disable automatic
scaling.
:type pool_id: str
:param pool_disable_auto_scale_options: Additional parameters for the
operation
:type pool_disable_auto_scale_options:
:class:`PoolDisableAutoScaleOptions
<azure.batch.models.PoolDisableA... | def disable_auto_scale(self, pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (pool_disable_auto_scale_options is not None):
timeout = pool_disable_auto_scale_options.timeout
client_request_id = None
if (pool_disable_auto_scale_options is not None):
client_request_id = pool_disable_auto_scale_options.client_request_id
return_client_request_id... |
'Enables automatic scaling for a pool.
You cannot enable automatic scaling on a pool if a resize operation is
in progress on the pool. If automatic scaling of the pool is currently
disabled, you must specify a valid autoscale formula as part of the
request. If automatic scaling of the pool is already enabled, you may
s... | def enable_auto_scale(self, pool_id, pool_enable_auto_scale_options=None, auto_scale_formula=None, auto_scale_evaluation_interval=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (pool_enable_auto_scale_options is not None):
timeout = pool_enable_auto_scale_options.timeout
client_request_id = None
if (pool_enable_auto_scale_options is not None):
client_request_id = pool_enable_auto_scale_options.client_request_id
return_client_request_id = N... |
'Gets the result of evaluating an automatic scaling formula on the pool.
This API is primarily for validating an autoscale formula, as it simply
returns the result without applying the formula to the pool.
:param pool_id: The ID of the pool on which to evaluate the automatic
scaling formula.
:type pool_id: str
:param a... | def evaluate_auto_scale(self, pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (pool_evaluate_auto_scale_options is not None):
timeout = pool_evaluate_auto_scale_options.timeout
client_request_id = None
if (pool_evaluate_auto_scale_options is not None):
client_request_id = pool_evaluate_auto_scale_options.client_request_id
return_client_reques... |
'Changes the number of compute nodes that are assigned to a pool.
You can only resize a pool when its allocation state is steady. If the
pool is already resizing, the request fails with status code 409. When
you resize a pool, the pool\'s allocation state changes from steady to
resizing. You cannot resize pools which a... | def resize(self, pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (pool_resize_options is not None):
timeout = pool_resize_options.timeout
client_request_id = None
if (pool_resize_options is not None):
client_request_id = pool_resize_options.client_request_id
return_client_request_id = None
if (pool_resize_options is not None)... |
'Stops an ongoing resize operation on the pool.
This does not restore the pool to its previous state before the resize
operation: it only stops any further changes being made, and the pool
maintains its current state. A resize operation need not be an explicit
resize pool request; this API can also be used to halt the ... | def stop_resize(self, pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (pool_stop_resize_options is not None):
timeout = pool_stop_resize_options.timeout
client_request_id = None
if (pool_stop_resize_options is not None):
client_request_id = pool_stop_resize_options.client_request_id
return_client_request_id = None
if (pool_stop_re... |
'Updates the properties of the specified pool.
This fully replaces all the updateable properties of the pool. For
example, if the pool has a start task associated with it and if start
task is not specified with this request, then the Batch service will
remove the existing start task.
:param pool_id: The ID of the pool ... | def update_properties(self, pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (pool_update_properties_options is not None):
timeout = pool_update_properties_options.timeout
client_request_id = None
if (pool_update_properties_options is not None):
client_request_id = pool_update_properties_options.client_request_id
return_client_request_id = N... |
'Upgrades the operating system of the specified pool.
During an upgrade, the Batch service upgrades each compute node in the
pool. When a compute node is chosen for upgrade, any tasks running on
that node are removed from the node and returned to the queue to be
rerun later (or on a different compute node). The node wi... | def upgrade_os(self, pool_id, target_os_version, pool_upgrade_os_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (pool_upgrade_os_options is not None):
timeout = pool_upgrade_os_options.timeout
client_request_id = None
if (pool_upgrade_os_options is not None):
client_request_id = pool_upgrade_os_options.client_request_id
return_client_request_id = None
if (pool_upgrade_os_... |
'Removes compute nodes from the specified pool.
This operation can only run when the allocation state of the pool is
steady. When this operation runs, the allocation state changes from
steady to resizing.
:param pool_id: The ID of the pool from which you want to remove
nodes.
:type pool_id: str
:param node_remove_param... | def remove_nodes(self, pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (pool_remove_nodes_options is not None):
timeout = pool_remove_nodes_options.timeout
client_request_id = None
if (pool_remove_nodes_options is not None):
client_request_id = pool_remove_nodes_options.client_request_id
return_client_request_id = None
if (pool_rem... |
'Gets lifetime summary statistics for all of the jobs in the specified
account.
Statistics are aggregated across all jobs that have ever existed in the
account, from account creation to the last update time of the
statistics.
:param job_get_all_lifetime_statistics_options: Additional parameters
for the operation
:type ... | def get_all_lifetime_statistics(self, job_get_all_lifetime_statistics_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_get_all_lifetime_statistics_options is not None):
timeout = job_get_all_lifetime_statistics_options.timeout
client_request_id = None
if (job_get_all_lifetime_statistics_options is not None):
client_request_id = job_get_all_lifetime_statistics_options.client_request... |
'Deletes a job.
Deleting a job also deletes all tasks that are part of that job, and
all job statistics. This also overrides the retention period for task
data; that is, if the job contains tasks which are still retained on
compute nodes, the Batch services deletes those tasks\' working
directories and all their conten... | def delete(self, job_id, job_delete_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_delete_options is not None):
timeout = job_delete_options.timeout
client_request_id = None
if (job_delete_options is not None):
client_request_id = job_delete_options.client_request_id
return_client_request_id = None
if (job_delete_options is not None):
... |
'Gets information about the specified job.
:param job_id: The ID of the job.
:type job_id: str
:param job_get_options: Additional parameters for the operation
:type job_get_options: :class:`JobGetOptions
<azure.batch.models.JobGetOptions>`
:param dict custom_headers: headers that will be added to the request
:param boo... | def get(self, job_id, job_get_options=None, custom_headers=None, raw=False, **operation_config):
| select = None
if (job_get_options is not None):
select = job_get_options.select
expand = None
if (job_get_options is not None):
expand = job_get_options.expand
timeout = None
if (job_get_options is not None):
timeout = job_get_options.timeout
client_request_id = None
... |
'Updates the properties of the specified job.
This replaces only the job properties specified in the request. For
example, if the job has constraints, and a request does not specify the
constraints element, then the job keeps the existing constraints.
:param job_id: The ID of the job whose properties you want to update... | def patch(self, job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_patch_options is not None):
timeout = job_patch_options.timeout
client_request_id = None
if (job_patch_options is not None):
client_request_id = job_patch_options.client_request_id
return_client_request_id = None
if (job_patch_options is not None):
... |
'Updates the properties of the specified job.
This fully replaces all the updateable properties of the job. For
example, if the job has constraints associated with it and if
constraints is not specified with this request, then the Batch service
will remove the existing constraints.
:param job_id: The ID of the job whos... | def update(self, job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_update_options is not None):
timeout = job_update_options.timeout
client_request_id = None
if (job_update_options is not None):
client_request_id = job_update_options.client_request_id
return_client_request_id = None
if (job_update_options is not None):
... |
'Disables the specified job, preventing new tasks from running.
The Batch Service immediately moves the job to the disabling state.
Batch then uses the disableTasks parameter to determine what to do with
the currently running tasks of the job. The job remains in the
disabling state until the disable operation is comple... | def disable(self, job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_disable_options is not None):
timeout = job_disable_options.timeout
client_request_id = None
if (job_disable_options is not None):
client_request_id = job_disable_options.client_request_id
return_client_request_id = None
if (job_disable_options is not None)... |
'Enables the specified job, allowing new tasks to run.
When you call this API, the Batch service sets a disabled job to the
enabling state. After the this operation is completed, the job moves to
the active state, and scheduling of new tasks under the job resumes.
The Batch service does not allow a task to remain in th... | def enable(self, job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_enable_options is not None):
timeout = job_enable_options.timeout
client_request_id = None
if (job_enable_options is not None):
client_request_id = job_enable_options.client_request_id
return_client_request_id = None
if (job_enable_options is not None):
... |
'Terminates the specified job, marking it as completed.
When a Terminate Job request is received, the Batch service sets the
job to the terminating state. The Batch service then terminates any
active or running tasks associated with the job, and runs any required
Job Release tasks. The job then moves into the completed... | def terminate(self, job_id, job_terminate_options=None, terminate_reason=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_terminate_options is not None):
timeout = job_terminate_options.timeout
client_request_id = None
if (job_terminate_options is not None):
client_request_id = job_terminate_options.client_request_id
return_client_request_id = None
if (job_terminate_options is... |
'Adds a job to the specified account.
The Batch service supports two ways to control the work done as part of
a job. In the first approach, the user specifies a Job Manager task.
The Batch service launches this task when it is ready to start the job.
The Job Manager task controls all other tasks that run under this job... | def add(self, job, job_add_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_add_options is not None):
timeout = job_add_options.timeout
client_request_id = None
if (job_add_options is not None):
client_request_id = job_add_options.client_request_id
return_client_request_id = None
if (job_add_options is not None):
return_cli... |
'Lists all of the jobs in the specified account.
:param job_list_options: Additional parameters for the operation
:type job_list_options: :class:`JobListOptions
<azure.batch.models.JobListOptions>`
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongsi... | def list(self, job_list_options=None, custom_headers=None, raw=False, **operation_config):
| filter = None
if (job_list_options is not None):
filter = job_list_options.filter
select = None
if (job_list_options is not None):
select = job_list_options.select
expand = None
if (job_list_options is not None):
expand = job_list_options.expand
max_results = None
... |
'Lists the jobs that have been created under the specified job schedule.
:param job_schedule_id: The ID of the job schedule from which you want
to get a list of jobs.
:type job_schedule_id: str
:param job_list_from_job_schedule_options: Additional parameters for
the operation
:type job_list_from_job_schedule_options:
:... | def list_from_job_schedule(self, job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config):
| filter = None
if (job_list_from_job_schedule_options is not None):
filter = job_list_from_job_schedule_options.filter
select = None
if (job_list_from_job_schedule_options is not None):
select = job_list_from_job_schedule_options.select
expand = None
if (job_list_from_job_schedule... |
'Lists the execution status of the Job Preparation and Job Release task
for the specified job across the compute nodes where the job has run.
This API returns the Job Preparation and Job Release task status on all
compute nodes that have run the Job Preparation or Job Release task.
This includes nodes which have since ... | def list_preparation_and_release_task_status(self, job_id, job_list_preparation_and_release_task_status_options=None, custom_headers=None, raw=False, **operation_config):
| filter = None
if (job_list_preparation_and_release_task_status_options is not None):
filter = job_list_preparation_and_release_task_status_options.filter
select = None
if (job_list_preparation_and_release_task_status_options is not None):
select = job_list_preparation_and_release_task_st... |
'Gets the task counts for the specified job.
Task counts provide a count of the tasks by active, running or
completed task state, and a count of tasks which succeeded or failed.
Tasks in the preparing state are counted as running. If the
validationStatus is unvalidated, then the Batch service has not been
able to check... | def get_task_counts(self, job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_get_task_counts_options is not None):
timeout = job_get_task_counts_options.timeout
client_request_id = None
if (job_get_task_counts_options is not None):
client_request_id = job_get_task_counts_options.client_request_id
return_client_request_id = None
if (... |
'Lists all node agent SKUs supported by the Azure Batch service.
:param account_list_node_agent_skus_options: Additional parameters for
the operation
:type account_list_node_agent_skus_options:
:class:`AccountListNodeAgentSkusOptions
<azure.batch.models.AccountListNodeAgentSkusOptions>`
:param dict custom_headers: head... | def list_node_agent_skus(self, account_list_node_agent_skus_options=None, custom_headers=None, raw=False, **operation_config):
| filter = None
if (account_list_node_agent_skus_options is not None):
filter = account_list_node_agent_skus_options.filter
max_results = None
if (account_list_node_agent_skus_options is not None):
max_results = account_list_node_agent_skus_options.max_results
timeout = None
if (ac... |
'Checks the specified job schedule exists.
:param job_schedule_id: The ID of the job schedule which you want to
check.
:type job_schedule_id: str
:param job_schedule_exists_options: Additional parameters for the
operation
:type job_schedule_exists_options: :class:`JobScheduleExistsOptions
<azure.batch.models.JobSchedul... | def exists(self, job_schedule_id, job_schedule_exists_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_schedule_exists_options is not None):
timeout = job_schedule_exists_options.timeout
client_request_id = None
if (job_schedule_exists_options is not None):
client_request_id = job_schedule_exists_options.client_request_id
return_client_request_id = None
if (... |
'Deletes a job schedule from the specified account.
When you delete a job schedule, this also deletes all jobs and tasks
under that schedule. When tasks are deleted, all the files in their
working directories on the compute nodes are also deleted (the
retention period is ignored). The job schedule statistics are no lon... | def delete(self, job_schedule_id, job_schedule_delete_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_schedule_delete_options is not None):
timeout = job_schedule_delete_options.timeout
client_request_id = None
if (job_schedule_delete_options is not None):
client_request_id = job_schedule_delete_options.client_request_id
return_client_request_id = None
if (... |
'Gets information about the specified job schedule.
:param job_schedule_id: The ID of the job schedule to get.
:type job_schedule_id: str
:param job_schedule_get_options: Additional parameters for the
operation
:type job_schedule_get_options: :class:`JobScheduleGetOptions
<azure.batch.models.JobScheduleGetOptions>`
:pa... | def get(self, job_schedule_id, job_schedule_get_options=None, custom_headers=None, raw=False, **operation_config):
| select = None
if (job_schedule_get_options is not None):
select = job_schedule_get_options.select
expand = None
if (job_schedule_get_options is not None):
expand = job_schedule_get_options.expand
timeout = None
if (job_schedule_get_options is not None):
timeout = job_sche... |
'Updates the properties of the specified job schedule.
This replaces only the job schedule properties specified in the
request. For example, if the schedule property is not specified with
this request, then the Batch service will keep the existing schedule.
Changes to a job schedule only impact jobs created by the sche... | def patch(self, job_schedule_id, job_schedule_patch_parameter, job_schedule_patch_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_schedule_patch_options is not None):
timeout = job_schedule_patch_options.timeout
client_request_id = None
if (job_schedule_patch_options is not None):
client_request_id = job_schedule_patch_options.client_request_id
return_client_request_id = None
if (job_... |
'Updates the properties of the specified job schedule.
This fully replaces all the updateable properties of the job schedule.
For example, if the schedule property is not specified with this
request, then the Batch service will remove the existing schedule.
Changes to a job schedule only impact jobs created by the sche... | def update(self, job_schedule_id, job_schedule_update_parameter, job_schedule_update_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_schedule_update_options is not None):
timeout = job_schedule_update_options.timeout
client_request_id = None
if (job_schedule_update_options is not None):
client_request_id = job_schedule_update_options.client_request_id
return_client_request_id = None
if (... |
'Disables a job schedule.
No new jobs will be created until the job schedule is enabled again.
:param job_schedule_id: The ID of the job schedule to disable.
:type job_schedule_id: str
:param job_schedule_disable_options: Additional parameters for the
operation
:type job_schedule_disable_options: :class:`JobScheduleDis... | def disable(self, job_schedule_id, job_schedule_disable_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_schedule_disable_options is not None):
timeout = job_schedule_disable_options.timeout
client_request_id = None
if (job_schedule_disable_options is not None):
client_request_id = job_schedule_disable_options.client_request_id
return_client_request_id = None
... |
'Enables a job schedule.
:param job_schedule_id: The ID of the job schedule to enable.
:type job_schedule_id: str
:param job_schedule_enable_options: Additional parameters for the
operation
:type job_schedule_enable_options: :class:`JobScheduleEnableOptions
<azure.batch.models.JobScheduleEnableOptions>`
:param dict cus... | def enable(self, job_schedule_id, job_schedule_enable_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_schedule_enable_options is not None):
timeout = job_schedule_enable_options.timeout
client_request_id = None
if (job_schedule_enable_options is not None):
client_request_id = job_schedule_enable_options.client_request_id
return_client_request_id = None
if (... |
'Terminates a job schedule.
:param job_schedule_id: The ID of the job schedule to terminates.
:type job_schedule_id: str
:param job_schedule_terminate_options: Additional parameters for the
operation
:type job_schedule_terminate_options:
:class:`JobScheduleTerminateOptions
<azure.batch.models.JobScheduleTerminateOption... | def terminate(self, job_schedule_id, job_schedule_terminate_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_schedule_terminate_options is not None):
timeout = job_schedule_terminate_options.timeout
client_request_id = None
if (job_schedule_terminate_options is not None):
client_request_id = job_schedule_terminate_options.client_request_id
return_client_request_id = N... |
'Adds a job schedule to the specified account.
:param cloud_job_schedule: The job schedule to be added.
:type cloud_job_schedule: :class:`JobScheduleAddParameter
<azure.batch.models.JobScheduleAddParameter>`
:param job_schedule_add_options: Additional parameters for the
operation
:type job_schedule_add_options: :class:... | def add(self, cloud_job_schedule, job_schedule_add_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (job_schedule_add_options is not None):
timeout = job_schedule_add_options.timeout
client_request_id = None
if (job_schedule_add_options is not None):
client_request_id = job_schedule_add_options.client_request_id
return_client_request_id = None
if (job_schedule... |
'Lists all of the job schedules in the specified account.
:param job_schedule_list_options: Additional parameters for the
operation
:type job_schedule_list_options: :class:`JobScheduleListOptions
<azure.batch.models.JobScheduleListOptions>`
:param dict custom_headers: headers that will be added to the request
:param bo... | def list(self, job_schedule_list_options=None, custom_headers=None, raw=False, **operation_config):
| filter = None
if (job_schedule_list_options is not None):
filter = job_schedule_list_options.filter
select = None
if (job_schedule_list_options is not None):
select = job_schedule_list_options.select
expand = None
if (job_schedule_list_options is not None):
expand = job_s... |
'Adds a user account to the specified compute node.
You can add a user account to a node only when it is in the idle or
running state.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the machine on which you want to create a
user account.
:type node_id: st... | def add_user(self, pool_id, node_id, user, compute_node_add_user_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (compute_node_add_user_options is not None):
timeout = compute_node_add_user_options.timeout
client_request_id = None
if (compute_node_add_user_options is not None):
client_request_id = compute_node_add_user_options.client_request_id
return_client_request_id = None
... |
'Deletes a user account from the specified compute node.
You can delete a user account to a node only when it is in the idle or
running state.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the machine on which you want to delete a
user account.
:type nod... | def delete_user(self, pool_id, node_id, user_name, compute_node_delete_user_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (compute_node_delete_user_options is not None):
timeout = compute_node_delete_user_options.timeout
client_request_id = None
if (compute_node_delete_user_options is not None):
client_request_id = compute_node_delete_user_options.client_request_id
return_client_reques... |
'Updates the password or expiration time of a user account on the
specified compute node.
This operation replaces of all the updateable properties of the
account. For example, if the expiryTime element is not specified, the
current value is replaced with the default value, not left unmodified.
You can update a user acc... | def update_user(self, pool_id, node_id, user_name, node_update_user_parameter, compute_node_update_user_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (compute_node_update_user_options is not None):
timeout = compute_node_update_user_options.timeout
client_request_id = None
if (compute_node_update_user_options is not None):
client_request_id = compute_node_update_user_options.client_request_id
return_client_reques... |
'Gets information about the specified compute node.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node that you want to get
information about.
:type node_id: str
:param compute_node_get_options: Additional parameters for the
operation
:type c... | def get(self, pool_id, node_id, compute_node_get_options=None, custom_headers=None, raw=False, **operation_config):
| select = None
if (compute_node_get_options is not None):
select = compute_node_get_options.select
timeout = None
if (compute_node_get_options is not None):
timeout = compute_node_get_options.timeout
client_request_id = None
if (compute_node_get_options is not None):
clien... |
'Restarts the specified compute node.
You can restart a node only if it is in an idle or running state.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node that you want to restart.
:type node_id: str
:param compute_node_reboot_options: Additi... | def reboot(self, pool_id, node_id, compute_node_reboot_options=None, node_reboot_option=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (compute_node_reboot_options is not None):
timeout = compute_node_reboot_options.timeout
client_request_id = None
if (compute_node_reboot_options is not None):
client_request_id = compute_node_reboot_options.client_request_id
return_client_request_id = None
if (... |
'Reinstalls the operating system on the specified compute node.
You can reinstall the operating system on a node only if it is in an
idle or running state. This API can be invoked only on pools created
with the cloud service configuration property.
:param pool_id: The ID of the pool that contains the compute node.
:typ... | def reimage(self, pool_id, node_id, compute_node_reimage_options=None, node_reimage_option=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (compute_node_reimage_options is not None):
timeout = compute_node_reimage_options.timeout
client_request_id = None
if (compute_node_reimage_options is not None):
client_request_id = compute_node_reimage_options.client_request_id
return_client_request_id = None
... |
'Disables task scheduling on the specified compute node.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node on which you want to
disable task scheduling.
:type node_id: str
:param compute_node_disable_scheduling_options: Additional parameters... | def disable_scheduling(self, pool_id, node_id, compute_node_disable_scheduling_options=None, node_disable_scheduling_option=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (compute_node_disable_scheduling_options is not None):
timeout = compute_node_disable_scheduling_options.timeout
client_request_id = None
if (compute_node_disable_scheduling_options is not None):
client_request_id = compute_node_disable_scheduling_options.client_request... |
'Enables task scheduling on the specified compute node.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node on which you want to enable
task scheduling.
:type node_id: str
:param compute_node_enable_scheduling_options: Additional parameters
fo... | def enable_scheduling(self, pool_id, node_id, compute_node_enable_scheduling_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (compute_node_enable_scheduling_options is not None):
timeout = compute_node_enable_scheduling_options.timeout
client_request_id = None
if (compute_node_enable_scheduling_options is not None):
client_request_id = compute_node_enable_scheduling_options.client_request_id
... |
'Gets the settings required for remote login to a compute node.
Before you can remotely login to a node using the remote login
settings, you must create a user account on the node. This API can be
invoked only on pools created with the virtual machine configuration
property.
:param pool_id: The ID of the pool that cont... | def get_remote_login_settings(self, pool_id, node_id, compute_node_get_remote_login_settings_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (compute_node_get_remote_login_settings_options is not None):
timeout = compute_node_get_remote_login_settings_options.timeout
client_request_id = None
if (compute_node_get_remote_login_settings_options is not None):
client_request_id = compute_node_get_remote_login_set... |
'Gets the Remote Desktop Protocol file for the specified compute node.
Before you can access a node by using the RDP file, you must create a
user account on the node. This API can only be invoked on pools created
with the cloud service configuration property.
:param pool_id: The ID of the pool that contains the compute... | def get_remote_desktop(self, pool_id, node_id, compute_node_get_remote_desktop_options=None, custom_headers=None, raw=False, callback=None, **operation_config):
| timeout = None
if (compute_node_get_remote_desktop_options is not None):
timeout = compute_node_get_remote_desktop_options.timeout
client_request_id = None
if (compute_node_get_remote_desktop_options is not None):
client_request_id = compute_node_get_remote_desktop_options.client_request... |
'Lists the compute nodes in the specified pool.
:param pool_id: The ID of the pool from which you want to list nodes.
:type pool_id: str
:param compute_node_list_options: Additional parameters for the
operation
:type compute_node_list_options: :class:`ComputeNodeListOptions
<azure.batch.models.ComputeNodeListOptions>`
... | def list(self, pool_id, compute_node_list_options=None, custom_headers=None, raw=False, **operation_config):
| filter = None
if (compute_node_list_options is not None):
filter = compute_node_list_options.filter
select = None
if (compute_node_list_options is not None):
select = compute_node_list_options.select
max_results = None
if (compute_node_list_options is not None):
max_resul... |
'Deletes the specified task file from the compute node where the task
ran.
:param job_id: The ID of the job that contains the task.
:type job_id: str
:param task_id: The ID of the task whose file you want to delete.
:type task_id: str
:param file_path: The path to the task file that you want to delete.
:type file_path:... | def delete_from_task(self, job_id, task_id, file_path, recursive=None, file_delete_from_task_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (file_delete_from_task_options is not None):
timeout = file_delete_from_task_options.timeout
client_request_id = None
if (file_delete_from_task_options is not None):
client_request_id = file_delete_from_task_options.client_request_id
return_client_request_id = None
... |
'Returns the content of the specified task file.
:param job_id: The ID of the job that contains the task.
:type job_id: str
:param task_id: The ID of the task whose file you want to retrieve.
:type task_id: str
:param file_path: The path to the task file that you want to get the
content of.
:type file_path: str
:param ... | def get_from_task(self, job_id, task_id, file_path, file_get_from_task_options=None, custom_headers=None, raw=False, callback=None, **operation_config):
| timeout = None
if (file_get_from_task_options is not None):
timeout = file_get_from_task_options.timeout
client_request_id = None
if (file_get_from_task_options is not None):
client_request_id = file_get_from_task_options.client_request_id
return_client_request_id = None
if (file... |
'Gets the properties of the specified task file.
:param job_id: The ID of the job that contains the task.
:type job_id: str
:param task_id: The ID of the task whose file you want to get the
properties of.
:type task_id: str
:param file_path: The path to the task file that you want to get the
properties of.
:type file_p... | def get_properties_from_task(self, job_id, task_id, file_path, file_get_properties_from_task_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (file_get_properties_from_task_options is not None):
timeout = file_get_properties_from_task_options.timeout
client_request_id = None
if (file_get_properties_from_task_options is not None):
client_request_id = file_get_properties_from_task_options.client_request_id
... |
'Deletes the specified file from the compute node.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node from which you want to
delete the file.
:type node_id: str
:param file_path: The path to the file that you want to delete.
:type file_path: ... | def delete_from_compute_node(self, pool_id, node_id, file_path, recursive=None, file_delete_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (file_delete_from_compute_node_options is not None):
timeout = file_delete_from_compute_node_options.timeout
client_request_id = None
if (file_delete_from_compute_node_options is not None):
client_request_id = file_delete_from_compute_node_options.client_request_id
... |
'Returns the content of the specified compute node file.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node that contains the file.
:type node_id: str
:param file_path: The path to the compute node file that you want to
get the content of.
:t... | def get_from_compute_node(self, pool_id, node_id, file_path, file_get_from_compute_node_options=None, custom_headers=None, raw=False, callback=None, **operation_config):
| timeout = None
if (file_get_from_compute_node_options is not None):
timeout = file_get_from_compute_node_options.timeout
client_request_id = None
if (file_get_from_compute_node_options is not None):
client_request_id = file_get_from_compute_node_options.client_request_id
return_clien... |
'Gets the properties of the specified compute node file.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node that contains the file.
:type node_id: str
:param file_path: The path to the compute node file that you want to
get the properties of.... | def get_properties_from_compute_node(self, pool_id, node_id, file_path, file_get_properties_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (file_get_properties_from_compute_node_options is not None):
timeout = file_get_properties_from_compute_node_options.timeout
client_request_id = None
if (file_get_properties_from_compute_node_options is not None):
client_request_id = file_get_properties_from_compute_nod... |
'Lists the files in a task\'s directory on its compute node.
:param job_id: The ID of the job that contains the task.
:type job_id: str
:param task_id: The ID of the task whose files you want to list.
:type task_id: str
:param recursive: Whether to list children of a directory. This
parameter can be used in combination... | def list_from_task(self, job_id, task_id, recursive=None, file_list_from_task_options=None, custom_headers=None, raw=False, **operation_config):
| filter = None
if (file_list_from_task_options is not None):
filter = file_list_from_task_options.filter
max_results = None
if (file_list_from_task_options is not None):
max_results = file_list_from_task_options.max_results
timeout = None
if (file_list_from_task_options is not Non... |
'Lists all of the files in task directories on the specified compute
node.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node whose files you want to
list.
:type node_id: str
:param recursive: Whether to list children of a directory.
:type re... | def list_from_compute_node(self, pool_id, node_id, recursive=None, file_list_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config):
| filter = None
if (file_list_from_compute_node_options is not None):
filter = file_list_from_compute_node_options.filter
max_results = None
if (file_list_from_compute_node_options is not None):
max_results = file_list_from_compute_node_options.max_results
timeout = None
if (file_l... |
'Lists all of the applications available in the specified account.
This operation returns only applications and versions that are
available for use on compute nodes; that is, that can be used in an
application package reference. For administrator information about
applications and versions that are not yet available to... | def list(self, application_list_options=None, custom_headers=None, raw=False, **operation_config):
| max_results = None
if (application_list_options is not None):
max_results = application_list_options.max_results
timeout = None
if (application_list_options is not None):
timeout = application_list_options.timeout
client_request_id = None
if (application_list_options is not None)... |
'Gets information about the specified application.
:param application_id: The ID of the application.
:type application_id: str
:param application_get_options: Additional parameters for the
operation
:type application_get_options: :class:`ApplicationGetOptions
<azure.batch.models.ApplicationGetOptions>`
:param dict cust... | def get(self, application_id, application_get_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (application_get_options is not None):
timeout = application_get_options.timeout
client_request_id = None
if (application_get_options is not None):
client_request_id = application_get_options.client_request_id
return_client_request_id = None
if (application_get_... |
'Adds a certificate to the specified account.
:param certificate: The certificate to be added.
:type certificate: :class:`CertificateAddParameter
<azure.batch.models.CertificateAddParameter>`
:param certificate_add_options: Additional parameters for the
operation
:type certificate_add_options: :class:`CertificateAddOpt... | def add(self, certificate, certificate_add_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (certificate_add_options is not None):
timeout = certificate_add_options.timeout
client_request_id = None
if (certificate_add_options is not None):
client_request_id = certificate_add_options.client_request_id
return_client_request_id = None
if (certificate_add_... |
'Lists all of the certificates that have been added to the specified
account.
:param certificate_list_options: Additional parameters for the
operation
:type certificate_list_options: :class:`CertificateListOptions
<azure.batch.models.CertificateListOptions>`
:param dict custom_headers: headers that will be added to the... | def list(self, certificate_list_options=None, custom_headers=None, raw=False, **operation_config):
| filter = None
if (certificate_list_options is not None):
filter = certificate_list_options.filter
select = None
if (certificate_list_options is not None):
select = certificate_list_options.select
max_results = None
if (certificate_list_options is not None):
max_results = ... |
'Cancels a failed deletion of a certificate from the specified account.
If you try to delete a certificate that is being used by a pool or
compute node, the status of the certificate changes to deleteFailed. If
you decide that you want to continue using the certificate, you can use
this operation to set the status of t... | def cancel_deletion(self, thumbprint_algorithm, thumbprint, certificate_cancel_deletion_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (certificate_cancel_deletion_options is not None):
timeout = certificate_cancel_deletion_options.timeout
client_request_id = None
if (certificate_cancel_deletion_options is not None):
client_request_id = certificate_cancel_deletion_options.client_request_id
return_c... |
'Deletes a certificate from the specified account.
You cannot delete a certificate if a resource (pool or compute node) is
using it. Before you can delete a certificate, you must therefore make
sure that the certificate is not associated with any existing pools,
the certificate is not installed on any compute nodes (ev... | def delete(self, thumbprint_algorithm, thumbprint, certificate_delete_options=None, custom_headers=None, raw=False, **operation_config):
| timeout = None
if (certificate_delete_options is not None):
timeout = certificate_delete_options.timeout
client_request_id = None
if (certificate_delete_options is not None):
client_request_id = certificate_delete_options.client_request_id
return_client_request_id = None
if (cert... |
'Gets information about the specified certificate.
:param thumbprint_algorithm: The algorithm used to derive the
thumbprint parameter. This must be sha1.
:type thumbprint_algorithm: str
:param thumbprint: The thumbprint of the certificate to get.
:type thumbprint: str
:param certificate_get_options: Additional paramete... | def get(self, thumbprint_algorithm, thumbprint, certificate_get_options=None, custom_headers=None, raw=False, **operation_config):
| select = None
if (certificate_get_options is not None):
select = certificate_get_options.select
timeout = None
if (certificate_get_options is not None):
timeout = certificate_get_options.timeout
client_request_id = None
if (certificate_get_options is not None):
client_req... |
'Return distribution full name with - replaced with _'
| @property
def wheel_dist_name(self):
| return '-'.join((safer_name(self.distribution.get_name()), safer_version(self.distribution.get_version())))
|
'Return archive name without extension'
| def get_archive_basename(self):
| (impl_tag, abi_tag, plat_tag) = self.get_tag()
archive_basename = ('%s-%s-%s-%s' % (self.wheel_dist_name, impl_tag, abi_tag, plat_tag))
return archive_basename
|
'Return license filename from a license-file key in setup.cfg, or None.'
| def license_file(self):
| metadata = self.distribution.get_option_dict('metadata')
if (not ('license_file' in metadata)):
return None
return metadata['license_file'][1]
|
'Generate requirements from setup.cfg as
(\'Requires-Dist\', \'requirement; qualifier\') tuples. From a metadata
section in setup.cfg:
[metadata]
provides-extra = extra1
extra2
requires-dist = requirement; qualifier
another; qualifier2
unqualified
Yields
(\'Provides-Extra\', \'extra1\'),
(\'Provides-Extra\', \'extra2\'... | def setupcfg_requirements(self):
| metadata = self.distribution.get_option_dict('metadata')
for (key, title) in (('provides_extra', 'Provides-Extra'), ('requires_dist', 'Requires-Dist')):
if (not (key in metadata)):
continue
field = metadata[key]
for line in field[1].splitlines():
line = line.strip... |
'Add additional requirements from setup.cfg to file metadata_path'
| def add_requirements(self, metadata_path):
| additional = list(self.setupcfg_requirements())
if (not additional):
return
pkg_info = read_pkg_info(metadata_path)
if (('Provides-Extra' in pkg_info) or ('Requires-Dist' in pkg_info)):
warnings.warn('setup.cfg requirements overwrite values from setup.py')
del pkg_... |
'Convert an .egg-info directory into a .dist-info directory'
| def egg2dist(self, egginfo_path, distinfo_path):
| def adios(p):
'Appropriately delete directory, file or link.'
if (os.path.exists(p) and (not os.path.islink(p)) and os.path.isdir(p)):
shutil.rmtree(p)
elif os.path.exists(p):
os.unlink(p)
adios(distinfo_path)
if (not os.path.exists(egginfo_path... |
'Gets the queues within a namespace.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the... | def list_by_namespace(self, resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config):
| def internal_paging(next_link=None, raw=False):
if (not next_link):
url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_... |
'Creates or updates a Service Bus queue. This operation is idempotent.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param queue_name: The queue name.
:type queue_name: str
:param ... | def create_or_update(self, resource_group_name, namespace_name, queue_name, parameters, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length=90, min_length=1), 'namespaceNam... |
'Deletes a queue from the specified namespace in a resource group.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param queue_name: The queue name.
:type queue_name: str
:param dict... | def delete(self, resource_group_name, namespace_name, queue_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length=90, min_length=1), 'namespaceNam... |
'Returns a description for the specified queue.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param queue_name: The queue name.
:type queue_name: str
:param dict custom_headers: he... | def get(self, resource_group_name, namespace_name, queue_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length=90, min_length=1), 'namespaceNam... |
'Gets all authorization rules for a queue.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param queue_name: The queue name.
:type queue_name: str
:param dict custom_headers: headers... | def list_authorization_rules(self, resource_group_name, namespace_name, queue_name, custom_headers=None, raw=False, **operation_config):
| def internal_paging(next_link=None, raw=False):
if (not next_link):
url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules'
path_format_arguments = {'resourceGroupName':... |
'Creates an authorization rule for a queue.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param queue_name: The queue name.
:type queue_name: str
:param authorization_rule_name: Th... | def create_or_update_authorization_rule(self, resource_group_name, namespace_name, queue_name, authorization_rule_name, rights=None, custom_headers=None, raw=False, **operation_config):
| parameters = models.SBAuthorizationRule(rights=rights)
url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}'
path_format_arguments = {'resourceGroupName': self._serial... |
'Deletes a queue authorization rule.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param queue_name: The queue name.
:type queue_name: str
:param authorization_rule_name: The autho... | def delete_authorization_rule(self, resource_group_name, namespace_name, queue_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', ... |
'Gets an authorization rule for a queue by rule name.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param queue_name: The queue name.
:type queue_name: str
:param authorization_rul... | def get_authorization_rule(self, resource_group_name, namespace_name, queue_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', ... |
'Primary and secondary connection strings to the queue.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param queue_name: The queue name.
:type queue_name: str
:param authorization_r... | def list_keys(self, resource_group_name, namespace_name, queue_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/ListKeys'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name... |
'Regenerates the primary or secondary connection strings to the queue.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param queue_name: The queue name.
:type queue_name: str
:param ... | def regenerate_keys(self, resource_group_name, namespace_name, queue_name, authorization_rule_name, key_type, key=None, custom_headers=None, raw=False, **operation_config):
| parameters = models.RegenerateAccessKeyParameters(key_type=key_type, key=key)
url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/regenerateKeys'
path_format_argument... |
'Lists all of the available ServiceBus REST API operations.
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:rtype: :clas... | def list(self, custom_headers=None, raw=False, **operation_config):
| def internal_paging(next_link=None, raw=False):
if (not next_link):
url = '/providers/Microsoft.ServiceBus/operations'
query_parameters = {}
query_parameters['api-version'] = self._serialize.query('self.api_version', self.api_version, 'str')
else:
url ... |
'List all the rules within given topic-subscription.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param subscription_name:... | def list_by_subscriptions(self, resource_group_name, namespace_name, topic_name, subscription_name, custom_headers=None, raw=False, **operation_config):
| def internal_paging(next_link=None, raw=False):
if (not next_link):
url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules'
path_format_arguments = {... |
'Creates a new rule and updates an existing rule.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param subscription_name: Th... | def create_or_update(self, resource_group_name, namespace_name, topic_name, subscription_name, rule_name, parameters, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, ... |
'Deletes an existing rule.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param subscription_name: The subscription name.
:t... | def delete(self, resource_group_name, namespace_name, topic_name, subscription_name, rule_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, ... |
'Retrieves the description for the specified rule.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param subscription_name: T... | def get(self, resource_group_name, namespace_name, topic_name, subscription_name, rule_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, ... |
'Gets all the topics in a namespace.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the... | def list_by_namespace(self, resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config):
| def internal_paging(next_link=None, raw=False):
if (not next_link):
url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_... |
'Creates a topic in the specified namespace.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param parameters: Parameters sup... | def create_or_update(self, resource_group_name, namespace_name, topic_name, parameters, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length=90, min_length=1), 'namespaceNam... |
'Deletes a topic from the specified namespace and resource group.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param dict ... | def delete(self, resource_group_name, namespace_name, topic_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length=90, min_length=1), 'namespaceNam... |
'Returns a description for the specified topic.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param dict custom_headers: he... | def get(self, resource_group_name, namespace_name, topic_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length=90, min_length=1), 'namespaceNam... |
'Gets authorization rules for a topic.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param dict custom_headers: headers tha... | def list_authorization_rules(self, resource_group_name, namespace_name, topic_name, custom_headers=None, raw=False, **operation_config):
| def internal_paging(next_link=None, raw=False):
if (not next_link):
url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules'
path_format_arguments = {'resourceGroupName':... |
'Creates an authorizatio rule for the specified topic.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param authorization_ru... | def create_or_update_authorization_rule(self, resource_group_name, namespace_name, topic_name, authorization_rule_name, rights=None, custom_headers=None, raw=False, **operation_config):
| parameters = models.SBAuthorizationRule(rights=rights)
url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}'
path_format_arguments = {'resourceGroupName': self._serial... |
'Returns the specified authorization rule.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param authorization_rule_name: The... | def get_authorization_rule(self, resource_group_name, namespace_name, topic_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', ... |
'Deletes a topic authorization rule.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param authorization_rule_name: The autho... | def delete_authorization_rule(self, resource_group_name, namespace_name, topic_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', ... |
'Gets the primary and secondary connection strings for the topic.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param autho... | def list_keys(self, resource_group_name, namespace_name, topic_name, authorization_rule_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/ListKeys'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name... |
'Regenerates primary or secondary connection strings for the topic.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param aut... | def regenerate_keys(self, resource_group_name, namespace_name, topic_name, authorization_rule_name, key_type, key=None, custom_headers=None, raw=False, **operation_config):
| parameters = models.RegenerateAccessKeyParameters(key_type=key_type, key=key)
url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys'
path_format_argument... |
'List all the subscriptions under a specified topic.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param dict custom_header... | def list_by_topic(self, resource_group_name, namespace_name, topic_name, custom_headers=None, raw=False, **operation_config):
| def internal_paging(next_link=None, raw=False):
if (not next_link):
url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions'
path_format_arguments = {'resourceGroupName': self... |
'Creates a topic subscription.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param subscription_name: The subscription name... | def create_or_update(self, resource_group_name, namespace_name, topic_name, subscription_name, parameters, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length... |
'Deletes a subscription from the specified topic.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param subscription_name: Th... | def delete(self, resource_group_name, namespace_name, topic_name, subscription_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length... |
'Returns a subscription description for the specified topic.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param topic_name: The topic name.
:type topic_name: str
:param subscripti... | def get(self, resource_group_name, namespace_name, topic_name, subscription_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length... |
'Check the give namespace name availability.
:param name: The Name to check the namespce name availability and The
namespace name can contain only letters, numbers, and hyphens. The
namespace must start with a letter, and it must end with a letter or
number.
:type name: str
:param dict custom_headers: headers that will... | def check_name_availability_method(self, name, custom_headers=None, raw=False, **operation_config):
| parameters = models.CheckNameAvailability(name=name)
url = '/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/CheckNameAvailability'
path_format_arguments = {'subscriptionId': self._serialize.url('self.config.subscription_id', self.config.subscription_id, 'str')}
url = self._client.format_u... |
'Gets all the available namespaces within the subscription, irrespective
of the resource groups.
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:... | def list(self, custom_headers=None, raw=False, **operation_config):
| def internal_paging(next_link=None, raw=False):
if (not next_link):
url = '/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces'
path_format_arguments = {'subscriptionId': self._serialize.url('self.config.subscription_id', self.config.subscription_id, 'str')}
... |
'Gets the available namespaces within a resource group.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized respo... | def list_by_resource_group(self, resource_group_name, custom_headers=None, raw=False, **operation_config):
| def internal_paging(next_link=None, raw=False):
if (not next_link):
url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_g... |
'Creates or updates a service namespace. Once created, this namespace\'s
resource manifest is immutable. This operation is idempotent.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name.
:type namespace_name: str... | def create_or_update(self, resource_group_name, namespace_name, parameters, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length=90, min_length=1), 'namespaceName': self._serialize... |
'Deletes an existing namespace. This operation also removes all
associated resources under the namespace.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param dict custom_headers: h... | def delete(self, resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length=90, min_length=1), 'namespaceName': self._serialize... |
'Gets a description for the specified namespace.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param dict custom_headers: headers that will be added to the request
:param bool raw:... | def get(self, resource_group_name, namespace_name, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length=90, min_length=1), 'namespaceName': self._serialize... |
'Updates a service namespace. Once created, this namespace\'s resource
manifest is immutable. This operation is idempotent.
:param resource_group_name: Name of the Resource group within the
Azure subscription.
:type resource_group_name: str
:param namespace_name: The namespace name
:type namespace_name: str
:param para... | def update(self, resource_group_name, namespace_name, parameters, custom_headers=None, raw=False, **operation_config):
| url = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}'
path_format_arguments = {'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str', max_length=90, min_length=1), 'namespaceName': self._serialize... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.