README

A client for issuing REST requests to the Azure Batch service.

This PHP package is automatically generated by the Swagger Codegen project:

API version: 2016-07-01.3.1
Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Progrupa\Azure\Api\AccountsApi();
$api_version = "api_version_example"; // string | Client API Version.
$filter = "filter_example"; // string | An OData $filter clause.
$maxresults = 1000; // int | The maximum number of items to return in the response. A maximum of 1000 results will be returned.
$timeout = 30; // int | The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
$client_request_id = "client_request_id_example"; // string | The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
$return_client_request_id = false; // bool | Whether the server should return the client-request-id in the response.
$ocp_date = "ocp_date_example"; // string | The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

try {
    $result = $api_instance->accountListNodeAgentSkus($api_version, $filter, $maxresults, $timeout, $client_request_id, $return_client_request_id, $ocp_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountListNodeAgentSkus: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://batch.core.windows.net

Class	Method	HTTP request	Description
AccountsApi	accountListNodeAgentSkus	GET /nodeagentskus	Lists all node agent SKUs supported by the Azure Batch service.
ApplicationsApi	applicationGet	GET /applications/{applicationId}	Gets information about the specified application.
ApplicationsApi	applicationList	GET /applications	Lists all of the applications available in the specified account.
CertificatesApi	certificateAdd	POST /certificates	Adds a certificate to the specified account.
CertificatesApi	certificateCancelDeletion	POST /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete	Cancels a failed deletion of a certificate from the specified account.
CertificatesApi	certificateDelete	DELETE /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})	Deletes a certificate from the specified account.
CertificatesApi	certificateGet	GET /certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})
CertificatesApi	certificateList	GET /certificates	Lists all of the certificates that have been added to the specified account.
ComputeNodesApi	computeNodeAddUser	POST /pools/{poolId}/nodes/{nodeId}/users	Adds a user account to the specified compute node.
ComputeNodesApi	computeNodeDeleteUser	DELETE /pools/{poolId}/nodes/{nodeId}/users/{userName}	Deletes a user account from the specified compute node.
ComputeNodesApi	computeNodeDisableScheduling	POST /pools/{poolId}/nodes/{nodeId}/disablescheduling	Disables task scheduling on the specified compute node.
ComputeNodesApi	computeNodeEnableScheduling	POST /pools/{poolId}/nodes/{nodeId}/enablescheduling	Enables task scheduling on the specified compute node.
ComputeNodesApi	computeNodeGet	GET /pools/{poolId}/nodes/{nodeId}	Gets information about the specified compute node.
ComputeNodesApi	computeNodeGetRemoteDesktop	GET /pools/{poolId}/nodes/{nodeId}/rdp	Gets the Remote Desktop Protocol file for the specified compute node.
ComputeNodesApi	computeNodeGetRemoteLoginSettings	GET /pools/{poolId}/nodes/{nodeId}/remoteloginsettings	Gets the settings required for remote login to a compute node.
ComputeNodesApi	computeNodeList	GET /pools/{poolId}/nodes	Lists the compute nodes in the specified pool.
ComputeNodesApi	computeNodeReboot	POST /pools/{poolId}/nodes/{nodeId}/reboot	Restarts the specified compute node.
ComputeNodesApi	computeNodeReimage	POST /pools/{poolId}/nodes/{nodeId}/reimage	Reinstalls the operating system on the specified compute node.
ComputeNodesApi	computeNodeUpdateUser	PUT /pools/{poolId}/nodes/{nodeId}/users/{userName}	Updates the password or expiration time of a user account on the specified compute node.
ComputeNodesApi	poolRemoveNodes	POST /pools/{poolId}/removenodes	Removes compute nodes from the specified pool.
FilesApi	fileDeleteFromComputeNode	DELETE /pools/{poolId}/nodes/{nodeId}/files/{fileName}	Deletes the specified task file from the compute node.
FilesApi	fileDeleteFromTask	DELETE /jobs/{jobId}/tasks/{taskId}/files/{fileName}	Deletes the specified task file from the compute node where the task ran.
FilesApi	fileGetFromComputeNode	GET /pools/{poolId}/nodes/{nodeId}/files/{fileName}
FilesApi	fileGetFromTask	GET /jobs/{jobId}/tasks/{taskId}/files/{fileName}
FilesApi	fileGetNodeFilePropertiesFromComputeNode	HEAD /pools/{poolId}/nodes/{nodeId}/files/{fileName}
FilesApi	fileGetNodeFilePropertiesFromTask	HEAD /jobs/{jobId}/tasks/{taskId}/files/{fileName}
FilesApi	fileListFromComputeNode	GET /pools/{poolId}/nodes/{nodeId}/files	Lists all of the files in task directories on the specified compute node.
FilesApi	fileListFromTask	GET /jobs/{jobId}/tasks/{taskId}/files	Lists the files in a task's directory on its compute node.
JobSchedulesApi	jobScheduleAdd	POST /jobschedules	Adds a job schedule to the specified account.
JobSchedulesApi	jobScheduleDelete	DELETE /jobschedules/{jobScheduleId}	Deletes a job schedule from the specified account.
JobSchedulesApi	jobScheduleDisable	POST /jobschedules/{jobScheduleId}/disable	Disables a job schedule.
JobSchedulesApi	jobScheduleEnable	POST /jobschedules/{jobScheduleId}/enable	Enables a job schedule.
JobSchedulesApi	jobScheduleExists	HEAD /jobschedules/{jobScheduleId}	Checks the specified job schedule exists.
JobSchedulesApi	jobScheduleGet	GET /jobschedules/{jobScheduleId}
JobSchedulesApi	jobScheduleList	GET /jobschedules	Lists all of the job schedules in the specified account.
JobSchedulesApi	jobSchedulePatch	PATCH /jobschedules/{jobScheduleId}	Updates the properties of the specified job schedule.
JobSchedulesApi	jobScheduleTerminate	POST /jobschedules/{jobScheduleId}/terminate	Terminates a job schedule.
JobSchedulesApi	jobScheduleUpdate	PUT /jobschedules/{jobScheduleId}	Updates the properties of the specified job schedule.
JobsApi	jobAdd	POST /jobs	Adds a job to the specified account.
JobsApi	jobDelete	DELETE /jobs/{jobId}	Deletes a job.
JobsApi	jobDisable	POST /jobs/{jobId}/disable	Disables the specified job, preventing new tasks from running.
JobsApi	jobEnable	POST /jobs/{jobId}/enable	Enables the specified job, allowing new tasks to run.
JobsApi	jobGet	GET /jobs/{jobId}	Gets information about the specified job.
JobsApi	jobGetAllJobsLifetimeStatistics	GET /lifetimejobstats	Gets lifetime summary statistics for all of the jobs in the specified account.
JobsApi	jobList	GET /jobs	Lists all of the jobs in the specified account.
JobsApi	jobListFromJobSchedule	GET /jobschedules/{jobScheduleId}/jobs	Lists the jobs that have been created under the specified job schedule.
JobsApi	jobListPreparationAndReleaseTaskStatus	GET /jobs/{jobId}/jobpreparationandreleasetaskstatus	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.
JobsApi	jobPatch	PATCH /jobs/{jobId}	Updates the properties of the specified job.
JobsApi	jobTerminate	POST /jobs/{jobId}/terminate	Terminates the specified job, marking it as completed.
JobsApi	jobUpdate	PUT /jobs/{jobId}	Updates the properties of the specified job.
PoolsApi	poolAdd	POST /pools	Adds a pool to the specified account.
PoolsApi	poolDelete	DELETE /pools/{poolId}	Deletes a pool from the specified account.
PoolsApi	poolDisableAutoScale	POST /pools/{poolId}/disableautoscale	Disables automatic scaling for a pool.
PoolsApi	poolEnableAutoScale	POST /pools/{poolId}/enableautoscale	Enables automatic scaling for a pool.
PoolsApi	poolEvaluateAutoScale	POST /pools/{poolId}/evaluateautoscale	Gets the result of evaluating an automatic scaling formula on the pool.
PoolsApi	poolExists	HEAD /pools/{poolId}
PoolsApi	poolGet	GET /pools/{poolId}
PoolsApi	poolGetAllPoolsLifetimeStatistics	GET /lifetimepoolstats	Gets lifetime summary statistics for all of the pools in the specified account.
PoolsApi	poolList	GET /pools	Lists all of the pools in the specified account.
PoolsApi	poolListPoolUsageMetrics	GET /poolusagemetrics	Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account.
PoolsApi	poolPatch	PATCH /pools/{poolId}	Updates the properties of the specified pool.
PoolsApi	poolResize	POST /pools/{poolId}/resize	Changes the number of compute nodes that are assigned to a pool.
PoolsApi	poolStopResize	POST /pools/{poolId}/stopresize	Stops an ongoing resize operation on the pool.
PoolsApi	poolUpdateProperties	POST /pools/{poolId}/updateproperties	Updates the properties of the specified pool.
PoolsApi	poolUpgradeOS	POST /pools/{poolId}/upgradeos	Upgrades the operating system of the specified pool.
TasksApi	taskAdd	POST /jobs/{jobId}/tasks	Adds a task to the specified job.
TasksApi	taskAddCollection	POST /jobs/{jobId}/addtaskcollection	Adds a collection of tasks to the specified job.
TasksApi	taskDelete	DELETE /jobs/{jobId}/tasks/{taskId}	Deletes a task from the specified job.
TasksApi	taskGet	GET /jobs/{jobId}/tasks/{taskId}	Gets information about the specified task.
TasksApi	taskList	GET /jobs/{jobId}/tasks	Lists all of the tasks that are associated with the specified job.
TasksApi	taskListSubtasks	GET /jobs/{jobId}/tasks/{taskId}/subtasksinfo	Lists all of the subtasks that are associated with the specified multi-instance task.
TasksApi	taskReactivate	POST /jobs/{jobId}/tasks/{taskId}/reactivate	Reactivates the specified task.
TasksApi	taskTerminate	POST /jobs/{jobId}/tasks/{taskId}/terminate	Terminates the specified task.
TasksApi	taskUpdate	PUT /jobs/{jobId}/tasks/{taskId}

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

progrupa / azure-rest-api

Maintainers

Details