schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
function.json
cardinality
The cardinality hint for the input binding parameter (single message or array of messages).
{"enum": ["one", "many"]}
function.json
schedule
A cron expression of the format '{second} {minute} {hour} {day} {month} {day of week}' to specify the schedule.
{"type": "string", "pattern": "^(\\*|((([1-5]\\d)|\\d)(-(([1-5]\\d)|\\d)(/\\d+)?)?)(,((([1-5]\\d)|\\d)(-(([1-5]\\d)|\\d)(/\\d+)?)?))*)(/\\d+)? (\\*|((([1-5]\\d)|\\d)(-(([1-5]\\d)|\\d)(/\\d+)?)?)(,((([1-5]\\d)|\\d)(-(([1-5]\\d)|\\d)(/\\d+)?)?))*)(/\\d+)? (\\*|(((1\\d)|(2[0-3])|\\d)(-((1\\d)|(2[0-3])|\\d)(/\\d+)?)?)(,(((1\\d)|(2[0-3])|\\d)(-((1\\d)|(2[0-3])|\\d)(/\\d+)?)?))*)(/\\d+)? (\\*|((([1-2]\\d)|(3[0-1])|[1-9])(-(([1-2]\\d)|(3[0-1])|[1-9])(/\\d+)?)?)(,((([1-2]\\d)|(3[0-1])|[1-9])(-(([1-2]\\d)|(3[0-1])|[1-9])(/\\d+)?)?))*)(/\\d+)? (\\*|(([A-Za-z]+|(1[0-2])|[1-9])(-([A-Za-z]+|(1[0-2])|[1-9])(/\\d+)?)?)(,(([A-Za-z]+|(1[0-2])|[1-9])(-([A-Za-z]+|(1[0-2])|[1-9])(/\\d+)?)?))*)(/\\d+)? (\\*|(([A-Za-z]+|[0-6])(-([A-Za-z]+|[0-6])(/\\d+)?)?)(,(([A-Za-z]+|[0-6])(-([A-Za-z]+|[0-6])(/\\d+)?)?))*)(/\\d+)?$"}
function.json
runOnStartup
When true, your timer function will be invoked immediately after a runtime restart and on-schedule thereafter.
{"type": "boolean"}
function.json
useMonitor
When true, schedule will be persisted to aid in maintaining the correct schedule even through restarts. Defaults to true for schedules with interval >= 1 minute.
{"type": "boolean"}
function.json
queueName
The queue name.
{"type": "string"}
function.json
connection
An app setting (or environment variable) with the storage connection string to be used by this binding.
{"type": "string"}
function.json
route
The function HTTP route template.
{"type": "string"}
function.json
webHookType
The type of WebHook handled by the trigger (if handling a pre-defined WebHook).
{"type": "string"}
function.json
authLevel
The function HTTP authorization level.
{"type": "string", "default": "function", "enum": ["anonymous", "function", "admin"]}
function.json
tableName
This is the name of the table within your Mobile App to which data will be written.
{"type": "string"}
function.json
connection
This is the app setting name that specifies the URL of your Mobile App.
{"type": "string"}
function.json
apiKey
This is app setting name that specifies the API Key for your Mobile App.
{"type": "string"}
function.json
id
This is the id for the record to retrieve.
{"type": "string"}
function.json
connection
This is the connection string for your DocumentDB account.
{"type": "string"}
function.json
databaseName
This is the name of the database within your DocumentDB account to which data will be written.
{"type": "string"}
function.json
collectionName
This is the name of the collection within your database to which data will be written.
{"type": "string"}
function.json
id
This is the id for the record to retrieve.
{"type": "string"}
function.json
sqlQuery
This is the query to run against the collection.
{"type": "string"}
function.json
createIfNotExists
When true, your database and collection will be created automatically.
{"type": "boolean"}
function.json
tableName
The name of the storage table.
{"type": "string"}
function.json
partitionKey
The partition key.
{"type": "string"}
function.json
rowKey
The table row key.
{"type": "string"}
function.json
connection
An app setting (or environment variable) with the storage connection string to be used by this binding.
{"type": "string"}
function.json
take
The number or records to retrieve.
{"type": "string"}
function.json
filter
A filter expression to be applied when retrieving rows.
{"type": "string"}
function.json
tagExpression
The tag to send the notification to.
{"type": "string"}
function.json
hubName
The name of the notification hub.
{"type": "string"}
function.json
connection
The name of the app setting which contains the notification hub connection string.
{"type": "string"}
function.json
platform
The notification platform to target. Sends template notification if platform is omitted.
{"type": "string", "enum": ["apns", "adm", "gcm", "wns", "mpns"]}
function.json
accountSid
The name of the app setting which contains your Twilio Account Sid.
{"type": "string"}
function.json
authToken
The name of the app setting which contains your Twilio authentication token.
{"type": "string"}
function.json
to
The phone number the SMS text is sent to.
{"type": "string"}
function.json
from
The phone number the SMS text is sent from.
{"type": "string"}
function.json
body
Optional body of SMS text message.
{"type": "string"}
function.json
apiKey
The name of the app setting which contains your SendGrid api key.
{"type": "string"}
function.json
to
The email address to send to.
{"type": "string"}
function.json
from
The email address to send from.
{"type": "string"}
function.json
subject
The subject of the email.
{"type": "string"}
function.json
text
The text of the email.
{"type": "string"}
function.json
connectionStringSetting
The name of the app setting that contains the SQL connection string used to connect to the database.
{"type": "string"}
function.json
tableName
The name of the table to be monitored for changes.
{"type": "string"}
function.json
commandText
Either a query string or the name of a stored procedure to execute.
{"type": "string"}
function.json
commandType
Whether the commandText is a query (text) or a stored procedure (storedProcedure).
{"enum": ["text", "storedProcedure"]}
function.json
parameters
The parameters to the query or stored procedure.
{"type": "string"}
function.json
commandText
The name of the table into which rows will be upserted.
{"type": "string"}
function.json
connection
Name of the app setting that contains the kusto connection string used to connect to kusto.
{"type": "string"}
function.json
database
Name of the database within your kusto account to which data will be read/written.
{"type": "string"}
function.json
managedServiceIdentity
A managed service identity that has to be attached to use the bindings.
{"type": "string"}
function.json
kqlCommand
The Kusto command to execute.Can be a KQL query or a KQL function with optional parameters.
{"type": "string"}
function.json
kqlParameters
The parameters to the query or function. Named parameters are of the form @paramName=paramValue.
{"type": "string"}
function.json
tableName
The table to ingest the data into.
{"type": "string"}
function.json
mappingRef
An ingestion mapping ref that points to the mapping created in kusto and referenced in ingestion (optional).
{"type": "string"}
function.json
dataFormat
Dataformat to use in ingestion.The default dataformat is `multijson/json`. This has been tested for text formats
{"type": "string"}
function.json
disabled
If set to true, marks the function as disabled (it cannot be triggered).
{"type": "boolean"}
function.json
excluded
If set to true, the function will not be loaded, compiled, or triggered.
{"type": "boolean"}
function.json
scriptFile
Optional path to function script file.
{"type": "string"}
function.json
entryPoint
Optional named entry point.
{"type": "string"}
function.json
configurationSource
For C# precompiled functions only. If set to 'attributes', use WebJobs attributes to specify bindings. Otherwise, use the 'bindings' property of this function.json.
{"enum": ["attributes", "config"]}
function.json
retry
Retry policy of function execution failures.
{"type": "object", "properties": {"strategy": {"enum": ["exponentialBackoff", "fixedDelay"], "default": "exponentialBackoff"}, "maxRetryCount": {"type": "integer"}, "delayInterval": {"oneOf": [{"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"}, {"enum": [null]}]}, "minimumInterval": {"oneOf": [{"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"}, {"enum": [null]}]}, "maximumInterval": {"oneOf": [{"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"}, {"enum": [null]}]}}}
function.json
strategy
Retry strategy to use for retrying function executions
{"enum": ["exponentialBackoff", "fixedDelay"], "default": "exponentialBackoff"}
function.json
maxRetryCount
The maximum number of retries allowed per function execution. -1 means to retry indefinitely.
{"type": "integer"}
function.json
delayInterval
Value indicating the delayInterval for function execution retries when using FixedDelay strategy.
{"oneOf": [{"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"}, {"enum": [null]}]}
function.json
minimumInterval
Value indicating the minimumInterval for function execution retries when using ExponentialBackoff strategy.
{"oneOf": [{"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"}, {"enum": [null]}]}
function.json
maximumInterval
Value indicating the maximumInterval for function execution retries when using ExponentialBackoff strategy.
{"oneOf": [{"type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"}, {"enum": [null]}]}
function.json
bindings
A list of function bindings.
{"type": "array", "items": {"oneOf": [{}, {"oneOf": [{}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}]}], "allOf": [{}]}}
cluster.json
configFile
ConfigFile is a multiline string that represent a custom webhook config file
{"type": "string"}
cluster.json
cacheTimeout
CacheTimeout controls how long to cache authentication decisions
{"type": "string"}
cluster.json
strategy
Authentication strategy that will be used in kubernetes cluster
{"type": "string"}
cluster.json
sans
List of additional hostnames and IPs to include in the api server PKI cert
{"items": {"type": "string"}, "type": "array"}
cluster.json
webhook
Webhook configuration options
{}
cluster.json
mode
Authorization mode used by kubernetes
{"type": "string"}
cluster.json
options
Authorization mode options
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.json
cloud
The cloud environment identifier. Takes values from https://github.com/Azure/go-autorest/blob/ec5f4903f77ed9927ac95b19ab8e44ada64c1356/autorest/azure/environments.go#L13
{"type": "string"}
cluster.json
tenantId
The AAD Tenant ID for the Subscription that the cluster is deployed in
{"type": "string"}
cluster.json
subscriptionId
The ID of the Azure Subscription that the cluster is deployed in
{"type": "string"}
cluster.json
resourceGroup
The name of the resource group that the cluster is deployed in
{"type": "string"}
cluster.json
location
The location of the resource group that the cluster is deployed in
{"type": "string"}
cluster.json
vnetName
The name of the VNet that the cluster is deployed in
{"type": "string"}
cluster.json
vnetResourceGroup
The name of the resource group that the Vnet is deployed in
{"type": "string"}
cluster.json
subnetName
The name of the subnet that the cluster is deployed in
{"type": "string"}
cluster.json
securityGroupName
The name of the security group attached to the cluster's subnet
{"type": "string"}
cluster.json
routeTableName
(Optional in 1.6) The name of the route table attached to the subnet that the cluster is deployed in
{"type": "string"}
cluster.json
primaryAvailabilitySetName
(Optional) The name of the availability set that should be used as the load balancer backend If this is set, the Azure cloudprovider will only add nodes from that availability set to the load balancer backend pool. If this is not set, and multiple agent pools (availability sets) are used, then the cloudprovider will try to add all nodes to a single backend pool which is forbidden. In other words, if you use multiple agent pools (availability sets), you MUST set this field.
{"type": "string"}
cluster.json
vmType
The type of azure nodes. Candidate valudes are: vmss and standard. If not set, it will be default to standard.
{"type": "string"}
cluster.json
primaryScaleSetName
The name of the scale set that should be used as the load balancer backend. If this is set, the Azure cloudprovider will only add nodes from that scale set to the load balancer backend pool. If this is not set, and multiple agent pools (scale sets) are used, then the cloudprovider will try to add all nodes to a single backend pool which is forbidden. In other words, if you use multiple agent pools (scale sets), you MUST set this field.
{"type": "string"}
cluster.json
aadClientId
The ClientID for an AAD application with RBAC access to talk to Azure RM APIs This's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md
{"type": "string"}
cluster.json
aadClientSecret
The ClientSecret for an AAD application with RBAC access to talk to Azure RM APIs This's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md
{"type": "string"}
cluster.json
aadClientCertPath
The path of a client certificate for an AAD application with RBAC access to talk to Azure RM APIs This's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service
{"type": "string"}
cluster.json
aadClientCertPassword
The password of the client certificate for an AAD application with RBAC access to talk to Azure RM APIs This's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service
{"type": "string"}
cluster.json
cloudProviderBackoff
Enable exponential backoff to manage resource request retries
{"type": "boolean"}
cluster.json
cloudProviderBackoffRetries
Backoff retry limit
{"type": "integer"}
cluster.json
cloudProviderBackoffExponent
Backoff exponent
{"type": "integer"}
cluster.json
cloudProviderBackoffDuration
Backoff duration
{"type": "integer"}
cluster.json
cloudProviderBackoffJitter
Backoff jitter
{"type": "integer"}
cluster.json
cloudProviderRateLimit
Enable rate limiting
{"type": "boolean"}
cluster.json
cloudProviderRateLimitQPS
Rate limit QPS
{"type": "integer"}
cluster.json
cloudProviderRateLimitBucket
Rate limit Bucket Size
{"type": "integer"}
cluster.json
useInstanceMetadata
Use instance metadata service where possible
{"type": "boolean"}
cluster.json
useManagedIdentityExtension
Use managed service identity for the virtual machine to access Azure ARM APIs This's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview For user-assigned managed identity, need to set the below UserAssignedIdentityID
{"type": "boolean"}
cluster.json
userAssignedIdentityID
The Client ID of the user assigned MSI which is assigned to the underlying VMs This's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview
{"type": "string"}