schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
service-schema.json
jdkArchitectureOption
JDK architecture
{"ignoreCase": "all", "enum": ["x86", "x64"], "aliases": ["jdkArchitecture"]}
service-schema.json
task
Copy and Publish Build Artifacts [DEPRECATED] Use the Copy Files task and the Publish Build Artifacts task instead
{"ignoreCase": "value", "pattern": "^CopyPublishBuildArtifacts@1$"}
service-schema.json
inputs
Copy and Publish Build Artifacts inputs
{"properties": {"CopyRoot": {"type": "string", "ignoreCase": "key"}, "Contents": {"type": "string", "ignoreCase": "key"}, "ArtifactName": {"type": "string", "ignoreCase": "key"}, "ArtifactType": {"ignoreCase": "all", "enum": ["Container", "FilePath"]}, "TargetPath": {"type": "string", "ignoreCase": "key"}}, "additionalProperties": false, "required": ["Contents", "ArtifactName", "ArtifactType"]}
service-schema.json
CopyRoot
Copy Root
{"type": "string", "ignoreCase": "key"}
service-schema.json
Contents
Contents
{"type": "string", "ignoreCase": "key"}
service-schema.json
ArtifactName
Artifact Name
{"type": "string", "ignoreCase": "key"}
service-schema.json
ArtifactType
Artifact Type
{"ignoreCase": "all", "enum": ["Container", "FilePath"]}
service-schema.json
TargetPath
Path
{"type": "string", "ignoreCase": "key"}
service-schema.json
task
Download package Download a package from a package management feed in Azure Artifacts
{"ignoreCase": "value", "pattern": "^DownloadPackage@0$"}
service-schema.json
inputs
Download package inputs
{"properties": {"feed": {"type": "string", "ignoreCase": "key"}, "definition": {"type": "string", "ignoreCase": "key"}, "version": {"type": "string", "ignoreCase": "key"}, "downloadPath": {"type": "string", "ignoreCase": "key"}}, "additionalProperties": false, "required": ["feed", "definition", "version"]}
service-schema.json
feed
Feed
{"type": "string", "ignoreCase": "key"}
service-schema.json
definition
Package
{"type": "string", "ignoreCase": "key"}
service-schema.json
version
Version
{"type": "string", "ignoreCase": "key"}
service-schema.json
downloadPath
Destination directory
{"type": "string", "ignoreCase": "key"}
service-schema.json
task
Download package Download a package from a package management feed in Azure Artifacts
{"ignoreCase": "value", "pattern": "^DownloadPackage@1$"}
service-schema.json
inputs
Download package inputs
{"properties": {"packageType": {"ignoreCase": "all", "enum": ["maven", "npm", "nuget", "pypi", "upack", "cargo"]}, "feed": {"type": "string", "ignoreCase": "key"}, "view": {"type": "string", "ignoreCase": "key"}, "definition": {"type": "string", "ignoreCase": "key"}, "version": {"type": "string", "ignoreCase": "key"}, "files": {"type": "string", "ignoreCase": "key"}, "extract": {"type": "boolean", "ignoreCase": "key"}, "downloadPath": {"type": "string", "ignoreCase": "key"}}, "additionalProperties": false, "required": ["feed", "definition", "version"]}
service-schema.json
packageType
Package Type
{"ignoreCase": "all", "enum": ["maven", "npm", "nuget", "pypi", "upack", "cargo"]}
service-schema.json
feed
Feed
{"type": "string", "ignoreCase": "key"}
service-schema.json
view
View
{"type": "string", "ignoreCase": "key"}
service-schema.json
definition
Package
{"type": "string", "ignoreCase": "key"}
service-schema.json
version
Version
{"type": "string", "ignoreCase": "key"}
service-schema.json
files
Files
{"type": "string", "ignoreCase": "key"}
service-schema.json
extract
Extract package contents
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
downloadPath
Destination directory
{"type": "string", "ignoreCase": "key"}
service-schema.json
task
ARM template deployment Deploy an Azure Resource Manager (ARM) template to all the deployment scopes
{"ignoreCase": "value", "pattern": "^AzureResourceManagerTemplateDeployment@3$"}
service-schema.json
inputs
ARM template deployment inputs
{"properties": {"deploymentScope": {"ignoreCase": "all", "enum": ["Management Group", "Subscription", "Resource Group"]}, "azureResourceManagerConnection": {"type": "string", "ignoreCase": "key", "aliases": ["ConnectedServiceName"]}, "subscriptionId": {"type": "string", "ignoreCase": "key", "aliases": ["subscriptionName"]}, "action": {"ignoreCase": "all", "enum": ["Create Or Update Resource Group", "DeleteRG"]}, "resourceGroupName": {"type": "string", "ignoreCase": "key"}, "location": {"type": "string", "ignoreCase": "key"}, "templateLocation": {"ignoreCase": "all", "enum": ["Linked artifact", "URL of the file"]}, "csmFileLink": {"type": "string", "ignoreCase": "key"}, "csmParametersFileLink": {"type": "string", "ignoreCase": "key"}, "csmFile": {"type": "string", "ignoreCase": "key"}, "csmParametersFile": {"type": "string", "ignoreCase": "key"}, "overrideParameters": {"type": "string", "ignoreCase": "key"}, "deploymentMode": {"ignoreCase": "all", "enum": ["Incremental", "Complete", "Validation"]}, "deploymentName": {"type": "string", "ignoreCase": "key"}, "deploymentOutputs": {"type": "string", "ignoreCase": "key"}, "addSpnToEnvironment": {"type": "boolean", "ignoreCase": "key"}}, "additionalProperties": false, "required": ["azureResourceManagerConnection"]}
service-schema.json
deploymentScope
Deployment scope
{"ignoreCase": "all", "enum": ["Management Group", "Subscription", "Resource Group"]}
service-schema.json
azureResourceManagerConnection
Azure Resource Manager connection
{"type": "string", "ignoreCase": "key", "aliases": ["ConnectedServiceName"]}
service-schema.json
subscriptionId
Subscription
{"type": "string", "ignoreCase": "key", "aliases": ["subscriptionName"]}
service-schema.json
action
Action
{"ignoreCase": "all", "enum": ["Create Or Update Resource Group", "DeleteRG"]}
service-schema.json
resourceGroupName
Resource group
{"type": "string", "ignoreCase": "key"}
service-schema.json
location
Location
{"type": "string", "ignoreCase": "key"}
service-schema.json
templateLocation
Template location
{"ignoreCase": "all", "enum": ["Linked artifact", "URL of the file"]}
service-schema.json
csmFileLink
Template link
{"type": "string", "ignoreCase": "key"}
service-schema.json
csmParametersFileLink
Template parameters link
{"type": "string", "ignoreCase": "key"}
service-schema.json
csmFile
Template
{"type": "string", "ignoreCase": "key"}
service-schema.json
csmParametersFile
Template parameters
{"type": "string", "ignoreCase": "key"}
service-schema.json
overrideParameters
Override template parameters
{"type": "string", "ignoreCase": "key"}
service-schema.json
deploymentMode
Deployment mode
{"ignoreCase": "all", "enum": ["Incremental", "Complete", "Validation"]}
service-schema.json
deploymentName
Deployment name
{"type": "string", "ignoreCase": "key"}
service-schema.json
deploymentOutputs
Deployment outputs
{"type": "string", "ignoreCase": "key"}
service-schema.json
addSpnToEnvironment
Access service principal details in override parameters
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
task
Azure Resource Group Deployment Deploy, start, stop, delete Azure Resource Groups
{"ignoreCase": "value", "pattern": "^AzureResourceGroupDeployment@1$"}
service-schema.json
inputs
Azure Resource Group Deployment inputs
{"properties": {"ConnectedServiceNameSelector": {"ignoreCase": "all", "enum": ["ConnectedServiceName", "ConnectedServiceNameClassic"]}, "ConnectedServiceName": {"type": "string", "ignoreCase": "key"}, "ConnectedServiceNameClassic": {"type": "string", "ignoreCase": "key"}, "action": {"ignoreCase": "all", "enum": ["Create Or Update Resource Group", "Select Resource Group", "Start", "Stop", "Restart", "Delete", "DeleteRG"]}, "actionClassic": {"ignoreCase": "all", "enum": ["Select Resource Group"]}, "resourceGroupName": {"type": "string", "ignoreCase": "key"}, "cloudService": {"type": "string", "ignoreCase": "key"}, "location": {"ignoreCase": "all", "enum": ["Australia East", "Australia Southeast", "Brazil South", "Canada Central", "Canada East", "Central India", "Central US", "East Asia", "East US", "East US 2 ", "Japan East", "Japan West", "North Central US", "North Europe", "South Central US", "South India", "Southeast Asia", "UK South", "UK West", "West Central US", "West Europe", "West India", "West US", "West US 2"]}, "csmFile": {"type": "string", "ignoreCase": "key"}, "csmParametersFile": {"type": "string", "ignoreCase": "key"}, "overrideParameters": {"type": "string", "ignoreCase": "key"}, "deploymentMode": {"ignoreCase": "all", "enum": ["Validation", "Incremental", "Complete"]}, "enableDeploymentPrerequisitesForCreate": {"type": "boolean", "ignoreCase": "key"}, "enableDeploymentPrerequisitesForSelect": {"type": "boolean", "ignoreCase": "key"}, "outputVariable": {"type": "string", "ignoreCase": "key"}}, "additionalProperties": false, "required": []}
service-schema.json
ConnectedServiceNameSelector
Azure Connection Type
{"ignoreCase": "all", "enum": ["ConnectedServiceName", "ConnectedServiceNameClassic"]}
service-schema.json
ConnectedServiceName
Azure Subscription
{"type": "string", "ignoreCase": "key"}
service-schema.json
ConnectedServiceNameClassic
Azure Classic Subscription
{"type": "string", "ignoreCase": "key"}
service-schema.json
action
Action
{"ignoreCase": "all", "enum": ["Create Or Update Resource Group", "Select Resource Group", "Start", "Stop", "Restart", "Delete", "DeleteRG"]}
service-schema.json
actionClassic
Action
{"ignoreCase": "all", "enum": ["Select Resource Group"]}
service-schema.json
resourceGroupName
Resource Group
{"type": "string", "ignoreCase": "key"}
service-schema.json
cloudService
Cloud Service
{"type": "string", "ignoreCase": "key"}
service-schema.json
location
Location
{"ignoreCase": "all", "enum": ["Australia East", "Australia Southeast", "Brazil South", "Canada Central", "Canada East", "Central India", "Central US", "East Asia", "East US", "East US 2 ", "Japan East", "Japan West", "North Central US", "North Europe", "South Central US", "South India", "Southeast Asia", "UK South", "UK West", "West Central US", "West Europe", "West India", "West US", "West US 2"]}
service-schema.json
csmFile
Template
{"type": "string", "ignoreCase": "key"}
service-schema.json
csmParametersFile
Template Parameters
{"type": "string", "ignoreCase": "key"}
service-schema.json
overrideParameters
Override Template Parameters
{"type": "string", "ignoreCase": "key"}
service-schema.json
deploymentMode
Deployment Mode
{"ignoreCase": "all", "enum": ["Validation", "Incremental", "Complete"]}
service-schema.json
enableDeploymentPrerequisitesForCreate
Enable Deployment Prerequisites
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
enableDeploymentPrerequisitesForSelect
Enable Deployment Prerequisites
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
outputVariable
Resource Group
{"type": "string", "ignoreCase": "key"}
service-schema.json
task
Azure resource group deployment Deploy an Azure Resource Manager (ARM) template to a resource group and manage virtual machines
{"ignoreCase": "value", "pattern": "^AzureResourceGroupDeployment@2$"}
service-schema.json
inputs
Azure resource group deployment inputs
{"properties": {"azureSubscription": {"type": "string", "ignoreCase": "key", "aliases": ["ConnectedServiceName"]}, "action": {"ignoreCase": "all", "enum": ["Create Or Update Resource Group", "Select Resource Group", "Start", "Stop", "StopWithDeallocate", "Restart", "Delete", "DeleteRG"]}, "resourceGroupName": {"type": "string", "ignoreCase": "key"}, "location": {"type": "string", "ignoreCase": "key"}, "templateLocation": {"ignoreCase": "all", "enum": ["Linked artifact", "URL of the file"]}, "csmFileLink": {"type": "string", "ignoreCase": "key"}, "csmParametersFileLink": {"type": "string", "ignoreCase": "key"}, "csmFile": {"type": "string", "ignoreCase": "key"}, "csmParametersFile": {"type": "string", "ignoreCase": "key"}, "overrideParameters": {"type": "string", "ignoreCase": "key"}, "deploymentMode": {"ignoreCase": "all", "enum": ["Incremental", "Complete", "Validation"]}, "enableDeploymentPrerequisites": {"ignoreCase": "all", "enum": ["None", "ConfigureVMwithWinRM", "ConfigureVMWithDGAgent"]}, "teamServicesConnection": {"type": "string", "ignoreCase": "key", "aliases": ["deploymentGroupEndpoint"]}, "teamProject": {"type": "string", "ignoreCase": "key", "aliases": ["project"]}, "deploymentGroupName": {"type": "string", "ignoreCase": "key"}, "copyAzureVMTags": {"type": "boolean", "ignoreCase": "key"}, "runAgentServiceAsUser": {"type": "boolean", "ignoreCase": "key"}, "userName": {"type": "string", "ignoreCase": "key"}, "password": {"type": "string", "ignoreCase": "key"}, "outputVariable": {"type": "string", "ignoreCase": "key"}, "deploymentName": {"type": "string", "ignoreCase": "key"}, "deploymentOutputs": {"type": "string", "ignoreCase": "key"}, "addSpnToEnvironment": {"type": "boolean", "ignoreCase": "key"}}, "additionalProperties": false, "required": ["azureSubscription", "resourceGroupName"]}
service-schema.json
azureSubscription
Azure subscription
{"type": "string", "ignoreCase": "key", "aliases": ["ConnectedServiceName"]}
service-schema.json
action
Action
{"ignoreCase": "all", "enum": ["Create Or Update Resource Group", "Select Resource Group", "Start", "Stop", "StopWithDeallocate", "Restart", "Delete", "DeleteRG"]}
service-schema.json
resourceGroupName
Resource group
{"type": "string", "ignoreCase": "key"}
service-schema.json
location
Location
{"type": "string", "ignoreCase": "key"}
service-schema.json
templateLocation
Template location
{"ignoreCase": "all", "enum": ["Linked artifact", "URL of the file"]}
service-schema.json
csmFileLink
Template link
{"type": "string", "ignoreCase": "key"}
service-schema.json
csmParametersFileLink
Template parameters link
{"type": "string", "ignoreCase": "key"}
service-schema.json
csmFile
Template
{"type": "string", "ignoreCase": "key"}
service-schema.json
csmParametersFile
Template parameters
{"type": "string", "ignoreCase": "key"}
service-schema.json
overrideParameters
Override template parameters
{"type": "string", "ignoreCase": "key"}
service-schema.json
deploymentMode
Deployment mode
{"ignoreCase": "all", "enum": ["Incremental", "Complete", "Validation"]}
service-schema.json
enableDeploymentPrerequisites
Enable prerequisites
{"ignoreCase": "all", "enum": ["None", "ConfigureVMwithWinRM", "ConfigureVMWithDGAgent"]}
service-schema.json
teamServicesConnection
Azure Pipelines service connection
{"type": "string", "ignoreCase": "key", "aliases": ["deploymentGroupEndpoint"]}
service-schema.json
teamProject
Team project
{"type": "string", "ignoreCase": "key", "aliases": ["project"]}
service-schema.json
deploymentGroupName
Deployment Group
{"type": "string", "ignoreCase": "key"}
service-schema.json
copyAzureVMTags
Copy Azure VM tags to agents
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
runAgentServiceAsUser
Run agent service as a user
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
userName
User name
{"type": "string", "ignoreCase": "key"}
service-schema.json
password
Password
{"type": "string", "ignoreCase": "key"}
service-schema.json
outputVariable
VM details for WinRM
{"type": "string", "ignoreCase": "key"}
service-schema.json
deploymentName
Deployment name
{"type": "string", "ignoreCase": "key"}
service-schema.json
deploymentOutputs
Deployment outputs
{"type": "string", "ignoreCase": "key"}
service-schema.json
addSpnToEnvironment
Access service principal details in override parameters
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
task
Invoke REST API Invoke REST API as a part of your process.
{"ignoreCase": "value", "pattern": "^InvokeRESTAPI@0$"}
service-schema.json
inputs
Invoke REST API inputs
{"properties": {"serviceConnection": {"type": "string", "ignoreCase": "key", "aliases": ["connectedServiceName"]}, "method": {"ignoreCase": "all", "enum": ["OPTIONS", "GET", "HEAD", "POST", "PUT", "DELETE", "TRACE", "PATCH"]}, "headers": {"type": "string", "ignoreCase": "key"}, "body": {"type": "string", "ignoreCase": "key"}, "urlSuffix": {"type": "string", "ignoreCase": "key"}, "waitForCompletion": {"ignoreCase": "all", "enum": ["true", "false"]}, "successCriteria": {"type": "string", "ignoreCase": "key"}}, "additionalProperties": false, "required": ["serviceConnection"]}
service-schema.json
serviceConnection
Generic endpoint
{"type": "string", "ignoreCase": "key", "aliases": ["connectedServiceName"]}
service-schema.json
method
Method
{"ignoreCase": "all", "enum": ["OPTIONS", "GET", "HEAD", "POST", "PUT", "DELETE", "TRACE", "PATCH"]}
service-schema.json
headers
Headers
{"type": "string", "ignoreCase": "key"}
service-schema.json
body
Body
{"type": "string", "ignoreCase": "key"}
service-schema.json
urlSuffix
Url suffix string
{"type": "string", "ignoreCase": "key"}
service-schema.json
waitForCompletion
Complete based on
{"ignoreCase": "all", "enum": ["true", "false"]}
service-schema.json
successCriteria
Success criteria
{"type": "string", "ignoreCase": "key"}
service-schema.json
task
Invoke REST API Invoke a REST API as a part of your pipeline.
{"ignoreCase": "value", "pattern": "^InvokeRESTAPI@1$"}
service-schema.json
inputs
Invoke REST API inputs
{"properties": {"connectionType": {"ignoreCase": "all", "enum": ["connectedServiceName", "connectedServiceNameARM"], "aliases": ["connectedServiceNameSelector"]}, "serviceConnection": {"type": "string", "ignoreCase": "key", "aliases": ["connectedServiceName", "genericService"]}, "azureServiceConnection": {"type": "string", "ignoreCase": "key", "aliases": ["connectedServiceNameARM", "azureSubscription"]}, "method": {"ignoreCase": "all", "enum": ["OPTIONS", "GET", "HEAD", "POST", "PUT", "DELETE", "TRACE", "PATCH"]}, "headers": {"type": "string", "ignoreCase": "key"}, "body": {"type": "string", "ignoreCase": "key"}, "urlSuffix": {"type": "string", "ignoreCase": "key"}, "waitForCompletion": {"ignoreCase": "all", "enum": ["true", "false"]}, "successCriteria": {"type": "string", "ignoreCase": "key"}}, "additionalProperties": false, "required": []}
service-schema.json
connectionType
Connection type
{"ignoreCase": "all", "enum": ["connectedServiceName", "connectedServiceNameARM"], "aliases": ["connectedServiceNameSelector"]}
service-schema.json
serviceConnection
Generic service connection
{"type": "string", "ignoreCase": "key", "aliases": ["connectedServiceName", "genericService"]}
service-schema.json
azureServiceConnection
Azure subscription
{"type": "string", "ignoreCase": "key", "aliases": ["connectedServiceNameARM", "azureSubscription"]}
service-schema.json
method
Method
{"ignoreCase": "all", "enum": ["OPTIONS", "GET", "HEAD", "POST", "PUT", "DELETE", "TRACE", "PATCH"]}
service-schema.json
headers
Headers
{"type": "string", "ignoreCase": "key"}