Artifact Sources - Create Or Update
Create or replace an existing artifact source.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}?api-version=2018-09-15
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
lab
|
path | True |
string |
The name of the lab. |
name
|
path | True |
string |
The name of the artifact source. |
resource
|
path | True |
string |
The name of the resource group. |
subscription
|
path | True |
string |
The subscription ID. |
api-version
|
query | True |
string |
Client API version. |
Request Body
Name | Type | Description |
---|---|---|
location |
string |
The location of the resource. |
properties.armTemplateFolderPath |
string |
The folder containing Azure Resource Manager templates. |
properties.branchRef |
string |
The artifact source's branch reference. |
properties.displayName |
string |
The artifact source's display name. |
properties.folderPath |
string |
The folder containing artifacts. |
properties.securityToken |
string |
The security token to authenticate to the artifact source. |
properties.sourceType |
The artifact source's type. |
|
properties.status |
Indicates if the artifact source is enabled (values: Enabled, Disabled). |
|
properties.uri |
string |
The artifact source's URI. |
tags |
object |
The tags of the resource. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
201 Created |
Created |
|
Other Status Codes |
BadRequest |
Security
azure_auth
OAuth2 Implicit Grant
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Access Microsoft Azure |
Examples
ArtifactSources_CreateOrUpdate
Sample request
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}?api-version=2018-09-15
{
"properties": {
"displayName": "{displayName}",
"uri": "{artifactSourceUri}",
"sourceType": "{VsoGit|GitHub|StorageAccount}",
"folderPath": "{folderPath}",
"armTemplateFolderPath": "{armTemplateFolderPath}",
"branchRef": "{branchRef}",
"securityToken": "{securityToken}",
"status": "{Enabled|Disabled}"
},
"tags": {
"tagName1": "tagValue1"
}
}
Sample response
{
"properties": {
"displayName": "{displayName}",
"uri": "{artifactSourceUri}",
"sourceType": "{VsoGit|GitHub|StorageAccount}",
"folderPath": "{folderPath}",
"armTemplateFolderPath": "{armTemplateFolderPath}",
"branchRef": "{branchRef}",
"securityToken": "{securityToken}",
"status": "{Enabled|Disabled}",
"createdDate": "2020-12-16T16:53:02.4830866-07:00",
"provisioningState": "Succeeded",
"uniqueIdentifier": "{uniqueIdentifier}"
},
"id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}",
"name": "{artifactSourceName}",
"type": "Microsoft.DevTestLab/labs/artifactsources",
"location": "{location}",
"tags": {
"tagName1": "tagValue1"
}
}
{
"properties": {
"displayName": "{displayName}",
"uri": "{artifactSourceUri}",
"sourceType": "{VsoGit|GitHub|StorageAccount}",
"folderPath": "{folderPath}",
"armTemplateFolderPath": "{armTemplateFolderPath}",
"branchRef": "{branchRef}",
"securityToken": "{securityToken}",
"status": "{Enabled|Disabled}",
"createdDate": "2020-12-16T16:53:02.4830866-07:00",
"provisioningState": "Created",
"uniqueIdentifier": "{uniqueIdentifier}"
},
"id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}",
"name": "{artifactSourceName}",
"type": "Microsoft.DevTestLab/labs/artifactsources",
"location": "{location}",
"tags": {
"tagName1": "tagValue1"
}
}
Definitions
Name | Description |
---|---|
Artifact |
Properties of an artifact source. |
Cloud |
Error from a REST request. |
Cloud |
Body of an error from a REST request. |
Enable |
The status of the schedule (i.e. Enabled, Disabled) |
Source |
The artifact source's type. |
ArtifactSource
Properties of an artifact source.
Name | Type | Description |
---|---|---|
id |
string |
The identifier of the resource. |
location |
string |
The location of the resource. |
name |
string |
The name of the resource. |
properties.armTemplateFolderPath |
string |
The folder containing Azure Resource Manager templates. |
properties.branchRef |
string |
The artifact source's branch reference. |
properties.createdDate |
string |
The artifact source's creation date. |
properties.displayName |
string |
The artifact source's display name. |
properties.folderPath |
string |
The folder containing artifacts. |
properties.provisioningState |
string |
The provisioning status of the resource. |
properties.securityToken |
string |
The security token to authenticate to the artifact source. |
properties.sourceType |
The artifact source's type. |
|
properties.status |
Indicates if the artifact source is enabled (values: Enabled, Disabled). |
|
properties.uniqueIdentifier |
string |
The unique immutable identifier of a resource (Guid). |
properties.uri |
string |
The artifact source's URI. |
tags |
object |
The tags of the resource. |
type |
string |
The type of the resource. |
CloudError
Error from a REST request.
Name | Type | Description |
---|---|---|
error |
The cloud error that occurred |
CloudErrorBody
Body of an error from a REST request.
Name | Type | Description |
---|---|---|
code |
string |
The error code. |
details |
Inner errors. |
|
message |
string |
The error message. |
target |
string |
The error target. |
EnableStatus
The status of the schedule (i.e. Enabled, Disabled)
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
SourceControlType
The artifact source's type.
Name | Type | Description |
---|---|---|
GitHub |
string |
|
StorageAccount |
string |
|
VsoGit |
string |