schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
service-schema.json
body
Body
{"type": "string", "ignoreCase": "key"}
service-schema.json
urlSuffix
URL suffix and parameters
{"type": "string", "ignoreCase": "key"}
service-schema.json
waitForCompletion
Completion event
{"ignoreCase": "all", "enum": ["true", "false"]}
service-schema.json
successCriteria
Success criteria
{"type": "string", "ignoreCase": "key"}
service-schema.json
task
Archive Files Archive files using compression formats such as .7z, .rar, .tar.gz, and .zip.
{"ignoreCase": "value", "pattern": "^ArchiveFiles@1$"}
service-schema.json
inputs
Archive Files inputs
{"properties": {"rootFolder": {"type": "string", "ignoreCase": "key"}, "includeRootFolder": {"type": "boolean", "ignoreCase": "key"}, "archiveType": {"ignoreCase": "all", "enum": ["default", "7z", "tar", "wim"]}, "tarCompression": {"ignoreCase": "all", "enum": ["gz", "bz2", "xz", "none"]}, "archiveFile": {"type": "string", "ignoreCase": "key"}, "replaceExistingArchive": {"type": "boolean", "ignoreCase": "key"}}, "additionalProperties": false, "required": []}
service-schema.json
rootFolder
Root folder (or file) to archive
{"type": "string", "ignoreCase": "key"}
service-schema.json
includeRootFolder
Prefix root folder name to archive paths
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
archiveType
Archive type
{"ignoreCase": "all", "enum": ["default", "7z", "tar", "wim"]}
service-schema.json
tarCompression
Tar compression
{"ignoreCase": "all", "enum": ["gz", "bz2", "xz", "none"]}
service-schema.json
archiveFile
Archive file to create
{"type": "string", "ignoreCase": "key"}
service-schema.json
replaceExistingArchive
Replace existing archive
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
task
Archive files Compress files into .7z, .tar.gz, or .zip
{"ignoreCase": "value", "pattern": "^ArchiveFiles@2$"}
service-schema.json
inputs
Archive files inputs
{"properties": {"rootFolderOrFile": {"type": "string", "ignoreCase": "key"}, "includeRootFolder": {"type": "boolean", "ignoreCase": "key"}, "archiveType": {"ignoreCase": "all", "enum": ["zip", "7z", "tar", "wim"]}, "sevenZipCompression": {"ignoreCase": "all", "enum": ["ultra", "maximum", "normal", "fast", "fastest", "none"]}, "tarCompression": {"ignoreCase": "all", "enum": ["gz", "bz2", "xz", "none"]}, "archiveFile": {"type": "string", "ignoreCase": "key"}, "replaceExistingArchive": {"type": "boolean", "ignoreCase": "key"}, "verbose": {"type": "boolean", "ignoreCase": "key"}, "quiet": {"type": "boolean", "ignoreCase": "key"}}, "additionalProperties": false, "required": []}
service-schema.json
rootFolderOrFile
Root folder or file to archive
{"type": "string", "ignoreCase": "key"}
service-schema.json
includeRootFolder
Prepend root folder name to archive paths
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
archiveType
Archive type
{"ignoreCase": "all", "enum": ["zip", "7z", "tar", "wim"]}
service-schema.json
sevenZipCompression
7z compression
{"ignoreCase": "all", "enum": ["ultra", "maximum", "normal", "fast", "fastest", "none"]}
service-schema.json
tarCompression
Tar compression
{"ignoreCase": "all", "enum": ["gz", "bz2", "xz", "none"]}
service-schema.json
archiveFile
Archive file to create
{"type": "string", "ignoreCase": "key"}
service-schema.json
replaceExistingArchive
Replace existing archive
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
verbose
Force verbose output
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
quiet
Force quiet output
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
task
GitHub Comment Write a comment to your Github entity i.e. issue or a Pull Request (PR)
{"ignoreCase": "value", "pattern": "^GitHubComment@0$"}
service-schema.json
inputs
GitHub Comment inputs
{"properties": {"gitHubConnection": {"type": "string", "ignoreCase": "key"}, "repositoryName": {"type": "string", "ignoreCase": "key"}, "id": {"type": "string", "ignoreCase": "key"}, "comment": {"type": "string", "ignoreCase": "key"}}, "additionalProperties": false, "required": ["gitHubConnection"]}
service-schema.json
gitHubConnection
GitHub connection (OAuth or PAT)
{"type": "string", "ignoreCase": "key"}
service-schema.json
repositoryName
Repository
{"type": "string", "ignoreCase": "key"}
service-schema.json
id
ID of the github pr/issue
{"type": "string", "ignoreCase": "key"}
service-schema.json
comment
Comment
{"type": "string", "ignoreCase": "key"}
service-schema.json
task
Copy Files Copy files from source folder to target folder using minimatch patterns (The minimatch patterns will only match file paths, not folder paths)
{"ignoreCase": "value", "pattern": "^CopyFiles@1$"}
service-schema.json
inputs
Copy Files inputs
{"properties": {"SourceFolder": {"type": "string", "ignoreCase": "key"}, "Contents": {"type": "string", "ignoreCase": "key"}, "TargetFolder": {"type": "string", "ignoreCase": "key"}, "CleanTargetFolder": {"type": "boolean", "ignoreCase": "key"}, "OverWrite": {"type": "boolean", "ignoreCase": "key"}, "flattenFolders": {"type": "boolean", "ignoreCase": "key"}}, "additionalProperties": false, "required": ["TargetFolder"]}
service-schema.json
SourceFolder
Source Folder
{"type": "string", "ignoreCase": "key"}
service-schema.json
Contents
Contents
{"type": "string", "ignoreCase": "key"}
service-schema.json
TargetFolder
Target Folder
{"type": "string", "ignoreCase": "key"}
service-schema.json
CleanTargetFolder
Clean Target Folder
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
OverWrite
Overwrite
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
flattenFolders
Flatten Folders
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
task
Copy files Copy files from a source folder to a target folder using patterns matching file paths (not folder paths)
{"ignoreCase": "value", "pattern": "^CopyFiles@2$"}
service-schema.json
inputs
Copy files inputs
{"properties": {"SourceFolder": {"type": "string", "ignoreCase": "key"}, "Contents": {"type": "string", "ignoreCase": "key"}, "TargetFolder": {"type": "string", "ignoreCase": "key"}, "CleanTargetFolder": {"type": "boolean", "ignoreCase": "key"}, "OverWrite": {"type": "boolean", "ignoreCase": "key"}, "flattenFolders": {"type": "boolean", "ignoreCase": "key"}, "preserveTimestamp": {"type": "boolean", "ignoreCase": "key"}, "retryCount": {"type": "string", "ignoreCase": "key"}, "delayBetweenRetries": {"type": "string", "ignoreCase": "key"}, "ignoreMakeDirErrors": {"type": "boolean", "ignoreCase": "key"}}, "additionalProperties": false, "required": ["TargetFolder"]}
service-schema.json
SourceFolder
Source Folder
{"type": "string", "ignoreCase": "key"}
service-schema.json
Contents
Contents
{"type": "string", "ignoreCase": "key"}
service-schema.json
TargetFolder
Target Folder
{"type": "string", "ignoreCase": "key"}
service-schema.json
CleanTargetFolder
Clean Target Folder
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
OverWrite
Overwrite
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
flattenFolders
Flatten Folders
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
preserveTimestamp
Preserve Target Timestamp
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
retryCount
Retry count to copy the file
{"type": "string", "ignoreCase": "key"}
service-schema.json
delayBetweenRetries
Delay between two retries.
{"type": "string", "ignoreCase": "key"}
service-schema.json
ignoreMakeDirErrors
Ignore errors during creation of target folder.
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
task
Azure Database for MySQL deployment Run your scripts and make changes to your Azure Database for MySQL
{"ignoreCase": "value", "pattern": "^AzureMysqlDeployment@1$"}
service-schema.json
inputs
Azure Database for MySQL deployment inputs
{"properties": {"azureSubscription": {"type": "string", "ignoreCase": "key", "aliases": ["ConnectedServiceName"]}, "ServerName": {"type": "string", "ignoreCase": "key"}, "DatabaseName": {"type": "string", "ignoreCase": "key"}, "SqlUsername": {"type": "string", "ignoreCase": "key"}, "SqlPassword": {"type": "string", "ignoreCase": "key"}, "TaskNameSelector": {"ignoreCase": "all", "enum": ["SqlTaskFile", "InlineSqlTask"]}, "SqlFile": {"type": "string", "ignoreCase": "key"}, "SqlInline": {"type": "string", "ignoreCase": "key"}, "SqlAdditionalArguments": {"type": "string", "ignoreCase": "key"}, "IpDetectionMethod": {"ignoreCase": "all", "enum": ["AutoDetect", "IPAddressRange"]}, "StartIpAddress": {"type": "string", "ignoreCase": "key"}, "EndIpAddress": {"type": "string", "ignoreCase": "key"}, "DeleteFirewallRule": {"type": "boolean", "ignoreCase": "key"}}, "additionalProperties": false, "required": ["azureSubscription", "ServerName", "SqlUsername", "SqlPassword"]}
service-schema.json
azureSubscription
Azure Subscription
{"type": "string", "ignoreCase": "key", "aliases": ["ConnectedServiceName"]}
service-schema.json
ServerName
Host Name
{"type": "string", "ignoreCase": "key"}
service-schema.json
DatabaseName
Database Name
{"type": "string", "ignoreCase": "key"}
service-schema.json
SqlUsername
Server Admin Login
{"type": "string", "ignoreCase": "key"}
service-schema.json
SqlPassword
Password
{"type": "string", "ignoreCase": "key"}
service-schema.json
TaskNameSelector
Type
{"ignoreCase": "all", "enum": ["SqlTaskFile", "InlineSqlTask"]}
service-schema.json
SqlFile
MySQL Script
{"type": "string", "ignoreCase": "key"}
service-schema.json
SqlInline
Inline MySQL Script
{"type": "string", "ignoreCase": "key"}
service-schema.json
SqlAdditionalArguments
Additional MySQL Arguments
{"type": "string", "ignoreCase": "key"}
service-schema.json
IpDetectionMethod
Specify Firewall Rules Using
{"ignoreCase": "all", "enum": ["AutoDetect", "IPAddressRange"]}
service-schema.json
StartIpAddress
Start IP Address
{"type": "string", "ignoreCase": "key"}
service-schema.json
EndIpAddress
End IP Address
{"type": "string", "ignoreCase": "key"}
service-schema.json
DeleteFirewallRule
Delete Rule After Task Ends
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
task
npm Run an npm command. Use NpmAuthenticate@0 task for latest capabilities.
{"ignoreCase": "value", "pattern": "^Npm@0$"}
service-schema.json
inputs
npm inputs
{"properties": {"cwd": {"type": "string", "ignoreCase": "key"}, "command": {"type": "string", "ignoreCase": "key"}, "arguments": {"type": "string", "ignoreCase": "key"}}, "additionalProperties": false, "required": []}
service-schema.json
cwd
working folder
{"type": "string", "ignoreCase": "key"}
service-schema.json
command
npm command
{"type": "string", "ignoreCase": "key"}
service-schema.json
arguments
arguments
{"type": "string", "ignoreCase": "key"}
service-schema.json
task
npm Install and publish npm packages, or run an npm command. Supports npmjs.com and authenticated registries like Azure Artifacts.
{"ignoreCase": "value", "pattern": "^Npm@1$"}
service-schema.json
inputs
npm inputs
{"properties": {"command": {"ignoreCase": "all", "enum": ["ci", "install", "publish", "custom"]}, "workingDir": {"type": "string", "ignoreCase": "key"}, "verbose": {"type": "boolean", "ignoreCase": "key"}, "customCommand": {"type": "string", "ignoreCase": "key"}, "customRegistry": {"ignoreCase": "all", "enum": ["useNpmrc", "useFeed"]}, "customFeed": {"type": "string", "ignoreCase": "key"}, "customEndpoint": {"type": "string", "ignoreCase": "key"}, "publishRegistry": {"ignoreCase": "all", "enum": ["useExternalRegistry", "useFeed"]}, "publishFeed": {"type": "string", "ignoreCase": "key"}, "publishPackageMetadata": {"type": "boolean", "ignoreCase": "key"}, "publishEndpoint": {"type": "string", "ignoreCase": "key"}}, "additionalProperties": false, "required": []}
service-schema.json
command
Command
{"ignoreCase": "all", "enum": ["ci", "install", "publish", "custom"]}
service-schema.json
workingDir
Working folder that contains package.json
{"type": "string", "ignoreCase": "key"}
service-schema.json
verbose
Verbose logging
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
customCommand
Command and arguments
{"type": "string", "ignoreCase": "key"}
service-schema.json
customRegistry
Registries to use
{"ignoreCase": "all", "enum": ["useNpmrc", "useFeed"]}
service-schema.json
customFeed
Use packages from this Azure Artifacts/TFS registry
{"type": "string", "ignoreCase": "key"}
service-schema.json
customEndpoint
Credentials for registries outside this organization/collection
{"type": "string", "ignoreCase": "key"}
service-schema.json
publishRegistry
Registry location
{"ignoreCase": "all", "enum": ["useExternalRegistry", "useFeed"]}
service-schema.json
publishFeed
Target registry
{"type": "string", "ignoreCase": "key"}
service-schema.json
publishPackageMetadata
Publish pipeline metadata
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
publishEndpoint
External Registry
{"type": "string", "ignoreCase": "key"}
service-schema.json
task
Deploy Azure Static Web App [PREVIEW] Build and deploy an Azure Static Web App
{"ignoreCase": "value", "pattern": "^AzureStaticWebApp@0$"}
service-schema.json
inputs
Deploy Azure Static Web App inputs
{"properties": {"workingDirectory": {"type": "string", "ignoreCase": "key", "aliases": ["cwd", "rootDirectory"]}, "app_location": {"type": "string", "ignoreCase": "key"}, "app_build_command": {"type": "string", "ignoreCase": "key"}, "output_location": {"type": "string", "ignoreCase": "key"}, "api_location": {"type": "string", "ignoreCase": "key"}, "api_build_command": {"type": "string", "ignoreCase": "key"}, "routes_location": {"type": "string", "ignoreCase": "key"}, "config_file_location": {"type": "string", "ignoreCase": "key"}, "skip_app_build": {"type": "boolean", "ignoreCase": "key"}, "skip_api_build": {"type": "boolean", "ignoreCase": "key"}, "is_static_export": {"type": "boolean", "ignoreCase": "key"}, "verbose": {"type": "boolean", "ignoreCase": "key"}, "build_timeout_in_minutes": {"type": "integer", "ignoreCase": "key"}, "azure_static_web_apps_api_token": {"type": "string", "ignoreCase": "key"}, "deployment_environment": {"type": "string", "ignoreCase": "key"}, "production_branch": {"type": "string", "ignoreCase": "key"}, "data_api_location": {"type": "string", "ignoreCase": "key"}}, "additionalProperties": false, "required": []}
service-schema.json
workingDirectory
Working directory
{"type": "string", "ignoreCase": "key", "aliases": ["cwd", "rootDirectory"]}
service-schema.json
app_location
App location
{"type": "string", "ignoreCase": "key"}
service-schema.json
app_build_command
App build command
{"type": "string", "ignoreCase": "key"}
service-schema.json
output_location
Output location
{"type": "string", "ignoreCase": "key"}
service-schema.json
api_location
Api location
{"type": "string", "ignoreCase": "key"}
service-schema.json
api_build_command
Api build command
{"type": "string", "ignoreCase": "key"}
service-schema.json
routes_location
Routes location
{"type": "string", "ignoreCase": "key"}
service-schema.json
config_file_location
Config file location
{"type": "string", "ignoreCase": "key"}
service-schema.json
skip_app_build
Skip app build
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
skip_api_build
Skip api build
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
is_static_export
Set static export
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
verbose
Verbose
{"type": "boolean", "ignoreCase": "key"}
service-schema.json
build_timeout_in_minutes
Build timeout in minutes
{"type": "integer", "ignoreCase": "key"}
service-schema.json
azure_static_web_apps_api_token
Azure Static Web Apps api token
{"type": "string", "ignoreCase": "key"}
service-schema.json
deployment_environment
Deployment Environment
{"type": "string", "ignoreCase": "key"}
service-schema.json
production_branch
Production Branch
{"type": "string", "ignoreCase": "key"}