Share via


Artifact Sources - Get

Get artifact source.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}?api-version=2018-09-15
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}?api-version=2018-09-15&$expand={$expand}

URI Parameters

Name In Required Type Description
labName
path True

string

The name of the lab.

name
path True

string

The name of the ArtifactSource

resourceGroupName
path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

minLength: 1

The ID of the target subscription.

api-version
query True

string

minLength: 1

The API version to use for this operation.

$expand
query

string

Specify the $expand query. Example: 'properties($select=displayName)'

Responses

Name Type Description
200 OK

ArtifactSource

Azure operation completed successfully.

Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ArtifactSources_Get

Sample request

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}?api-version=2018-09-15

Sample response

{
  "name": "{artifactSourceName}",
  "type": "Microsoft.DevTestLab/labs/artifactsources",
  "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}",
  "location": "{location}",
  "properties": {
    "armTemplateFolderPath": "{armTemplateFolderPath}",
    "branchRef": "{branchRef}",
    "createdDate": "2020-12-16T16:53:02.4830866-07:00",
    "displayName": "{displayName}",
    "folderPath": "{folderPath}",
    "provisioningState": "Succeeded",
    "securityToken": "{securityToken}",
    "sourceType": "{VsoGit|GitHub|StorageAccount}",
    "status": "{Enabled|Disabled}",
    "uniqueIdentifier": "{uniqueIdentifier}",
    "uri": "{artifactSourceUri}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definitions

Name Description
ArtifactSource

Properties of an artifact source.

EnableStatus

Indicates if the artifact source is enabled (values: Enabled, Disabled).

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

SourceControlType

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 (date-time)

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

SourceControlType

The artifact source's type.

properties.status

EnableStatus

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.

EnableStatus

Indicates if the artifact source is enabled (values: Enabled, Disabled).

Value Description
Enabled
Disabled

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

SourceControlType

The artifact source's type.

Value Description
VsoGit
GitHub
StorageAccount