Microsoft Azure

BatchAI

The Azure BatchAI Management API.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Azure BatchAI Management API.

Endpoints 29

Operations

  • GETOperations_List/providers/Microsoft.BatchAI/operations?api-version=stringLists available operations for the Microsoft.BatchAI provider.

Usage

  • GETUsages_List/subscriptions/:subscriptionId/providers/Microsoft.BatchAI/locations/:location/usages?api-version=stringGets the current usage information as well as limits for Batch AI resources for given subscription.

Workspace

  • GETWorkspaces_List/subscriptions/:subscriptionId/providers/Microsoft.BatchAI/workspaces?maxresults=1000&api-version=stringGets a list of Workspaces associated with the given subscription.
  • GETWorkspaces_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces?maxresults=1000&api-version=stringGets a list of Workspaces within the specified resource group.
  • GETWorkspaces_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName?api-version=stringGets information about a Workspace.
  • PUTWorkspaces_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName?api-version=stringCreates a Workspace.
  • DELETEWorkspaces_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName?api-version=stringDeletes a Workspace.
  • PATCHWorkspaces_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName?api-version=stringUpdates properties of a Workspace.

Cluster

  • GETClusters_ListByWorkspace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/clusters?maxresults=1000&api-version=stringGets information about Clusters associated with the given Workspace.
  • GETClusters_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/clusters/:clusterName?api-version=stringGets information about a Cluster.
  • PUTClusters_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/clusters/:clusterName?api-version=stringCreates a Cluster in the given Workspace.
  • DELETEClusters_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/clusters/:clusterName?api-version=stringDeletes a Cluster.
  • PATCHClusters_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/clusters/:clusterName?api-version=stringUpdates properties of a Cluster.
  • POSTClusters_ListRemoteLoginInformation/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/clusters/:clusterName/listRemoteLoginInformation?api-version=stringGet the IP address, port of all the compute nodes in the Cluster.

Experiment

  • GETExperiments_ListByWorkspace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/experiments?maxresults=1000&api-version=stringGets a list of Experiments within the specified Workspace.
  • GETExperiments_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/experiments/:experimentName?api-version=stringGets information about an Experiment.
  • PUTExperiments_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/experiments/:experimentName?api-version=stringCreates an Experiment.
  • DELETEExperiments_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/experiments/:experimentName?api-version=stringDeletes an Experiment.

Job

  • GETJobs_ListByExperiment/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/experiments/:experimentName/jobs?maxresults=1000&api-version=stringGets a list of Jobs within the specified Experiment.
  • GETJobs_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/experiments/:experimentName/jobs/:jobName?api-version=stringGets information about a Job.
  • PUTJobs_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/experiments/:experimentName/jobs/:jobName?api-version=stringCreates a Job in the given Experiment.
  • DELETEJobs_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/experiments/:experimentName/jobs/:jobName?api-version=stringDeletes a Job.
  • POSTJobs_ListOutputFiles/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/experiments/:experimentName/jobs/:jobName/listOutputFiles?outputdirectoryid=string&directory=.&linkexpiryinminutes=60&maxresults=1000&api-version=stringList all directories and files inside the given directory of the Job's output directory (if the output directory is on Azure File Share or Azure Storage…
  • POSTJobs_ListRemoteLoginInformation/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/experiments/:experimentName/jobs/:jobName/listRemoteLoginInformation?api-version=stringGets a list of currently existing nodes which were used for the Job execution. The returned information contains the node ID, its public IP and SSH port.
  • POSTJobs_Terminate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/experiments/:experimentName/jobs/:jobName/terminate?api-version=stringTerminates a job.

FileServer

  • GETFileServers_ListByWorkspace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/fileServers?maxresults=1000&api-version=stringGets a list of File Servers associated with the specified workspace.
  • GETFileServers_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/fileServers/:fileServerName?api-version=stringGets information about a File Server.
  • PUTFileServers_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/fileServers/:fileServerName?api-version=stringCreates a File Server in the given workspace.
  • DELETEFileServers_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.BatchAI/workspaces/:workspaceName/fileServers/:fileServerName?api-version=stringDeletes a File Server.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
29 operations on 17 pathsGET 13PUT 5DELETE 5POST 4PATCH 2
Main resources
Job 7Cluster 6Workspace 6Experiment 4FileServer 4Operations 1Usage 1
Response formats
application/json
Description format
Swagger 2.0, API version 2018-05-01
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the BatchAI in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the BatchAI collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.BatchAI/operations?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the BatchAI?

The Azure BatchAI Management API. It is listed under Developer tools and has 29 endpoints.

Who publishes the BatchAI?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the BatchAI?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the BatchAI?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the BatchAI have?

29 operations on 17 paths (13 GET, 5 PUT, 5 DELETE, 4 POST, 2 PATCH). The largest groups are Job, Cluster, Workspace, Experiment.

Is forking the BatchAI free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.