Azure DevTest Labs ServiceRunners API
The ServiceRunners API from Azure DevTest Labs — 1 operation(s) for servicerunners.
The ServiceRunners API from Azure DevTest Labs — 1 operation(s) for servicerunners.
swagger: '2.0'
info:
description: The DevTest Labs Client.
title: DevTestLabsClient ArmTemplates ServiceRunners API
version: '2018-09-15'
x-apisguru-categories:
- cloud
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png
x-origin:
- format: swagger
url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json
version: '2.0'
x-preferred: true
x-providerName: azure.com
x-serviceName: devtestlabs-DTL
x-tags:
- Azure
- Microsoft
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
tags:
- name: ServiceRunners
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners/{name}
: delete:
description: Delete service runner.
operationId: ServiceRunners_Delete
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- description: The name of the lab.
in: path
name: labName
required: true
type: string
example: example-value
- description: The name of the service runner.
in: path
name: name
required: true
type: string
example: example-value
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK
'204':
description: No Content
default:
description: BadRequest
schema:
$ref: '#/definitions/CloudError'
tags:
- ServiceRunners
summary: Azure DevTest Labs Service Runners_ Delete
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
description: Get service runner.
operationId: ServiceRunners_Get
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- description: The name of the lab.
in: path
name: labName
required: true
type: string
example: example-value
- description: The name of the service runner.
in: path
name: name
required: true
type: string
example: example-value
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ServiceRunner'
default:
description: BadRequest
schema:
$ref: '#/definitions/CloudError'
tags:
- ServiceRunners
summary: Azure DevTest Labs Service Runners_ Get
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
description: Create or replace an existing service runner.
operationId: ServiceRunners_CreateOrUpdate
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- description: The name of the lab.
in: path
name: labName
required: true
type: string
example: example-value
- description: The name of the service runner.
in: path
name: name
required: true
type: string
example: example-value
- description: A container for a managed identity to execute DevTest lab services.
in: body
name: serviceRunner
required: true
schema:
$ref: '#/definitions/ServiceRunner'
example: example-value
- $ref: '#/parameters/api-version'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ServiceRunner'
'201':
description: Created
schema:
$ref: '#/definitions/ServiceRunner'
default:
description: BadRequest
schema:
$ref: '#/definitions/CloudError'
tags:
- ServiceRunners
summary: Azure DevTest Labs Service Runners_ Create or Update
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
definitions:
Resource:
description: An Azure resource.
properties:
id:
description: The identifier of the resource.
readOnly: true
type: string
location:
description: The location of the resource.
type: string
name:
description: The name of the resource.
readOnly: true
type: string
tags:
additionalProperties:
type: string
description: The tags of the resource.
type: object
type:
description: The type of the resource.
readOnly: true
type: string
type: object
x-ms-azure-resource: true
CloudError:
description: Error from a REST request.
properties:
error:
$ref: '#/definitions/CloudErrorBody'
description: The cloud error that occurred
type: object
x-ms-external: true
CloudErrorBody:
description: Body of an error from a REST request.
properties:
code:
description: The error code.
type: string
details:
description: Inner errors.
items:
$ref: '#/definitions/CloudErrorBody'
type: array
message:
description: The error message.
type: string
target:
description: The error target.
type: string
type: object
x-ms-external: true
IdentityProperties:
description: Properties of a managed identity
properties:
clientSecretUrl:
description: The client secret URL of the identity.
type: string
principalId:
description: The principal id of resource identity.
type: string
tenantId:
description: The tenant identifier of resource.
type: string
type:
description: Managed identity.
type: string
type: object
ServiceRunner:
allOf:
- $ref: '#/definitions/Resource'
description: A container for a managed identity to execute DevTest lab services.
properties:
identity:
$ref: '#/definitions/IdentityProperties'
description: The identity of the resource.
type: object
parameters:
resourceGroupName:
description: The name of the resource group.
in: path
name: resourceGroupName
required: true
type: string
x-ms-parameter-location: method
subscriptionId:
description: The subscription ID.
in: path
name: subscriptionId
required: true
type: string
api-version:
default: '2018-09-15'
description: Client API version.
in: query
name: api-version
required: true
type: string
securityDefinitions:
azure_auth:
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
description: OAuth2 Implicit Grant
flow: implicit
scopes:
user_impersonation: Access Microsoft Azure
type: oauth2