Regenerate expected schemas
This commit is contained in:
Anthony Martin
Родитель
0f9d65ddaf
Коммит
cb023ea4cc
|
|
@ -368,7 +368,7 @@ module.exports =
|
|||
|
||||
autorest: (args,done,ignoreexitcode) ->
|
||||
echo info "Queuing up: AutoRest #{args.join(' ')}"
|
||||
execute "#{basefolder}/node_modules/.bin/autorest \"--use=#{basefolder}\" #{args.map((a) -> "\"#{a}\"").join(' ')}" , { silent:true, ignoreexitcode: ignoreexitcode || false }, (code,stdout,stderr) ->
|
||||
execute "#{basefolder}/node_modules/.bin/autorest-beta \"--use=#{basefolder}\" #{args.map((a) -> "\"#{a}\"").join(' ')}" , { silent:true, ignoreexitcode: ignoreexitcode || false }, (code,stdout,stderr) ->
|
||||
return done(code,stdout,stderr)
|
||||
|
||||
# build task for global build
|
||||
|
|
@ -472,28 +472,28 @@ task 'fix-line-endings', 'Fixes line endings to file-type appropriate values.',
|
|||
.pipe eol {eolc: 'LF', encoding:'utf8'}
|
||||
.pipe destination '.'
|
||||
|
||||
task 'get-tag', '!', (done)->
|
||||
if argv.tag
|
||||
# take the argument if they specified it.
|
||||
global.tag = argv.tag
|
||||
done()
|
||||
else
|
||||
# pick up the tag from the pkg.json version entry
|
||||
global.tag = semver.parse((package_json.version).trim()).prerelease.join(".")
|
||||
if( global.tag )
|
||||
return done()
|
||||
|
||||
# if branch is provided by environment
|
||||
if( env.BUILD_SOURCEBRANCHNAME )
|
||||
global.tag = if ( env.BUILD_SOURCEBRANCHNAME == "master" || env.BUILD_SOURCEBRANCHNAME =="HEAD" ) then "preview" else env.BUILD_SOURCEBRANCHNAME
|
||||
return done();
|
||||
|
||||
# grab the git branch name.
|
||||
execute "git rev-parse --abbrev-ref HEAD" , {silent:true}, (c,o,e)->
|
||||
o = "preview" if( o == undefined || o == null || o == "" || o.trim() == 'master' || o.trim() == 'HEAD')
|
||||
global.tag = o.trim()
|
||||
done();
|
||||
|
||||
task 'get-tag', '!', (done)->
|
||||
if argv.tag
|
||||
# take the argument if they specified it.
|
||||
global.tag = argv.tag
|
||||
done()
|
||||
else
|
||||
# pick up the tag from the pkg.json version entry
|
||||
global.tag = semver.parse((package_json.version).trim()).prerelease.join(".")
|
||||
if( global.tag )
|
||||
return done()
|
||||
|
||||
# if branch is provided by environment
|
||||
if( env.BUILD_SOURCEBRANCHNAME )
|
||||
global.tag = if ( env.BUILD_SOURCEBRANCHNAME == "master" || env.BUILD_SOURCEBRANCHNAME =="HEAD" ) then "preview" else env.BUILD_SOURCEBRANCHNAME
|
||||
return done();
|
||||
|
||||
# grab the git branch name.
|
||||
execute "git rev-parse --abbrev-ref HEAD" , {silent:true}, (c,o,e)->
|
||||
o = "preview" if( o == undefined || o == null || o == "" || o.trim() == 'master' || o.trim() == 'HEAD')
|
||||
global.tag = o.trim()
|
||||
done();
|
||||
|
||||
task 'version-number', '!', (done)->
|
||||
if argv.version
|
||||
global.version = argv.version if argv.version
|
||||
|
|
|
|||
|
|
@ -12,18 +12,17 @@ regenExpected = (opts,done) ->
|
|||
key = kkey.trim();
|
||||
|
||||
args = [
|
||||
"--#{opts.language}.output-folder=#{__dirname}/../#{opts.outputDir}/#{key}",
|
||||
"--title=title"
|
||||
"--#{opts.language}.multi-scope=true",
|
||||
"--output-folder=#{__dirname}/../#{opts.outputDir}/#{key}",
|
||||
"--tag=all-api-versions",
|
||||
"--title=none"
|
||||
]
|
||||
|
||||
if value.file
|
||||
args.push("--input-file=#{value.file}")
|
||||
else
|
||||
args.push("#{opts.inputBaseDir}/#{value.folder}/resource-manager/readme.md")
|
||||
args.push("#{opts.inputBaseDir}/#{value.basePath}/readme.md")
|
||||
|
||||
for tag in value.tags
|
||||
for apiVersion in value.apiVersions
|
||||
args2 = args.slice()
|
||||
args2.push("--tag=#{tag}")
|
||||
args2.push("--api-version=#{apiVersion}")
|
||||
autorest args2,() =>
|
||||
instances--
|
||||
return done() if instances is 0
|
||||
|
|
@ -31,51 +30,27 @@ regenExpected = (opts,done) ->
|
|||
task 'regenerate', '', (done) ->
|
||||
regenExpected {
|
||||
'outputDir': 'test/Resource/Expected',
|
||||
'inputBaseDir': 'https://github.com/Azure/azure-rest-api-specs/blob/ee4507de8c2ba506fb8a7a9decff67691ed4d336/specification',
|
||||
'inputBaseDir': 'https://github.com/Azure/azure-rest-api-specs/blob/f1fdf4a5adfb067c78e4625e293ad4bbc97789c7/specification',
|
||||
'mappings': {
|
||||
# 'Advisor': { folder: 'advisor', tags: [ 'package-2017-04', 'package-2017-03', 'package-2016-07-preview' ] },
|
||||
'AnalysisServices': { folder: 'analysisservices', tags: [ 'package-2017-08-beta', 'package-2017-07', 'package-2016-05' ] },
|
||||
'ApiManagement': { folder: 'apimanagement', tags: [ 'package-2017-03', 'package-2016-10' ] },
|
||||
# 'ApplicationInsights': { folder: 'applicationinsights', tags: [ 'package-2015-05' ] },
|
||||
# 'Authorization': { folder: 'authorization', tags: [ 'package-2015-07', 'package-2017-10-01-preview' ] },
|
||||
'Automation': { folder: 'automation', tags: [ 'package-2015-10', 'package-2017-05-preview' ] },
|
||||
'Batch': { folder: 'batch', tags: [ 'package-2017-09', 'package-2017-05', 'package-2017-01', 'package-2015-12' ] },
|
||||
# 'CDN': { folder: 'cdn', tags: [ 'package-2017-04', 'package-2016-10', 'package-2016-04', 'package-2015-06' ] },
|
||||
# 'CognitiveServices': { folder: 'cognitiveservices', tags: [ 'package-2017-04', 'package-2016-02-preview' ] },
|
||||
'Compute': { folder: 'compute', tags: [ 'package-compute-only-2017-12', 'package-skus-2017-09', 'package-2017-03', 'package-2016-04-preview', 'package-2016-03', 'package-2015-06-preview' ] },
|
||||
# 'Consumption': { folder: 'consumption', tags: [ 'package-2017-11', 'package-2017-04-preview', 'package-2017-12-preview' ] },
|
||||
'ContainerRegistry': { folder: 'containerregistry', tags: [ 'package-2017-10', 'package-2017-06-preview', 'package-2017-03', 'package-2016-06-preview' ] },
|
||||
# 'ContainerService': { folder: 'containerservices', tags: [ 'package-2017-09', 'package-2017-08', 'package-2017-07' ] },
|
||||
'CustomerInsights': { folder: 'customer-insights', tags: [ 'package-2017-04', 'package-2017-01' ] },
|
||||
# 'DataLakeAnalytics': { folder: 'datalake-analytics', tags: [ 'package-2016-11', 'package-2015-10-preview' ] },
|
||||
# 'DataLakeStore': { folder: 'datalake-store', tags: [ 'package-2016-11', 'package-2015-10-preview' ] },
|
||||
'DevTestLabs': { folder: 'devtestlabs', tags: [ 'package-2016-05', 'package-2015-05-preview' ] },
|
||||
# 'DNS': { folder: 'dns', tags: [ 'package-2017-09', 'package-2016-04', 'package-2015-05-preview' ] },
|
||||
# 'DomainServices': { folder: 'domainservices', tags: [ 'package-2017-06', 'package-2017-01' ] },
|
||||
'EventGrid': { folder: 'eventgrid', tags: [ 'package-2018-01', 'package-2017-09-preview', 'package-2017-06-preview' ] },
|
||||
'EventHub': { folder: 'eventhub', tags: [ 'package-2017-04', 'package-2015-08' ] },
|
||||
# 'IotHub': { folder: 'iothub', tags: [ 'package-2017-07', 'package-2017-01', 'package-2016-02' ] },
|
||||
# 'KeyVault': { folder: 'keyvault', tags: [ 'package-2016-10', 'package-2015-06' ] },
|
||||
'Logic': { folder: 'logic', tags: [ 'package-2016-06', 'package-2015-08-preview', 'package-2015-02-preview' ] }, # missing 'type: object'
|
||||
'Monitor': { folder: 'monitor', tags: [ 'package-2017-08', 'package-2017-09' ] }
|
||||
'Network': { folder: 'network', tags: [ 'package-2017-10', 'package-2017-09', 'package-2017-08', 'package-2017-06', 'package-2017-03', 'package-2016-12', 'package-2016-09', 'package-2016-06', 'package-2016-03' ] },
|
||||
# 'NotificationHubs': { folder: 'notificationhubs', tags: [ 'package-2017-04', 'package-2016-03', 'package-2014-09' ] },
|
||||
# 'PowerBIEmbedded': { folder: 'powerbiembedded', tags: [ 'package-2016-01' ] },
|
||||
# 'ProvisioningServices': { folder: 'provisioningservices', tags: [ 'package-2017-08', 'package-2017-11' ] },
|
||||
'RecoveryServices': { folder: 'recoveryservices', tags: [ 'package-2016-12', 'package-2016-06' ] },
|
||||
# 'RecoveryServicesBackup': { folder: 'recoveryservicesbackup', tags: [ 'package-2017-07', 'package-2016-06' ] },
|
||||
# 'Redis': { folder: 'redis', tags: [ 'package-2017-10', 'package-2017-02', 'package-2016-04', 'package-2015-08' ] },
|
||||
'Relay': { folder: 'relay', tags: [ 'package-2017-04', 'package-2016-07' ] },
|
||||
# 'Reservations': { folder: 'reservations', tags: [ 'package-2017-11' ] },
|
||||
# 'Scheduler': { folder: 'scheduler', tags: [ 'package-2016-03', 'package-2016-01', 'package-2014-08-preview' ] },
|
||||
# 'Search': { folder: 'search', tags: [ 'package-2015-08', 'package-2015-02' ] },
|
||||
'ServiceBus': { folder: 'servicebus', tags: [ 'package-2017-04', 'package-2015-08' ] },
|
||||
'ServiceFabric': { folder: 'servicefabric', tags: [ 'package-2017-07', 'package-2016-09' ] }, # missing 'type: object'
|
||||
'Storage': { folder: 'storage', tags: [ 'package-2017-10', 'package-2017-06', 'package-2016-12', 'package-2016-05', 'package-2016-01', 'package-2015-06', 'package-2015-05-preview' ] },
|
||||
# 'TrafficManager': { folder: 'trafficmanager', tags: [ 'package-2017-09-preview', 'package-2017-05', 'package-2017-03', 'package-2015-11' ] },
|
||||
'TimeSeriesInsights': { folder: 'timeseriesinsights', tags: [ 'package-2017-11-15' ] },
|
||||
'Web': { folder: 'web', tags: [ 'package-2016-09' ] }, # missing 'type: object'
|
||||
# 'poly': { file: __dirname + "/../test/Resource/poly-service.json", tags: [ '' ] }
|
||||
'Microsoft.BotService': { basePath: 'botservice/resource-manager', apiVersions: [ '2017-12-01', '2018-07-12' ] },
|
||||
'Microsoft.DataBox': { basePath: 'databox/resource-manager', apiVersions: [ '2018-01-01' ] },
|
||||
'Microsoft.DataBoxEdge': { basePath: 'databoxedge/resource-manager', apiVersions: [ '2019-03-01', '2019-07-01' ] },
|
||||
'Microsoft.Databricks': { basePath: 'databricks/resource-manager', apiVersions: [ '2018-04-01' ] },
|
||||
'Microsoft.DevSpaces': { basePath: 'devspaces/resource-manager', apiVersions: [ '2019-04-01' ] },
|
||||
'Microsoft.DocumentDB': { basePath: 'cosmos-db/resource-manager', apiVersions: [ '2015-04-08', '2019-08-01' ] },
|
||||
'Microsoft.EnterpriseKnowledgeGraph': { basePath: 'EnterpriseKnowledgeGraph/resource-manager', apiVersions: [ '2018-12-03' ] },
|
||||
'Microsoft.EventHub': { basePath: 'eventhub/resource-manager', apiVersions: [ '2014-09-01', '2015-08-01', '2017-04-01', '2018-01-01-preview' ] },
|
||||
'Microsoft.IoTSpaces': { basePath: 'iotspaces/resource-manager', apiVersions: [ '2017-10-01-preview' ] },
|
||||
'Microsoft.LabServices': { basePath: 'labservices/resource-manager', apiVersions: [ '2018-10-15' ] },
|
||||
'Microsoft.MachineLearningCompute': { basePath: 'machinelearningcompute/resource-manager', apiVersions: [ '2017-06-01-preview', '2017-08-01-preview' ] },
|
||||
'Microsoft.Portal': { basePath: 'portal/resource-manager', apiVersions: [ '2015-08-01-preview', '2018-10-01-preview', '2019-01-01-preview' ] },
|
||||
'Microsoft.Relay': { basePath: 'relay/resource-manager', apiVersions: [ '2016-07-01', '2017-04-01' ] },
|
||||
'Microsoft.ServiceBus': { basePath: 'servicebus/resource-manager', apiVersions: [ '2015-08-01', '2017-04-01', '2018-01-01-preview' ] },
|
||||
'Microsoft.ServiceFabric': { basePath: 'servicefabric/resource-manager', apiVersions: [ '2016-09-01', '2017-07-01-preview', '2018-02-01', '2019-03-01', '2019-03-01-preview' ] },
|
||||
'Microsoft.ServiceFabricMesh': { basePath: 'servicefabricmesh/resource-manager', apiVersions: [ '2018-07-01-preview', '2018-09-01-preview' ] },
|
||||
'Microsoft.SqlVirtualMachine': { basePath: 'sqlvirtualmachine/resource-manager', apiVersions: [ '2017-03-01-preview' ] },
|
||||
'Microsoft.StorageSync': { basePath: 'storagesync/resource-manager', apiVersions: [ '2017-06-05-preview', '2018-04-02', '2018-07-01', '2018-10-01', '2019-02-01', '2019-03-01' ] },
|
||||
'Microsoft.WindowsIoT': { basePath: 'windowsiot/resource-manager', apiVersions: [ '2018-02-16-preview', '2019-06-01' ] },
|
||||
},
|
||||
'language': 'azureresourceschema'
|
||||
},done
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@
|
|||
},
|
||||
"homepage": "https://github.com/Azure/autorest.azureresourceschema/blob/master/README.md",
|
||||
"devDependencies": {
|
||||
"autorest": "^2.0.4203",
|
||||
"@autorest/autorest": "^3.0.6113",
|
||||
"coffee-script": "^1.11.1",
|
||||
"dotnet-sdk-2.0.0": "^1.4.4",
|
||||
"gulp": "^3.9.1",
|
||||
|
|
@ -51,4 +51,4 @@
|
|||
"dependencies": {
|
||||
"dotnet-2.0.0": "^1.4.4"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,150 +0,0 @@
|
|||
{
|
||||
"id": "https://schema.management.azure.com/schemas/2016-05-16/Microsoft.AnalysisServices.json#",
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "Microsoft.AnalysisServices",
|
||||
"description": "Microsoft AnalysisServices Resource Types",
|
||||
"resourceDefinitions": {
|
||||
"servers": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.AnalysisServices/servers"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2016-05-16"
|
||||
]
|
||||
},
|
||||
"location": {
|
||||
"type": "string",
|
||||
"description": "Location of the Analysis Services resource."
|
||||
},
|
||||
"sku": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ResourceSku"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The SKU of the Analysis Services resource."
|
||||
},
|
||||
"tags": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"properties": {}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Key-value pairs of additional resource provisioning properties."
|
||||
},
|
||||
"properties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/AnalysisServicesServerProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of the provision operation request."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion",
|
||||
"location",
|
||||
"sku",
|
||||
"properties"
|
||||
],
|
||||
"description": "Microsoft.AnalysisServices/servers"
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"AnalysisServicesServerProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"asAdministrators": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ServerAdministrators"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "A collection of AS server administrators"
|
||||
},
|
||||
"backupBlobContainerUri": {
|
||||
"type": "string",
|
||||
"description": "The container URI of backup blob."
|
||||
}
|
||||
},
|
||||
"description": "Properties of Analysis Services resource."
|
||||
},
|
||||
"ResourceSku": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name of the SKU level."
|
||||
},
|
||||
"tier": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Development",
|
||||
"Basic",
|
||||
"Standard"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The name of the Azure pricing tier to which the SKU applies."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name"
|
||||
],
|
||||
"description": "Represents the SKU name and Azure pricing tier for Analysis Services resource."
|
||||
},
|
||||
"ServerAdministrators": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"members": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "An array of administrator user identities."
|
||||
}
|
||||
},
|
||||
"description": "An array of administrator user identities"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,66 +0,0 @@
|
|||
# Microsoft.AnalysisServices/servers template reference
|
||||
API Version: 2016-05-16
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.AnalysisServices/servers resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.AnalysisServices/servers",
|
||||
"apiVersion": "2016-05-16",
|
||||
"location": "string",
|
||||
"sku": {
|
||||
"name": "string",
|
||||
"tier": "string"
|
||||
},
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"asAdministrators": {
|
||||
"members": [
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"backupBlobContainerUri": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.AnalysisServices/servers" />
|
||||
### Microsoft.AnalysisServices/servers object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.AnalysisServices/servers |
|
||||
| apiVersion | enum | Yes | 2016-05-16 |
|
||||
| location | string | Yes | Location of the Analysis Services resource. |
|
||||
| sku | object | Yes | The SKU of the Analysis Services resource. - [ResourceSku object](#ResourceSku) |
|
||||
| tags | object | No | Key-value pairs of additional resource provisioning properties. |
|
||||
| properties | object | Yes | Properties of the provision operation request. - [AnalysisServicesServerProperties object](#AnalysisServicesServerProperties) |
|
||||
|
||||
|
||||
<a id="ResourceSku" />
|
||||
### ResourceSku object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Name of the SKU level. |
|
||||
| tier | enum | No | The name of the Azure pricing tier to which the SKU applies. - Development, Basic, Standard |
|
||||
|
||||
|
||||
<a id="AnalysisServicesServerProperties" />
|
||||
### AnalysisServicesServerProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| asAdministrators | object | No | A collection of AS server administrators - [ServerAdministrators object](#ServerAdministrators) |
|
||||
| backupBlobContainerUri | string | No | The container URI of backup blob. |
|
||||
|
||||
|
||||
<a id="ServerAdministrators" />
|
||||
### ServerAdministrators object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| members | array | No | An array of administrator user identities. - string |
|
||||
|
||||
|
|
@ -1,171 +0,0 @@
|
|||
{
|
||||
"id": "https://schema.management.azure.com/schemas/2017-07-14/Microsoft.AnalysisServices.json#",
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "Microsoft.AnalysisServices",
|
||||
"description": "Microsoft AnalysisServices Resource Types",
|
||||
"resourceDefinitions": {
|
||||
"servers": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.AnalysisServices/servers"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-07-14"
|
||||
]
|
||||
},
|
||||
"location": {
|
||||
"type": "string",
|
||||
"description": "Location of the Analysis Services resource."
|
||||
},
|
||||
"sku": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ResourceSku"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The SKU of the Analysis Services resource."
|
||||
},
|
||||
"tags": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"properties": {}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Key-value pairs of additional resource provisioning properties."
|
||||
},
|
||||
"properties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/AnalysisServicesServerProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of the provision operation request."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion",
|
||||
"location",
|
||||
"sku",
|
||||
"properties"
|
||||
],
|
||||
"description": "Microsoft.AnalysisServices/servers"
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"AnalysisServicesServerProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"asAdministrators": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ServerAdministrators"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "A collection of AS server administrators"
|
||||
},
|
||||
"backupBlobContainerUri": {
|
||||
"type": "string",
|
||||
"description": "The SAS container URI to the backup container."
|
||||
},
|
||||
"gatewayDetails": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/GatewayDetails"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The gateway details configured for the AS server."
|
||||
}
|
||||
},
|
||||
"description": "Properties of Analysis Services resource."
|
||||
},
|
||||
"GatewayDetails": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"gatewayResourceId": {
|
||||
"type": "string",
|
||||
"description": "Gateway resource to be associated with the server."
|
||||
}
|
||||
},
|
||||
"description": "The gateway details."
|
||||
},
|
||||
"ResourceSku": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name of the SKU level."
|
||||
},
|
||||
"tier": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Development",
|
||||
"Basic",
|
||||
"Standard"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The name of the Azure pricing tier to which the SKU applies."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name"
|
||||
],
|
||||
"description": "Represents the SKU name and Azure pricing tier for Analysis Services resource."
|
||||
},
|
||||
"ServerAdministrators": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"members": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "An array of administrator user identities."
|
||||
}
|
||||
},
|
||||
"description": "An array of administrator user identities"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,77 +0,0 @@
|
|||
# Microsoft.AnalysisServices/servers template reference
|
||||
API Version: 2017-07-14
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.AnalysisServices/servers resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.AnalysisServices/servers",
|
||||
"apiVersion": "2017-07-14",
|
||||
"location": "string",
|
||||
"sku": {
|
||||
"name": "string",
|
||||
"tier": "string"
|
||||
},
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"asAdministrators": {
|
||||
"members": [
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"backupBlobContainerUri": "string",
|
||||
"gatewayDetails": {
|
||||
"gatewayResourceId": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.AnalysisServices/servers" />
|
||||
### Microsoft.AnalysisServices/servers object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.AnalysisServices/servers |
|
||||
| apiVersion | enum | Yes | 2017-07-14 |
|
||||
| location | string | Yes | Location of the Analysis Services resource. |
|
||||
| sku | object | Yes | The SKU of the Analysis Services resource. - [ResourceSku object](#ResourceSku) |
|
||||
| tags | object | No | Key-value pairs of additional resource provisioning properties. |
|
||||
| properties | object | Yes | Properties of the provision operation request. - [AnalysisServicesServerProperties object](#AnalysisServicesServerProperties) |
|
||||
|
||||
|
||||
<a id="ResourceSku" />
|
||||
### ResourceSku object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Name of the SKU level. |
|
||||
| tier | enum | No | The name of the Azure pricing tier to which the SKU applies. - Development, Basic, Standard |
|
||||
|
||||
|
||||
<a id="AnalysisServicesServerProperties" />
|
||||
### AnalysisServicesServerProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| asAdministrators | object | No | A collection of AS server administrators - [ServerAdministrators object](#ServerAdministrators) |
|
||||
| backupBlobContainerUri | string | No | The SAS container URI to the backup container. |
|
||||
| gatewayDetails | object | No | The gateway details configured for the AS server. - [GatewayDetails object](#GatewayDetails) |
|
||||
|
||||
|
||||
<a id="ServerAdministrators" />
|
||||
### ServerAdministrators object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| members | array | No | An array of administrator user identities. - string |
|
||||
|
||||
|
||||
<a id="GatewayDetails" />
|
||||
### GatewayDetails object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| gatewayResourceId | string | No | Gateway resource to be associated with the server. |
|
||||
|
||||
|
|
@ -1,253 +0,0 @@
|
|||
{
|
||||
"id": "https://schema.management.azure.com/schemas/2017-08-01-beta/Microsoft.AnalysisServices.json#",
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "Microsoft.AnalysisServices",
|
||||
"description": "Microsoft AnalysisServices Resource Types",
|
||||
"resourceDefinitions": {
|
||||
"servers": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.AnalysisServices/servers"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-08-01-beta"
|
||||
]
|
||||
},
|
||||
"location": {
|
||||
"type": "string",
|
||||
"description": "Location of the Analysis Services resource."
|
||||
},
|
||||
"sku": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ResourceSku"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The SKU of the Analysis Services resource."
|
||||
},
|
||||
"tags": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"properties": {}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Key-value pairs of additional resource provisioning properties."
|
||||
},
|
||||
"properties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/AnalysisServicesServerProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of the provision operation request."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion",
|
||||
"location",
|
||||
"sku",
|
||||
"properties"
|
||||
],
|
||||
"description": "Microsoft.AnalysisServices/servers"
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"AnalysisServicesServerProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"asAdministrators": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ServerAdministrators"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "A collection of AS server administrators"
|
||||
},
|
||||
"backupBlobContainerUri": {
|
||||
"type": "string",
|
||||
"description": "The SAS container URI to the backup container."
|
||||
},
|
||||
"gatewayDetails": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/GatewayDetails"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The gateway details configured for the AS server."
|
||||
},
|
||||
"ipV4FirewallSettings": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/IPv4FirewallSettings"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The firewall settings for the AS server."
|
||||
},
|
||||
"querypoolConnectionMode": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"All",
|
||||
"ReadOnly"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "How the read-write server's participation in the query pool is controlled.<br/>It can have the following values: <ul><li>readOnly - indicates that the read-write server is intended not to participate in query operations</li><li>all - indicates that the read-write server can participate in query operations</li></ul>Specifying readOnly when capacity is 1 results in error."
|
||||
}
|
||||
},
|
||||
"description": "Properties of Analysis Services resource."
|
||||
},
|
||||
"GatewayDetails": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"gatewayResourceId": {
|
||||
"type": "string",
|
||||
"description": "Gateway resource to be associated with the server."
|
||||
}
|
||||
},
|
||||
"description": "The gateway details."
|
||||
},
|
||||
"IPv4FirewallRule": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"firewallRuleName": {
|
||||
"type": "string",
|
||||
"description": "The rule name."
|
||||
},
|
||||
"rangeStart": {
|
||||
"type": "string",
|
||||
"description": "The start range of IPv4."
|
||||
},
|
||||
"rangeEnd": {
|
||||
"type": "string",
|
||||
"description": "The end range of IPv4."
|
||||
}
|
||||
},
|
||||
"description": "The detail of firewall rule."
|
||||
},
|
||||
"IPv4FirewallSettings": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"firewallRules": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/IPv4FirewallRule"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "An array of firewall rules."
|
||||
},
|
||||
"enablePowerBIService": {
|
||||
"type": "string",
|
||||
"description": "The indicator of enableing PBI service."
|
||||
}
|
||||
},
|
||||
"description": "An array of firewall rules."
|
||||
},
|
||||
"ResourceSku": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name of the SKU level."
|
||||
},
|
||||
"tier": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Development",
|
||||
"Basic",
|
||||
"Standard"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The name of the Azure pricing tier to which the SKU applies."
|
||||
},
|
||||
"capacity": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 8,
|
||||
"default": "1"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The number of instances in the read only query pool."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name"
|
||||
],
|
||||
"description": "Represents the SKU name and Azure pricing tier for Analysis Services resource."
|
||||
},
|
||||
"ServerAdministrators": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"members": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "An array of administrator user identities."
|
||||
}
|
||||
},
|
||||
"description": "An array of administrator user identities."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,109 +0,0 @@
|
|||
# Microsoft.AnalysisServices/servers template reference
|
||||
API Version: 2017-08-01-beta
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.AnalysisServices/servers resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.AnalysisServices/servers",
|
||||
"apiVersion": "2017-08-01-beta",
|
||||
"location": "string",
|
||||
"sku": {
|
||||
"name": "string",
|
||||
"tier": "string",
|
||||
"capacity": "integer"
|
||||
},
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"asAdministrators": {
|
||||
"members": [
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"backupBlobContainerUri": "string",
|
||||
"gatewayDetails": {
|
||||
"gatewayResourceId": "string"
|
||||
},
|
||||
"ipV4FirewallSettings": {
|
||||
"firewallRules": [
|
||||
{
|
||||
"firewallRuleName": "string",
|
||||
"rangeStart": "string",
|
||||
"rangeEnd": "string"
|
||||
}
|
||||
],
|
||||
"enablePowerBIService": "string"
|
||||
},
|
||||
"querypoolConnectionMode": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.AnalysisServices/servers" />
|
||||
### Microsoft.AnalysisServices/servers object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.AnalysisServices/servers |
|
||||
| apiVersion | enum | Yes | 2017-08-01-beta |
|
||||
| location | string | Yes | Location of the Analysis Services resource. |
|
||||
| sku | object | Yes | The SKU of the Analysis Services resource. - [ResourceSku object](#ResourceSku) |
|
||||
| tags | object | No | Key-value pairs of additional resource provisioning properties. |
|
||||
| properties | object | Yes | Properties of the provision operation request. - [AnalysisServicesServerProperties object](#AnalysisServicesServerProperties) |
|
||||
|
||||
|
||||
<a id="ResourceSku" />
|
||||
### ResourceSku object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Name of the SKU level. |
|
||||
| tier | enum | No | The name of the Azure pricing tier to which the SKU applies. - Development, Basic, Standard |
|
||||
| capacity | integer | No | The number of instances in the read only query pool. |
|
||||
|
||||
|
||||
<a id="AnalysisServicesServerProperties" />
|
||||
### AnalysisServicesServerProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| asAdministrators | object | No | A collection of AS server administrators - [ServerAdministrators object](#ServerAdministrators) |
|
||||
| backupBlobContainerUri | string | No | The SAS container URI to the backup container. |
|
||||
| gatewayDetails | object | No | The gateway details configured for the AS server. - [GatewayDetails object](#GatewayDetails) |
|
||||
| ipV4FirewallSettings | object | No | The firewall settings for the AS server. - [IPv4FirewallSettings object](#IPv4FirewallSettings) |
|
||||
| querypoolConnectionMode | enum | No | How the read-write server's participation in the query pool is controlled.<br/>It can have the following values: <ul><li>readOnly - indicates that the read-write server is intended not to participate in query operations</li><li>all - indicates that the read-write server can participate in query operations</li></ul>Specifying readOnly when capacity is 1 results in error. - All or ReadOnly |
|
||||
|
||||
|
||||
<a id="ServerAdministrators" />
|
||||
### ServerAdministrators object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| members | array | No | An array of administrator user identities. - string |
|
||||
|
||||
|
||||
<a id="GatewayDetails" />
|
||||
### GatewayDetails object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| gatewayResourceId | string | No | Gateway resource to be associated with the server. |
|
||||
|
||||
|
||||
<a id="IPv4FirewallSettings" />
|
||||
### IPv4FirewallSettings object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| firewallRules | array | No | An array of firewall rules. - [IPv4FirewallRule object](#IPv4FirewallRule) |
|
||||
| enablePowerBIService | string | No | The indicator of enableing PBI service. |
|
||||
|
||||
|
||||
<a id="IPv4FirewallRule" />
|
||||
### IPv4FirewallRule object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| firewallRuleName | string | No | The rule name. |
|
||||
| rangeStart | string | No | The start range of IPv4. |
|
||||
| rangeEnd | string | No | The end range of IPv4. |
|
||||
|
||||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -1,128 +0,0 @@
|
|||
# Microsoft.ApiManagement/service template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service",
|
||||
"apiVersion": "2016-10-10",
|
||||
"location": "string",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"publisherEmail": "string",
|
||||
"publisherName": "string",
|
||||
"addresserEmail": "string",
|
||||
"hostnameConfigurations": [
|
||||
{
|
||||
"type": "string",
|
||||
"hostname": "string",
|
||||
"certificate": {
|
||||
"expiry": "string",
|
||||
"thumbprint": "string",
|
||||
"subject": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"vpnconfiguration": {
|
||||
"subnetResourceId": "string",
|
||||
"location": "string"
|
||||
},
|
||||
"additionalLocations": [
|
||||
{
|
||||
"location": "string",
|
||||
"skuType": "string",
|
||||
"skuUnitCount": "integer",
|
||||
"vpnconfiguration": {
|
||||
"subnetResourceId": "string",
|
||||
"location": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"customProperties": {},
|
||||
"vpnType": "string"
|
||||
},
|
||||
"sku": {
|
||||
"name": "string",
|
||||
"capacity": "integer"
|
||||
},
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service" />
|
||||
### Microsoft.ApiManagement/service object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | The name of the API Management service. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| location | string | Yes | Resource location. |
|
||||
| tags | object | No | Resource tags. |
|
||||
| properties | object | Yes | Properties of the API Management service. - [ApiManagementServiceProperties object](#ApiManagementServiceProperties) |
|
||||
| sku | object | Yes | SKU properties of the API Management service. - [ApiManagementServiceSkuProperties object](#ApiManagementServiceSkuProperties) |
|
||||
| resources | array | No | [users](./service/users.md) [subscriptions](./service/subscriptions.md) [properties](./service/properties.md) [products](./service/products.md) [openidConnectProviders](./service/openidConnectProviders.md) [loggers](./service/loggers.md) [identityProviders](./service/identityProviders.md) [groups](./service/groups.md) [certificates](./service/certificates.md) [backends](./service/backends.md) [authorizationServers](./service/authorizationServers.md) [apis](./service/apis.md) |
|
||||
|
||||
|
||||
<a id="ApiManagementServiceProperties" />
|
||||
### ApiManagementServiceProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| publisherEmail | string | Yes | Publisher email. |
|
||||
| publisherName | string | Yes | Publisher name. |
|
||||
| addresserEmail | string | No | Addresser email. |
|
||||
| hostnameConfigurations | array | No | Custom hostname configuration of the API Management service. - [HostnameConfiguration object](#HostnameConfiguration) |
|
||||
| vpnconfiguration | object | No | Virtual network configuration of the API Management service. - [VirtualNetworkConfiguration object](#VirtualNetworkConfiguration) |
|
||||
| additionalLocations | array | No | Additional datacenter locations of the API Management service. - [AdditionalRegion object](#AdditionalRegion) |
|
||||
| customProperties | object | No | Custom properties of the API Management service, like disabling TLS 1.0. |
|
||||
| vpnType | enum | No | The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. - None, External, Internal |
|
||||
|
||||
|
||||
<a id="ApiManagementServiceSkuProperties" />
|
||||
### ApiManagementServiceSkuProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | enum | Yes | Name of the Sku. - Developer, Standard, Premium |
|
||||
| capacity | integer | No | Capacity of the SKU (number of deployed units of the SKU). The default value is 1. |
|
||||
|
||||
|
||||
<a id="HostnameConfiguration" />
|
||||
### HostnameConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| type | enum | Yes | Hostname type. - Proxy, Portal, Management, Scm |
|
||||
| hostname | string | Yes | Hostname. |
|
||||
| certificate | object | Yes | Certificate information. - [CertificateInformation object](#CertificateInformation) |
|
||||
|
||||
|
||||
<a id="VirtualNetworkConfiguration" />
|
||||
### VirtualNetworkConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| subnetResourceId | string | No | The full resource ID of a subnet in a virtual network to deploy the API Management service in. |
|
||||
| location | string | No | The location of the virtual network. |
|
||||
|
||||
|
||||
<a id="AdditionalRegion" />
|
||||
### AdditionalRegion object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| location | string | Yes | The location name of the additional region among Azure Data center regions. |
|
||||
| skuType | enum | Yes | The SKU type in the location. - Developer, Standard, Premium |
|
||||
| skuUnitCount | integer | No | The SKU Unit count at the location. The maximum SKU Unit count depends on the SkuType. Maximum allowed for Developer SKU is 1, for Standard SKU is 4, and for Premium SKU is 10, at a location. |
|
||||
| vpnconfiguration | object | No | Virtual network configuration for the location. - [VirtualNetworkConfiguration object](#VirtualNetworkConfiguration) |
|
||||
|
||||
|
||||
<a id="CertificateInformation" />
|
||||
### CertificateInformation object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| expiry | string | Yes | Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. |
|
||||
| thumbprint | string | Yes | Thumbprint of the certificate. |
|
||||
| subject | string | Yes | Subject of the certificate. |
|
||||
|
||||
|
|
@ -1,72 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/apis template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/apis resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/apis",
|
||||
"apiVersion": "2016-10-10",
|
||||
"description": "string",
|
||||
"authenticationSettings": {
|
||||
"oAuth2": {
|
||||
"authorizationServerId": "string",
|
||||
"scope": "string"
|
||||
}
|
||||
},
|
||||
"subscriptionKeyParameterNames": {
|
||||
"header": "string",
|
||||
"query": "string"
|
||||
},
|
||||
"serviceUrl": "string",
|
||||
"path": "string",
|
||||
"protocols": [
|
||||
"string"
|
||||
],
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/apis" />
|
||||
### Microsoft.ApiManagement/service/apis object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | API identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/apis |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| description | string | No | Description of the API. May include HTML formatting tags. |
|
||||
| authenticationSettings | object | No | Collection of authentication settings included into this API. - [AuthenticationSettingsContract object](#AuthenticationSettingsContract) |
|
||||
| subscriptionKeyParameterNames | object | No | Protocols over which API is made available. - [SubscriptionKeyParameterNamesContract object](#SubscriptionKeyParameterNamesContract) |
|
||||
| serviceUrl | string | Yes | Absolute URL of the backend service implementing this API. |
|
||||
| path | string | Yes | Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. |
|
||||
| protocols | array | Yes | Describes on which protocols the operations in this API can be invoked. - Http or Https |
|
||||
| resources | array | No | [operations](./apis/operations.md) |
|
||||
|
||||
|
||||
<a id="AuthenticationSettingsContract" />
|
||||
### AuthenticationSettingsContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| oAuth2 | object | No | [OAuth2AuthenticationSettingsContract object](#OAuth2AuthenticationSettingsContract) |
|
||||
|
||||
|
||||
<a id="SubscriptionKeyParameterNamesContract" />
|
||||
### SubscriptionKeyParameterNamesContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| header | string | No | Subscription key header name. |
|
||||
| query | string | No | Subscription key query string parameter name. |
|
||||
|
||||
|
||||
<a id="OAuth2AuthenticationSettingsContract" />
|
||||
### OAuth2AuthenticationSettingsContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| authorizationServerId | string | No | OAuth authorization server identifier. |
|
||||
| scope | string | No | operations scope. |
|
||||
|
||||
|
|
@ -1,130 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/apis/operations template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/apis/operations resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/apis/operations",
|
||||
"apiVersion": "2016-10-10",
|
||||
"templateParameters": [
|
||||
{
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"type": "string",
|
||||
"defaultValue": "string",
|
||||
"required": "boolean",
|
||||
"values": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
],
|
||||
"description": "string",
|
||||
"request": {
|
||||
"description": "string",
|
||||
"queryParameters": [
|
||||
{
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"type": "string",
|
||||
"defaultValue": "string",
|
||||
"required": "boolean",
|
||||
"values": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
],
|
||||
"headers": [
|
||||
{
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"type": "string",
|
||||
"defaultValue": "string",
|
||||
"required": "boolean",
|
||||
"values": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
],
|
||||
"representations": [
|
||||
{
|
||||
"contentType": "string",
|
||||
"sample": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"responses": [
|
||||
{
|
||||
"statusCode": "integer",
|
||||
"description": "string",
|
||||
"representations": [
|
||||
{
|
||||
"contentType": "string",
|
||||
"sample": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"method": "string",
|
||||
"urlTemplate": "string"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/apis/operations" />
|
||||
### Microsoft.ApiManagement/service/apis/operations object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Operation identifier within an API. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/apis/operations |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| templateParameters | array | No | Collection of URL template parameters. - [ParameterContract object](#ParameterContract) |
|
||||
| description | string | No | Description of the operation. May include HTML formatting tags. |
|
||||
| request | object | No | An entity containing request details. - [RequestContract object](#RequestContract) |
|
||||
| responses | array | No | Array of Operation responses. - [ResultContract object](#ResultContract) |
|
||||
| method | string | Yes | A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. |
|
||||
| urlTemplate | string | Yes | Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} |
|
||||
|
||||
|
||||
<a id="ParameterContract" />
|
||||
### ParameterContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Parameter name. |
|
||||
| description | string | No | Parameter description. |
|
||||
| type | string | Yes | Parameter type. |
|
||||
| defaultValue | string | No | Default parameter value. |
|
||||
| required | boolean | No | whether parameter is required or not. |
|
||||
| values | array | No | Parameter values. - string |
|
||||
|
||||
|
||||
<a id="RequestContract" />
|
||||
### RequestContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| description | string | No | Operation request description. |
|
||||
| queryParameters | array | No | Collection of operation request query parameters. - [ParameterContract object](#ParameterContract) |
|
||||
| headers | array | No | Collection of operation request headers. - [ParameterContract object](#ParameterContract) |
|
||||
| representations | array | No | Collection of operation request representations. - [RepresentationContract object](#RepresentationContract) |
|
||||
|
||||
|
||||
<a id="ResultContract" />
|
||||
### ResultContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| statusCode | integer | Yes | Operation response HTTP status code. |
|
||||
| description | string | No | Operation response description. |
|
||||
| representations | array | No | Collection of operation response representations. - [RepresentationContract object](#RepresentationContract) |
|
||||
|
||||
|
||||
<a id="RepresentationContract" />
|
||||
### RepresentationContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| contentType | string | Yes | Specifies a registered or custom content type for this representation, e.g. application/xml. |
|
||||
| sample | string | No | An example of the representation. |
|
||||
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/authorizationServers template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/authorizationServers resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/authorizationServers",
|
||||
"apiVersion": "2016-10-10",
|
||||
"description": "string",
|
||||
"clientRegistrationEndpoint": "string",
|
||||
"authorizationEndpoint": "string",
|
||||
"authorizationMethods": [
|
||||
"string"
|
||||
],
|
||||
"clientAuthenticationMethod": [
|
||||
"string"
|
||||
],
|
||||
"tokenBodyParameters": [
|
||||
{
|
||||
"name": "string",
|
||||
"value": "string"
|
||||
}
|
||||
],
|
||||
"tokenEndpoint": "string",
|
||||
"supportState": "boolean",
|
||||
"defaultScope": "string",
|
||||
"grantTypes": [
|
||||
"string"
|
||||
],
|
||||
"bearerTokenSendingMethods": [
|
||||
"string"
|
||||
],
|
||||
"clientId": "string",
|
||||
"clientSecret": "string",
|
||||
"resourceOwnerUsername": "string",
|
||||
"resourceOwnerPassword": "string"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/authorizationServers" />
|
||||
### Microsoft.ApiManagement/service/authorizationServers object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Identifier of the authorization server. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/authorizationServers |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| description | string | No | Description of the authorization server. Can contain HTML formatting tags. |
|
||||
| clientRegistrationEndpoint | string | Yes | Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced. |
|
||||
| authorizationEndpoint | string | Yes | OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. |
|
||||
| authorizationMethods | array | No | HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. - HEAD, OPTIONS, TRACE, GET, POST, PUT, PATCH, DELETE |
|
||||
| clientAuthenticationMethod | array | No | Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. - Basic or Body |
|
||||
| tokenBodyParameters | array | No | Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}. - [TokenBodyParameterContract object](#TokenBodyParameterContract) |
|
||||
| tokenEndpoint | string | No | OAuth token endpoint. Contains absolute URI to entity being referenced. |
|
||||
| supportState | boolean | No | If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. |
|
||||
| defaultScope | string | No | Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. |
|
||||
| grantTypes | array | Yes | Form of an authorization grant, which the client uses to request the access token. - authorizationCode, implicit, resourceOwnerPassword, clientCredentials |
|
||||
| bearerTokenSendingMethods | array | No | Specifies the mechanism by which access token is passed to the API. - authorizationHeader or query |
|
||||
| clientId | string | Yes | Client or app id registered with this authorization server. |
|
||||
| clientSecret | string | No | Client or app secret registered with this authorization server. |
|
||||
| resourceOwnerUsername | string | No | Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. |
|
||||
| resourceOwnerPassword | string | No | Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. |
|
||||
|
||||
|
||||
<a id="TokenBodyParameterContract" />
|
||||
### TokenBodyParameterContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | body parameter name. |
|
||||
| value | string | Yes | body parameter value. |
|
||||
|
||||
|
|
@ -1,60 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/backends template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/backends resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/backends",
|
||||
"apiVersion": "2016-10-10",
|
||||
"certificate": [
|
||||
"string"
|
||||
],
|
||||
"query": {},
|
||||
"header": {},
|
||||
"url": "string",
|
||||
"username": "string",
|
||||
"password": "string",
|
||||
"title": "string",
|
||||
"description": "string",
|
||||
"resourceId": "string",
|
||||
"properties": {
|
||||
"skipCertificateChainValidation": "boolean",
|
||||
"skipCertificateNameValidation": "boolean"
|
||||
},
|
||||
"protocol": "string"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/backends" />
|
||||
### Microsoft.ApiManagement/service/backends object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Identifier of the Backend entity. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/backends |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| certificate | array | No | List of Client Certificate Thumbprint. - string |
|
||||
| query | object | No | Query Parameter description. |
|
||||
| header | object | No | Header Parameter description. |
|
||||
| url | string | Yes | WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. |
|
||||
| username | string | No | Username to connect to the WebProxy server |
|
||||
| password | string | No | Password to connect to the WebProxy Server |
|
||||
| title | string | No | Backend Title. |
|
||||
| description | string | No | Backend Description. |
|
||||
| resourceId | string | No | Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps. |
|
||||
| properties | object | Yes | [BackendProperties object](#BackendProperties) |
|
||||
| protocol | enum | Yes | Backend communication protocol. - http or soap |
|
||||
|
||||
|
||||
<a id="BackendProperties" />
|
||||
### BackendProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| skipCertificateChainValidation | boolean | No | Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host. |
|
||||
| skipCertificateNameValidation | boolean | No | Flag indicating whether SSL certificate name validation should be skipped when using self-signed certificates for this backend host. |
|
||||
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/certificates template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/certificates resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/certificates",
|
||||
"apiVersion": "2016-10-10",
|
||||
"data": "string",
|
||||
"password": "string"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/certificates" />
|
||||
### Microsoft.ApiManagement/service/certificates object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Identifier of the certificate entity. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/certificates |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| data | string | Yes | Base 64 encoded certificate using the application/x-pkcs12 representation. |
|
||||
| password | string | Yes | Password for the Certificate |
|
||||
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/groups template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/groups resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/groups",
|
||||
"apiVersion": "2016-10-10",
|
||||
"description": "string",
|
||||
"externalId": "string",
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/groups" />
|
||||
### Microsoft.ApiManagement/service/groups object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/groups |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| description | string | No | Group description. |
|
||||
| externalId | string | No | Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null. |
|
||||
| resources | array | No | [users](./groups/users.md) |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/groups/users template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/groups/users resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/groups/users",
|
||||
"apiVersion": "2016-10-10"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/groups/users" />
|
||||
### Microsoft.ApiManagement/service/groups/users object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | User identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/groups/users |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/identityProviders template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/identityProviders resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/identityProviders",
|
||||
"apiVersion": "2016-10-10",
|
||||
"clientId": "string",
|
||||
"clientSecret": "string",
|
||||
"allowedTenants": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/identityProviders" />
|
||||
### Microsoft.ApiManagement/service/identityProviders object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | enum | Yes | Identity Provider Type identifier. - facebook, google, microsoft, twitter, aad, aadB2C |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/identityProviders |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| clientId | string | Yes | Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. |
|
||||
| clientSecret | string | Yes | Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. |
|
||||
| allowedTenants | array | No | List of Allowed Tenants when configuring Azure Active Directory login. - string |
|
||||
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/loggers template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/loggers resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/loggers",
|
||||
"apiVersion": "2016-10-10",
|
||||
"description": "string",
|
||||
"credentials": {},
|
||||
"isBuffered": "boolean"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/loggers" />
|
||||
### Microsoft.ApiManagement/service/loggers object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Logger identifier. Must be unique in the API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/loggers |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| description | string | No | Logger description. |
|
||||
| credentials | object | Yes | The name and SendRule connection string of the event hub. |
|
||||
| isBuffered | boolean | No | Whether records are buffered in the logger before publishing. Default is assumed to be true. |
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/openidConnectProviders template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/openidConnectProviders resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/openidConnectProviders",
|
||||
"apiVersion": "2016-10-10",
|
||||
"description": "string",
|
||||
"metadataEndpoint": "string",
|
||||
"clientId": "string",
|
||||
"clientSecret": "string"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/openidConnectProviders" />
|
||||
### Microsoft.ApiManagement/service/openidConnectProviders object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Identifier of the OpenID Connect Provider. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/openidConnectProviders |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| description | string | No | User-friendly description of OpenID Connect Provider. |
|
||||
| metadataEndpoint | string | Yes | Metadata endpoint URI. |
|
||||
| clientId | string | Yes | Client ID of developer console which is the client application. |
|
||||
| clientSecret | string | No | Client Secret of developer console which is the client application. |
|
||||
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/products template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/products resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/products",
|
||||
"apiVersion": "2016-10-10",
|
||||
"description": "string",
|
||||
"terms": "string",
|
||||
"subscriptionRequired": "boolean",
|
||||
"approvalRequired": "boolean",
|
||||
"subscriptionsLimit": "integer",
|
||||
"state": "string",
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/products" />
|
||||
### Microsoft.ApiManagement/service/products object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Product identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/products |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| description | string | No | Product description. May include HTML formatting tags. |
|
||||
| terms | string | No | Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. |
|
||||
| subscriptionRequired | boolean | No | Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. |
|
||||
| approvalRequired | boolean | No | whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false. |
|
||||
| subscriptionsLimit | integer | No | Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false. |
|
||||
| state | enum | No | whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished. - NotPublished or Published |
|
||||
| resources | array | No | [groups](./products/groups.md) [apis](./products/apis.md) |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/products/apis template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/products/apis resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/products/apis",
|
||||
"apiVersion": "2016-10-10"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/products/apis" />
|
||||
### Microsoft.ApiManagement/service/products/apis object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | API identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/products/apis |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/products/groups template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/products/groups resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/products/groups",
|
||||
"apiVersion": "2016-10-10"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/products/groups" />
|
||||
### Microsoft.ApiManagement/service/products/groups object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/products/groups |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/properties template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/properties resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/properties",
|
||||
"apiVersion": "2016-10-10",
|
||||
"value": "string",
|
||||
"tags": [
|
||||
"string"
|
||||
],
|
||||
"secret": "boolean"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/properties" />
|
||||
### Microsoft.ApiManagement/service/properties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Identifier of the property. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/properties |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| value | string | Yes | Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. |
|
||||
| tags | array | No | Optional tags that when provided can be used to filter the property list. - string |
|
||||
| secret | boolean | No | Determines whether the value is a secret and should be encrypted or not. Default value is false. |
|
||||
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/subscriptions template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/subscriptions resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/subscriptions",
|
||||
"apiVersion": "2016-10-10",
|
||||
"userId": "string",
|
||||
"productId": "string",
|
||||
"primaryKey": "string",
|
||||
"secondaryKey": "string",
|
||||
"state": "string"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/subscriptions" />
|
||||
### Microsoft.ApiManagement/service/subscriptions object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Subscription entity Identifier. The entity represents the association between a user and a product in API Management. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/subscriptions |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| userId | string | Yes | User (user id path) for whom subscription is being created in form /users/{uid} |
|
||||
| productId | string | Yes | Product (product id path) for which subscription is being created in form /products/{productid} |
|
||||
| primaryKey | string | No | Primary subscription key. If not specified during request key will be generated automatically. |
|
||||
| secondaryKey | string | No | Secondary subscription key. If not specified during request key will be generated automatically. |
|
||||
| state | enum | No | Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. - Suspended, Active, Expired, Submitted, Rejected, Cancelled |
|
||||
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/users template reference
|
||||
API Version: 2016-10-10
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/users resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/users",
|
||||
"apiVersion": "2016-10-10",
|
||||
"email": "string",
|
||||
"password": "string",
|
||||
"firstName": "string",
|
||||
"lastName": "string",
|
||||
"state": "string",
|
||||
"note": "string"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/users" />
|
||||
### Microsoft.ApiManagement/service/users object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | User identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/users |
|
||||
| apiVersion | enum | Yes | 2016-10-10 |
|
||||
| email | string | Yes | Email address. Must not be empty and must be unique within the service instance. |
|
||||
| password | string | Yes | User Password. |
|
||||
| firstName | string | Yes | First name. |
|
||||
| lastName | string | Yes | Last name. |
|
||||
| state | enum | No | Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. - Active or Blocked |
|
||||
| note | string | No | Optional note about a user set by the administrator. |
|
||||
|
||||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -1,149 +0,0 @@
|
|||
# Microsoft.ApiManagement/service template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service",
|
||||
"apiVersion": "2017-03-01",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"notificationSenderEmail": "string",
|
||||
"hostnameConfigurations": [
|
||||
{
|
||||
"type": "string",
|
||||
"hostName": "string",
|
||||
"keyVaultId": "string",
|
||||
"encodedCertificate": "string",
|
||||
"certificatePassword": "string",
|
||||
"defaultSslBinding": "boolean",
|
||||
"negotiateClientCertificate": "boolean"
|
||||
}
|
||||
],
|
||||
"virtualNetworkConfiguration": {
|
||||
"subnetResourceId": "string"
|
||||
},
|
||||
"additionalLocations": [
|
||||
{
|
||||
"location": "string",
|
||||
"sku": {
|
||||
"name": "string",
|
||||
"capacity": "integer"
|
||||
},
|
||||
"virtualNetworkConfiguration": {
|
||||
"subnetResourceId": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"customProperties": {},
|
||||
"certificates": [
|
||||
{
|
||||
"encodedCertificate": "string",
|
||||
"certificatePassword": "string",
|
||||
"storeName": "string"
|
||||
}
|
||||
],
|
||||
"virtualNetworkType": "string",
|
||||
"publisherEmail": "string",
|
||||
"publisherName": "string"
|
||||
},
|
||||
"sku": {
|
||||
"name": "string",
|
||||
"capacity": "integer"
|
||||
},
|
||||
"identity": {
|
||||
"type": "SystemAssigned"
|
||||
},
|
||||
"location": "string",
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service" />
|
||||
### Microsoft.ApiManagement/service object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | The name of the API Management service. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| tags | object | No | Resource tags. |
|
||||
| properties | object | Yes | Properties of the API Management service. - [ApiManagementServiceProperties object](#ApiManagementServiceProperties) |
|
||||
| sku | object | Yes | SKU properties of the API Management service. - [ApiManagementServiceSkuProperties object](#ApiManagementServiceSkuProperties) |
|
||||
| identity | object | No | Managed service identity of the Api Management service. - [ApiManagementServiceIdentity object](#ApiManagementServiceIdentity) |
|
||||
| location | string | Yes | Resource location. |
|
||||
| resources | array | No | [users](./service/users.md) [subscriptions](./service/subscriptions.md) [properties](./service/properties.md) [products](./service/products.md) [openidConnectProviders](./service/openidConnectProviders.md) [notifications](./service/notifications.md) [loggers](./service/loggers.md) [identityProviders](./service/identityProviders.md) [groups](./service/groups.md) [templates](./service/templates.md) [certificates](./service/certificates.md) [backends](./service/backends.md) [authorizationServers](./service/authorizationServers.md) [apis](./service/apis.md) [policies](./service/policies.md) |
|
||||
|
||||
|
||||
<a id="ApiManagementServiceProperties" />
|
||||
### ApiManagementServiceProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| notificationSenderEmail | string | No | Email address from which the notification will be sent. |
|
||||
| hostnameConfigurations | array | No | Custom hostname configuration of the API Management service. - [HostnameConfiguration object](#HostnameConfiguration) |
|
||||
| virtualNetworkConfiguration | object | No | Virtual network configuration of the API Management service. - [VirtualNetworkConfiguration object](#VirtualNetworkConfiguration) |
|
||||
| additionalLocations | array | No | Additional datacenter locations of the API Management service. - [AdditionalLocation object](#AdditionalLocation) |
|
||||
| customProperties | object | No | Custom properties of the API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1 and setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service. |
|
||||
| certificates | array | No | List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. - [CertificateConfiguration object](#CertificateConfiguration) |
|
||||
| virtualNetworkType | enum | No | The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. - None, External, Internal |
|
||||
| publisherEmail | string | Yes | Publisher email. |
|
||||
| publisherName | string | Yes | Publisher name. |
|
||||
|
||||
|
||||
<a id="ApiManagementServiceSkuProperties" />
|
||||
### ApiManagementServiceSkuProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | enum | Yes | Name of the Sku. - Developer, Standard, Premium, Basic |
|
||||
| capacity | integer | No | Capacity of the SKU (number of deployed units of the SKU). The default value is 1. |
|
||||
|
||||
|
||||
<a id="ApiManagementServiceIdentity" />
|
||||
### ApiManagementServiceIdentity object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| type | enum | Yes | The identity type. Currently the only supported type is 'SystemAssigned'. - SystemAssigned |
|
||||
|
||||
|
||||
<a id="HostnameConfiguration" />
|
||||
### HostnameConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| type | enum | Yes | Hostname type. - Proxy, Portal, Management, Scm |
|
||||
| hostName | string | Yes | Hostname to configure on the Api Management service. |
|
||||
| keyVaultId | string | No | Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type *application/x-pkcs12* |
|
||||
| encodedCertificate | string | No | Base64 Encoded certificate. |
|
||||
| certificatePassword | string | No | Certificate Password. |
|
||||
| defaultSslBinding | boolean | No | Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type. |
|
||||
| negotiateClientCertificate | boolean | No | Specify true to always negotiate client certificate on the hostname. Default Value is false. |
|
||||
|
||||
|
||||
<a id="VirtualNetworkConfiguration" />
|
||||
### VirtualNetworkConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| subnetResourceId | string | No | The full resource ID of a subnet in a virtual network to deploy the API Management service in. |
|
||||
|
||||
|
||||
<a id="AdditionalLocation" />
|
||||
### AdditionalLocation object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| location | string | Yes | The location name of the additional region among Azure Data center regions. |
|
||||
| sku | object | Yes | SKU properties of the API Management service. - [ApiManagementServiceSkuProperties object](#ApiManagementServiceSkuProperties) |
|
||||
| virtualNetworkConfiguration | object | No | Virtual network configuration for the location. - [VirtualNetworkConfiguration object](#VirtualNetworkConfiguration) |
|
||||
|
||||
|
||||
<a id="CertificateConfiguration" />
|
||||
### CertificateConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| encodedCertificate | string | No | Base64 Encoded certificate. |
|
||||
| certificatePassword | string | No | Certificate Password. |
|
||||
| storeName | enum | Yes | The local certificate store location. Only Root and CertificateAuthority are valid locations. - CertificateAuthority or Root |
|
||||
|
||||
|
|
@ -1,108 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/apis template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/apis resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/apis",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"description": "string",
|
||||
"authenticationSettings": {
|
||||
"oAuth2": {
|
||||
"authorizationServerId": "string",
|
||||
"scope": "string"
|
||||
}
|
||||
},
|
||||
"subscriptionKeyParameterNames": {
|
||||
"header": "string",
|
||||
"query": "string"
|
||||
},
|
||||
"type": "string",
|
||||
"apiRevision": "string",
|
||||
"isCurrent": "boolean",
|
||||
"isOnline": "boolean",
|
||||
"displayName": "string",
|
||||
"serviceUrl": "string",
|
||||
"path": "string",
|
||||
"protocols": [
|
||||
"string"
|
||||
],
|
||||
"contentValue": "string",
|
||||
"contentFormat": "string",
|
||||
"wsdlSelector": {
|
||||
"wsdlServiceName": "string",
|
||||
"wsdlEndpointName": "string"
|
||||
}
|
||||
},
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/apis" />
|
||||
### Microsoft.ApiManagement/service/apis object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | API identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/apis |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Api entity create of update properties. - [ApiCreateOrUpdateProperties object](#ApiCreateOrUpdateProperties) |
|
||||
| resources | array | No | [schemas](./apis/schemas.md) [policies](./apis/policies.md) [operations](./apis/operations.md) |
|
||||
|
||||
|
||||
<a id="ApiCreateOrUpdateProperties" />
|
||||
### ApiCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| description | string | No | Description of the API. May include HTML formatting tags. |
|
||||
| authenticationSettings | object | No | Collection of authentication settings included into this API. - [AuthenticationSettingsContract object](#AuthenticationSettingsContract) |
|
||||
| subscriptionKeyParameterNames | object | No | Protocols over which API is made available. - [SubscriptionKeyParameterNamesContract object](#SubscriptionKeyParameterNamesContract) |
|
||||
| type | enum | No | Type of API. - http or soap |
|
||||
| apiRevision | string | No | Describes the Revision of the Api. If no value is provided, default revision 1 is created |
|
||||
| isCurrent | boolean | No | Indicates if API revision is current api revision. |
|
||||
| isOnline | boolean | No | Indicates if API revision is accessible via the gateway. |
|
||||
| displayName | string | No | API name. |
|
||||
| serviceUrl | string | No | Absolute URL of the backend service implementing this API. |
|
||||
| path | string | Yes | Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. |
|
||||
| protocols | array | No | Describes on which protocols the operations in this API can be invoked. - http or https |
|
||||
| contentValue | string | No | Content value when Importing an API. |
|
||||
| contentFormat | enum | No | Format of the Content in which the API is getting imported. - wadl-xml, wadl-link-json, swagger-json, swagger-link-json, wsdl, wsdl-link |
|
||||
| wsdlSelector | object | No | Criteria to limit import of WSDL to a subset of the document. - [ApiCreateOrUpdatePropertiesWsdlSelector object](#ApiCreateOrUpdatePropertiesWsdlSelector) |
|
||||
|
||||
|
||||
<a id="AuthenticationSettingsContract" />
|
||||
### AuthenticationSettingsContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| oAuth2 | object | No | OAuth2 Authentication settings - [OAuth2AuthenticationSettingsContract object](#OAuth2AuthenticationSettingsContract) |
|
||||
|
||||
|
||||
<a id="SubscriptionKeyParameterNamesContract" />
|
||||
### SubscriptionKeyParameterNamesContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| header | string | No | Subscription key header name. |
|
||||
| query | string | No | Subscription key query string parameter name. |
|
||||
|
||||
|
||||
<a id="ApiCreateOrUpdatePropertiesWsdlSelector" />
|
||||
### ApiCreateOrUpdatePropertiesWsdlSelector object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| wsdlServiceName | string | No | Name of service to import from WSDL |
|
||||
| wsdlEndpointName | string | No | Name of endpoint(port) to import from WSDL |
|
||||
|
||||
|
||||
<a id="OAuth2AuthenticationSettingsContract" />
|
||||
### OAuth2AuthenticationSettingsContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| authorizationServerId | string | No | OAuth authorization server identifier. |
|
||||
| scope | string | No | operations scope. |
|
||||
|
||||
|
|
@ -1,189 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/apis/operations template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/apis/operations resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/apis/operations",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"templateParameters": [
|
||||
{
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"type": "string",
|
||||
"defaultValue": "string",
|
||||
"required": "boolean",
|
||||
"values": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
],
|
||||
"description": "string",
|
||||
"request": {
|
||||
"description": "string",
|
||||
"queryParameters": [
|
||||
{
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"type": "string",
|
||||
"defaultValue": "string",
|
||||
"required": "boolean",
|
||||
"values": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
],
|
||||
"headers": [
|
||||
{
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"type": "string",
|
||||
"defaultValue": "string",
|
||||
"required": "boolean",
|
||||
"values": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
],
|
||||
"representations": [
|
||||
{
|
||||
"contentType": "string",
|
||||
"sample": "string",
|
||||
"schemaId": "string",
|
||||
"typeName": "string",
|
||||
"formParameters": [
|
||||
{
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"type": "string",
|
||||
"defaultValue": "string",
|
||||
"required": "boolean",
|
||||
"values": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"responses": [
|
||||
{
|
||||
"statusCode": "integer",
|
||||
"description": "string",
|
||||
"representations": [
|
||||
{
|
||||
"contentType": "string",
|
||||
"sample": "string",
|
||||
"schemaId": "string",
|
||||
"typeName": "string",
|
||||
"formParameters": [
|
||||
{
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"type": "string",
|
||||
"defaultValue": "string",
|
||||
"required": "boolean",
|
||||
"values": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"headers": [
|
||||
{
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"type": "string",
|
||||
"defaultValue": "string",
|
||||
"required": "boolean",
|
||||
"values": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"policies": "string",
|
||||
"displayName": "string",
|
||||
"method": "string",
|
||||
"urlTemplate": "string"
|
||||
},
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/apis/operations" />
|
||||
### Microsoft.ApiManagement/service/apis/operations object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Operation identifier within an API. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/apis/operations |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Properties of the Operation Contract. - [OperationContractProperties object](#OperationContractProperties) |
|
||||
| resources | array | No | [policies](./operations/policies.md) |
|
||||
|
||||
|
||||
<a id="OperationContractProperties" />
|
||||
### OperationContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| templateParameters | array | No | Collection of URL template parameters. - [ParameterContract object](#ParameterContract) |
|
||||
| description | string | No | Description of the operation. May include HTML formatting tags. |
|
||||
| request | object | No | An entity containing request details. - [RequestContract object](#RequestContract) |
|
||||
| responses | array | No | Array of Operation responses. - [ResponseContract object](#ResponseContract) |
|
||||
| policies | string | No | Operation Policies |
|
||||
| displayName | string | Yes | Operation Name. |
|
||||
| method | string | Yes | A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. |
|
||||
| urlTemplate | string | Yes | Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} |
|
||||
|
||||
|
||||
<a id="ParameterContract" />
|
||||
### ParameterContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Parameter name. |
|
||||
| description | string | No | Parameter description. |
|
||||
| type | string | Yes | Parameter type. |
|
||||
| defaultValue | string | No | Default parameter value. |
|
||||
| required | boolean | No | whether parameter is required or not. |
|
||||
| values | array | No | Parameter values. - string |
|
||||
|
||||
|
||||
<a id="RequestContract" />
|
||||
### RequestContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| description | string | No | Operation request description. |
|
||||
| queryParameters | array | No | Collection of operation request query parameters. - [ParameterContract object](#ParameterContract) |
|
||||
| headers | array | No | Collection of operation request headers. - [ParameterContract object](#ParameterContract) |
|
||||
| representations | array | No | Collection of operation request representations. - [RepresentationContract object](#RepresentationContract) |
|
||||
|
||||
|
||||
<a id="ResponseContract" />
|
||||
### ResponseContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| statusCode | integer | Yes | Operation response HTTP status code. |
|
||||
| description | string | No | Operation response description. |
|
||||
| representations | array | No | Collection of operation response representations. - [RepresentationContract object](#RepresentationContract) |
|
||||
| headers | array | No | Collection of operation response headers. - [ParameterContract object](#ParameterContract) |
|
||||
|
||||
|
||||
<a id="RepresentationContract" />
|
||||
### RepresentationContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| contentType | string | Yes | Specifies a registered or custom content type for this representation, e.g. application/xml. |
|
||||
| sample | string | No | An example of the representation. |
|
||||
| schemaId | string | No | Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. |
|
||||
| typeName | string | No | Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. |
|
||||
| formParameters | array | No | Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. - [ParameterContract object](#ParameterContract) |
|
||||
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/apis/operations/policies template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/apis/operations/policies resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "policy",
|
||||
"type": "Microsoft.ApiManagement/service/apis/operations/policies",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"policyContent": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/apis/operations/policies" />
|
||||
### Microsoft.ApiManagement/service/apis/operations/policies object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | enum | Yes | The identifier of the Policy. - policy |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/apis/operations/policies |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Properties of the Policy. - [PolicyContractProperties object](#PolicyContractProperties) |
|
||||
|
||||
|
||||
<a id="PolicyContractProperties" />
|
||||
### PolicyContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| policyContent | string | Yes | Json escaped Xml Encoded contents of the Policy. |
|
||||
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/apis/policies template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/apis/policies resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "policy",
|
||||
"type": "Microsoft.ApiManagement/service/apis/policies",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"policyContent": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/apis/policies" />
|
||||
### Microsoft.ApiManagement/service/apis/policies object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | enum | Yes | The identifier of the Policy. - policy |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/apis/policies |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Properties of the Policy. - [PolicyContractProperties object](#PolicyContractProperties) |
|
||||
|
||||
|
||||
<a id="PolicyContractProperties" />
|
||||
### PolicyContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| policyContent | string | Yes | Json escaped Xml Encoded contents of the Policy. |
|
||||
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/apis/schemas template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/apis/schemas resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/apis/schemas",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"contentType": "string",
|
||||
"document": {
|
||||
"value": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/apis/schemas" />
|
||||
### Microsoft.ApiManagement/service/apis/schemas object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Schema identifier within an API. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/apis/schemas |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Properties of the Schema. - [SchemaContractProperties object](#SchemaContractProperties) |
|
||||
|
||||
|
||||
<a id="SchemaContractProperties" />
|
||||
### SchemaContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| contentType | string | Yes | Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). |
|
||||
| document | object | No | Properties of the Schema Document. - [SchemaDocumentProperties object](#SchemaDocumentProperties) |
|
||||
|
||||
|
||||
<a id="SchemaDocumentProperties" />
|
||||
### SchemaDocumentProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| value | string | No | Json escaped string defining the document representing the Schema. |
|
||||
|
||||
|
|
@ -1,87 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/authorizationServers template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/authorizationServers resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/authorizationServers",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"description": "string",
|
||||
"authorizationMethods": [
|
||||
"string"
|
||||
],
|
||||
"clientAuthenticationMethod": [
|
||||
"string"
|
||||
],
|
||||
"tokenBodyParameters": [
|
||||
{
|
||||
"name": "string",
|
||||
"value": "string"
|
||||
}
|
||||
],
|
||||
"tokenEndpoint": "string",
|
||||
"supportState": "boolean",
|
||||
"defaultScope": "string",
|
||||
"bearerTokenSendingMethods": [
|
||||
"string"
|
||||
],
|
||||
"clientSecret": "string",
|
||||
"resourceOwnerUsername": "string",
|
||||
"resourceOwnerPassword": "string",
|
||||
"displayName": "string",
|
||||
"clientRegistrationEndpoint": "string",
|
||||
"authorizationEndpoint": "string",
|
||||
"grantTypes": [
|
||||
"string"
|
||||
],
|
||||
"clientId": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/authorizationServers" />
|
||||
### Microsoft.ApiManagement/service/authorizationServers object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Identifier of the authorization server. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/authorizationServers |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Properties of the External OAuth authorization server Contract. - [AuthorizationServerContractProperties object](#AuthorizationServerContractProperties) |
|
||||
|
||||
|
||||
<a id="AuthorizationServerContractProperties" />
|
||||
### AuthorizationServerContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| description | string | No | Description of the authorization server. Can contain HTML formatting tags. |
|
||||
| authorizationMethods | array | No | HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. - HEAD, OPTIONS, TRACE, GET, POST, PUT, PATCH, DELETE |
|
||||
| clientAuthenticationMethod | array | No | Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. - Basic or Body |
|
||||
| tokenBodyParameters | array | No | Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}. - [TokenBodyParameterContract object](#TokenBodyParameterContract) |
|
||||
| tokenEndpoint | string | No | OAuth token endpoint. Contains absolute URI to entity being referenced. |
|
||||
| supportState | boolean | No | If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. |
|
||||
| defaultScope | string | No | Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. |
|
||||
| bearerTokenSendingMethods | array | No | Specifies the mechanism by which access token is passed to the API. - authorizationHeader or query |
|
||||
| clientSecret | string | No | Client or app secret registered with this authorization server. |
|
||||
| resourceOwnerUsername | string | No | Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. |
|
||||
| resourceOwnerPassword | string | No | Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. |
|
||||
| displayName | string | Yes | User-friendly authorization server name. |
|
||||
| clientRegistrationEndpoint | string | Yes | Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced. |
|
||||
| authorizationEndpoint | string | Yes | OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. |
|
||||
| grantTypes | array | Yes | Form of an authorization grant, which the client uses to request the access token. - authorizationCode, implicit, resourceOwnerPassword, clientCredentials |
|
||||
| clientId | string | Yes | Client or app id registered with this authorization server. |
|
||||
|
||||
|
||||
<a id="TokenBodyParameterContract" />
|
||||
### TokenBodyParameterContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | body parameter name. |
|
||||
| value | string | Yes | body parameter value. |
|
||||
|
||||
|
|
@ -1,147 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/backends template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/backends resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/backends",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"title": "string",
|
||||
"description": "string",
|
||||
"resourceId": "string",
|
||||
"properties": {
|
||||
"serviceFabricCluster": {
|
||||
"clientCertificatethumbprint": "string",
|
||||
"maxPartitionResolutionRetries": "integer",
|
||||
"managementEndpoints": [
|
||||
"string"
|
||||
],
|
||||
"serverCertificateThumbprints": [
|
||||
"string"
|
||||
],
|
||||
"serverX509Names": [
|
||||
{
|
||||
"name": "string",
|
||||
"issuerCertificateThumbprint": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"credentials": {
|
||||
"certificate": [
|
||||
"string"
|
||||
],
|
||||
"query": {},
|
||||
"header": {},
|
||||
"authorization": {
|
||||
"scheme": "string",
|
||||
"parameter": "string"
|
||||
}
|
||||
},
|
||||
"proxy": {
|
||||
"url": "string",
|
||||
"username": "string",
|
||||
"password": "string"
|
||||
},
|
||||
"tls": {
|
||||
"validateCertificateChain": "boolean",
|
||||
"validateCertificateName": "boolean"
|
||||
},
|
||||
"url": "string",
|
||||
"protocol": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/backends" />
|
||||
### Microsoft.ApiManagement/service/backends object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Identifier of the Backend entity. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/backends |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Backend entity contract properties. - [BackendContractProperties object](#BackendContractProperties) |
|
||||
|
||||
|
||||
<a id="BackendContractProperties" />
|
||||
### BackendContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| title | string | No | Backend Title. |
|
||||
| description | string | No | Backend Description. |
|
||||
| resourceId | string | No | Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps. |
|
||||
| properties | object | No | Backend Properties contract - [BackendProperties object](#BackendProperties) |
|
||||
| credentials | object | No | Backend Credentials Contract Properties - [BackendCredentialsContract object](#BackendCredentialsContract) |
|
||||
| proxy | object | No | Backend Proxy Contract Properties - [BackendProxyContract object](#BackendProxyContract) |
|
||||
| tls | object | No | Backend TLS Properties - [BackendTlsProperties object](#BackendTlsProperties) |
|
||||
| url | string | Yes | Runtime Url of the Backend. |
|
||||
| protocol | enum | Yes | Backend communication protocol. - http or soap |
|
||||
|
||||
|
||||
<a id="BackendProperties" />
|
||||
### BackendProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| serviceFabricCluster | object | No | Backend Service Fabric Cluster Properties - [BackendServiceFabricClusterProperties object](#BackendServiceFabricClusterProperties) |
|
||||
|
||||
|
||||
<a id="BackendCredentialsContract" />
|
||||
### BackendCredentialsContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| certificate | array | No | List of Client Certificate Thumbprint. - string |
|
||||
| query | object | No | Query Parameter description. |
|
||||
| header | object | No | Header Parameter description. |
|
||||
| authorization | object | No | Authorization header authentication - [BackendAuthorizationHeaderCredentials object](#BackendAuthorizationHeaderCredentials) |
|
||||
|
||||
|
||||
<a id="BackendProxyContract" />
|
||||
### BackendProxyContract object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| url | string | Yes | WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. |
|
||||
| username | string | No | Username to connect to the WebProxy server |
|
||||
| password | string | No | Password to connect to the WebProxy Server |
|
||||
|
||||
|
||||
<a id="BackendTlsProperties" />
|
||||
### BackendTlsProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| validateCertificateChain | boolean | No | Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. |
|
||||
| validateCertificateName | boolean | No | Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. |
|
||||
|
||||
|
||||
<a id="BackendServiceFabricClusterProperties" />
|
||||
### BackendServiceFabricClusterProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| clientCertificatethumbprint | string | Yes | The client certificate thumbprint for the management endpoint. |
|
||||
| maxPartitionResolutionRetries | integer | No | Maximum number of retries while attempting resolve the parition. |
|
||||
| managementEndpoints | array | Yes | The cluster management endpoint. - string |
|
||||
| serverCertificateThumbprints | array | No | Thumbprints of certificates cluster management service uses for tls communication - string |
|
||||
| serverX509Names | array | No | Server X509 Certificate Names Collection - [X509CertificateName object](#X509CertificateName) |
|
||||
|
||||
|
||||
<a id="BackendAuthorizationHeaderCredentials" />
|
||||
### BackendAuthorizationHeaderCredentials object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| scheme | string | Yes | Authentication Scheme name. |
|
||||
| parameter | string | Yes | Authentication Parameter value. |
|
||||
|
||||
|
||||
<a id="X509CertificateName" />
|
||||
### X509CertificateName object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | No | Common Name of the Certificate. |
|
||||
| issuerCertificateThumbprint | string | No | Thumbprint for the Issuer of the Certificate. |
|
||||
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/certificates template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/certificates resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/certificates",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"data": "string",
|
||||
"password": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/certificates" />
|
||||
### Microsoft.ApiManagement/service/certificates object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Identifier of the certificate entity. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/certificates |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Certificate create or update properties details. - [CertificateCreateOrUpdateProperties object](#CertificateCreateOrUpdateProperties) |
|
||||
|
||||
|
||||
<a id="CertificateCreateOrUpdateProperties" />
|
||||
### CertificateCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| data | string | Yes | Base 64 encoded certificate using the application/x-pkcs12 representation. |
|
||||
| password | string | Yes | Password for the Certificate |
|
||||
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/groups template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/groups resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/groups",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"displayName": "string",
|
||||
"description": "string",
|
||||
"type": "string",
|
||||
"externalId": "string"
|
||||
},
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/groups" />
|
||||
### Microsoft.ApiManagement/service/groups object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/groups |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Properties supplied to Create Group operation. - [GroupCreateParametersProperties object](#GroupCreateParametersProperties) |
|
||||
| resources | array | No | [users](./groups/users.md) |
|
||||
|
||||
|
||||
<a id="GroupCreateParametersProperties" />
|
||||
### GroupCreateParametersProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| displayName | string | Yes | Group name. |
|
||||
| description | string | No | Group description. |
|
||||
| type | enum | No | Group type. - custom, system, external |
|
||||
| externalId | string | No | Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null. |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/groups/users template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/groups/users resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/groups/users",
|
||||
"apiVersion": "2017-03-01"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/groups/users" />
|
||||
### Microsoft.ApiManagement/service/groups/users object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | User identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/groups/users |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
|
||||
|
|
@ -1,52 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/identityProviders template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/identityProviders resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/identityProviders",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"type": "string",
|
||||
"allowedTenants": [
|
||||
"string"
|
||||
],
|
||||
"signupPolicyName": "string",
|
||||
"signinPolicyName": "string",
|
||||
"profileEditingPolicyName": "string",
|
||||
"passwordResetPolicyName": "string",
|
||||
"clientId": "string",
|
||||
"clientSecret": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/identityProviders" />
|
||||
### Microsoft.ApiManagement/service/identityProviders object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | enum | Yes | Identity Provider Type identifier. - facebook, google, microsoft, twitter, aad, aadB2C |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/identityProviders |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Identity Provider contract properties. - [IdentityProviderContractProperties object](#IdentityProviderContractProperties) |
|
||||
|
||||
|
||||
<a id="IdentityProviderContractProperties" />
|
||||
### IdentityProviderContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| type | enum | No | Identity Provider Type identifier. - facebook, google, microsoft, twitter, aad, aadB2C |
|
||||
| allowedTenants | array | No | List of Allowed Tenants when configuring Azure Active Directory login. - string |
|
||||
| signupPolicyName | string | No | Signup Policy Name. Only applies to AAD B2C Identity Provider. |
|
||||
| signinPolicyName | string | No | Signin Policy Name. Only applies to AAD B2C Identity Provider. |
|
||||
| profileEditingPolicyName | string | No | Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. |
|
||||
| passwordResetPolicyName | string | No | Password Reset Policy Name. Only applies to AAD B2C Identity Provider. |
|
||||
| clientId | string | Yes | Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. |
|
||||
| clientSecret | string | Yes | Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. |
|
||||
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/loggers template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/loggers resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/loggers",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"loggerType": "azureEventHub",
|
||||
"description": "string",
|
||||
"credentials": {},
|
||||
"isBuffered": "boolean"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/loggers" />
|
||||
### Microsoft.ApiManagement/service/loggers object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Logger identifier. Must be unique in the API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/loggers |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Logger entity contract properties. - [LoggerContractProperties object](#LoggerContractProperties) |
|
||||
|
||||
|
||||
<a id="LoggerContractProperties" />
|
||||
### LoggerContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| loggerType | enum | Yes | Logger type. - azureEventHub |
|
||||
| description | string | No | Logger description. |
|
||||
| credentials | object | Yes | The name and SendRule connection string of the event hub. |
|
||||
| isBuffered | boolean | No | Whether records are buffered in the logger before publishing. Default is assumed to be true. |
|
||||
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/notifications template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/notifications resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/notifications",
|
||||
"apiVersion": "2017-03-01",
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/notifications" />
|
||||
### Microsoft.ApiManagement/service/notifications object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | enum | Yes | Notification Name Identifier. - RequestPublisherNotificationMessage, PurchasePublisherNotificationMessage, NewApplicationNotificationMessage, BCC, NewIssuePublisherNotificationMessage, AccountClosedPublisher, QuotaLimitApproachingPublisherNotificationMessage |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/notifications |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| resources | array | No | [recipientEmails](./notifications/recipientEmails.md) [recipientUsers](./notifications/recipientUsers.md) |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/notifications/recipientEmails template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/notifications/recipientEmails resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/notifications/recipientEmails",
|
||||
"apiVersion": "2017-03-01"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/notifications/recipientEmails" />
|
||||
### Microsoft.ApiManagement/service/notifications/recipientEmails object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Email identifier. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/notifications/recipientEmails |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/notifications/recipientUsers template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/notifications/recipientUsers resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/notifications/recipientUsers",
|
||||
"apiVersion": "2017-03-01"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/notifications/recipientUsers" />
|
||||
### Microsoft.ApiManagement/service/notifications/recipientUsers object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | User identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/notifications/recipientUsers |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/openidConnectProviders template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/openidConnectProviders resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/openidConnectProviders",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"displayName": "string",
|
||||
"description": "string",
|
||||
"metadataEndpoint": "string",
|
||||
"clientId": "string",
|
||||
"clientSecret": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/openidConnectProviders" />
|
||||
### Microsoft.ApiManagement/service/openidConnectProviders object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Identifier of the OpenID Connect Provider. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/openidConnectProviders |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | OpenId Connect Provider contract properties. - [OpenidConnectProviderContractProperties object](#OpenidConnectProviderContractProperties) |
|
||||
|
||||
|
||||
<a id="OpenidConnectProviderContractProperties" />
|
||||
### OpenidConnectProviderContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| displayName | string | Yes | User-friendly OpenID Connect Provider name. |
|
||||
| description | string | No | User-friendly description of OpenID Connect Provider. |
|
||||
| metadataEndpoint | string | Yes | Metadata endpoint URI. |
|
||||
| clientId | string | Yes | Client ID of developer console which is the client application. |
|
||||
| clientSecret | string | No | Client Secret of developer console which is the client application. |
|
||||
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/policies template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/policies resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "policy",
|
||||
"type": "Microsoft.ApiManagement/service/policies",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"policyContent": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/policies" />
|
||||
### Microsoft.ApiManagement/service/policies object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | enum | Yes | The identifier of the Policy. - policy |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/policies |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Properties of the Policy. - [PolicyContractProperties object](#PolicyContractProperties) |
|
||||
|
||||
|
||||
<a id="PolicyContractProperties" />
|
||||
### PolicyContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| policyContent | string | Yes | Json escaped Xml Encoded contents of the Policy. |
|
||||
|
||||
|
|
@ -1,50 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/products template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/products resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/products",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"description": "string",
|
||||
"terms": "string",
|
||||
"subscriptionRequired": "boolean",
|
||||
"approvalRequired": "boolean",
|
||||
"subscriptionsLimit": "integer",
|
||||
"state": "string",
|
||||
"displayName": "string"
|
||||
},
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/products" />
|
||||
### Microsoft.ApiManagement/service/products object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Product identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/products |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Product entity contract properties. - [ProductContractProperties object](#ProductContractProperties) |
|
||||
| resources | array | No | [policies](./products/policies.md) [groups](./products/groups.md) [apis](./products/apis.md) |
|
||||
|
||||
|
||||
<a id="ProductContractProperties" />
|
||||
### ProductContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| description | string | No | Product description. May include HTML formatting tags. |
|
||||
| terms | string | No | Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. |
|
||||
| subscriptionRequired | boolean | No | Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. |
|
||||
| approvalRequired | boolean | No | whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false. |
|
||||
| subscriptionsLimit | integer | No | Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false. |
|
||||
| state | enum | No | whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. - notPublished or published |
|
||||
| displayName | string | Yes | Product name. |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/products/apis template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/products/apis resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/products/apis",
|
||||
"apiVersion": "2017-03-01"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/products/apis" />
|
||||
### Microsoft.ApiManagement/service/products/apis object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | API identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/products/apis |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/products/groups template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/products/groups resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/products/groups",
|
||||
"apiVersion": "2017-03-01"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/products/groups" />
|
||||
### Microsoft.ApiManagement/service/products/groups object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/products/groups |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/products/policies template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/products/policies resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "policy",
|
||||
"type": "Microsoft.ApiManagement/service/products/policies",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"policyContent": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/products/policies" />
|
||||
### Microsoft.ApiManagement/service/products/policies object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | enum | Yes | The identifier of the Policy. - policy |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/products/policies |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Properties of the Policy. - [PolicyContractProperties object](#PolicyContractProperties) |
|
||||
|
||||
|
||||
<a id="PolicyContractProperties" />
|
||||
### PolicyContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| policyContent | string | Yes | Json escaped Xml Encoded contents of the Policy. |
|
||||
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/properties template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/properties resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/properties",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"tags": [
|
||||
"string"
|
||||
],
|
||||
"secret": "boolean",
|
||||
"displayName": "string",
|
||||
"value": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/properties" />
|
||||
### Microsoft.ApiManagement/service/properties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Identifier of the property. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/properties |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Property entity contract properties. - [PropertyContractProperties object](#PropertyContractProperties) |
|
||||
|
||||
|
||||
<a id="PropertyContractProperties" />
|
||||
### PropertyContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| tags | array | No | Optional tags that when provided can be used to filter the property list. - string |
|
||||
| secret | boolean | No | Determines whether the value is a secret and should be encrypted or not. Default value is false. |
|
||||
| displayName | string | Yes | Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters. |
|
||||
| value | string | Yes | Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. |
|
||||
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/subscriptions template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/subscriptions resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/subscriptions",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"userId": "string",
|
||||
"productId": "string",
|
||||
"displayName": "string",
|
||||
"primaryKey": "string",
|
||||
"secondaryKey": "string",
|
||||
"state": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/subscriptions" />
|
||||
### Microsoft.ApiManagement/service/subscriptions object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Subscription entity Identifier. The entity represents the association between a user and a product in API Management. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/subscriptions |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Subscription contract properties. - [SubscriptionCreateParameterProperties object](#SubscriptionCreateParameterProperties) |
|
||||
|
||||
|
||||
<a id="SubscriptionCreateParameterProperties" />
|
||||
### SubscriptionCreateParameterProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| userId | string | Yes | User (user id path) for whom subscription is being created in form /users/{uid} |
|
||||
| productId | string | Yes | Product (product id path) for which subscription is being created in form /products/{productid} |
|
||||
| displayName | string | Yes | Subscription name. |
|
||||
| primaryKey | string | No | Primary subscription key. If not specified during request key will be generated automatically. |
|
||||
| secondaryKey | string | No | Secondary subscription key. If not specified during request key will be generated automatically. |
|
||||
| state | enum | No | Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. - suspended, active, expired, submitted, rejected, cancelled |
|
||||
|
||||
|
|
@ -1,59 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/templates template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/templates resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/templates",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"subject": "string",
|
||||
"title": "string",
|
||||
"description": "string",
|
||||
"body": "string",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "string",
|
||||
"title": "string",
|
||||
"description": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/templates" />
|
||||
### Microsoft.ApiManagement/service/templates object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | enum | Yes | Email Template Name Identifier. - applicationApprovedNotificationMessage, accountClosedDeveloper, quotaLimitApproachingDeveloperNotificationMessage, newDeveloperNotificationMessage, emailChangeIdentityDefault, inviteUserNotificationMessage, newCommentNotificationMessage, confirmSignUpIdentityDefault, newIssueNotificationMessage, purchaseDeveloperNotificationMessage, passwordResetIdentityDefault, passwordResetByAdminNotificationMessage, rejectDeveloperNotificationMessage, requestDeveloperNotificationMessage |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/templates |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | Email Template Update contract properties. - [EmailTemplateUpdateParameterProperties object](#EmailTemplateUpdateParameterProperties) |
|
||||
|
||||
|
||||
<a id="EmailTemplateUpdateParameterProperties" />
|
||||
### EmailTemplateUpdateParameterProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| subject | string | No | Subject of the Template. |
|
||||
| title | string | No | Title of the Template. |
|
||||
| description | string | No | Description of the Email Template. |
|
||||
| body | string | No | Email Template Body. This should be a valid XDocument |
|
||||
| parameters | array | No | Email Template Parameter values. - [EmailTemplateParametersContractProperties object](#EmailTemplateParametersContractProperties) |
|
||||
|
||||
|
||||
<a id="EmailTemplateParametersContractProperties" />
|
||||
### EmailTemplateParametersContractProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | No | Template parameter name. |
|
||||
| title | string | No | Template parameter title. |
|
||||
| description | string | No | Template parameter description. |
|
||||
|
||||
|
|
@ -1,48 +0,0 @@
|
|||
# Microsoft.ApiManagement/service/users template reference
|
||||
API Version: 2017-03-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ApiManagement/service/users resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ApiManagement/service/users",
|
||||
"apiVersion": "2017-03-01",
|
||||
"properties": {
|
||||
"state": "string",
|
||||
"note": "string",
|
||||
"email": "string",
|
||||
"firstName": "string",
|
||||
"lastName": "string",
|
||||
"password": "string",
|
||||
"confirmation": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ApiManagement/service/users" />
|
||||
### Microsoft.ApiManagement/service/users object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | User identifier. Must be unique in the current API Management service instance. |
|
||||
| type | enum | Yes | Microsoft.ApiManagement/service/users |
|
||||
| apiVersion | enum | Yes | 2017-03-01 |
|
||||
| properties | object | Yes | User entity create contract properties. - [UserCreateParameterProperties object](#UserCreateParameterProperties) |
|
||||
|
||||
|
||||
<a id="UserCreateParameterProperties" />
|
||||
### UserCreateParameterProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| state | enum | No | Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. - active, blocked, pending, deleted |
|
||||
| note | string | No | Optional note about a user set by the administrator. |
|
||||
| email | string | Yes | Email address. Must not be empty and must be unique within the service instance. |
|
||||
| firstName | string | Yes | First name. |
|
||||
| lastName | string | Yes | Last name. |
|
||||
| password | string | No | User Password. If no value is provided, a default password is generated. |
|
||||
| confirmation | enum | No | Determines the type of confirmation e-mail that will be sent to the newly created user. - signup or invite |
|
||||
|
||||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -1,55 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"sku": {
|
||||
"name": "string",
|
||||
"family": "string",
|
||||
"capacity": "integer"
|
||||
}
|
||||
},
|
||||
"location": "string",
|
||||
"tags": {},
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts" />
|
||||
### Microsoft.Automation/automationAccounts object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets account create or update properties. - [AutomationAccountCreateOrUpdateProperties object](#AutomationAccountCreateOrUpdateProperties) |
|
||||
| location | string | No | Gets or sets the location of the resource. |
|
||||
| tags | object | No | Gets or sets the tags attached to the resource. |
|
||||
| resources | array | No | [webhooks](./automationAccounts/webhooks.md) [variables](./automationAccounts/variables.md) [schedules](./automationAccounts/schedules.md) [runbooks](./automationAccounts/runbooks.md) [modules](./automationAccounts/modules.md) [jobSchedules](./automationAccounts/jobSchedules.md) [jobs](./automationAccounts/jobs.md) [nodeConfigurations](./automationAccounts/nodeConfigurations.md) [configurations](./automationAccounts/configurations.md) [compilationjobs](./automationAccounts/compilationjobs.md) [credentials](./automationAccounts/credentials.md) [connectionTypes](./automationAccounts/connectionTypes.md) [connections](./automationAccounts/connections.md) [certificates](./automationAccounts/certificates.md) |
|
||||
|
||||
|
||||
<a id="AutomationAccountCreateOrUpdateProperties" />
|
||||
### AutomationAccountCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| sku | object | No | Gets or sets account SKU. - [Sku object](#Sku) |
|
||||
|
||||
|
||||
<a id="Sku" />
|
||||
### Sku object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | enum | Yes | Gets or sets the SKU name of the account. - Free or Basic |
|
||||
| family | string | No | Gets or sets the SKU family. |
|
||||
| capacity | integer | No | Gets or sets the SKU capacity. |
|
||||
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/certificates template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/certificates resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/certificates",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"base64Value": "string",
|
||||
"description": "string",
|
||||
"thumbprint": "string",
|
||||
"isExportable": "boolean"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/certificates" />
|
||||
### Microsoft.Automation/automationAccounts/certificates object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/certificates |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets the properties of the certificate. - [CertificateCreateOrUpdateProperties object](#CertificateCreateOrUpdateProperties) |
|
||||
|
||||
|
||||
<a id="CertificateCreateOrUpdateProperties" />
|
||||
### CertificateCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| base64Value | string | Yes | Gets or sets the base64 encoded value of the certificate. |
|
||||
| description | string | No | Gets or sets the description of the certificate. |
|
||||
| thumbprint | string | No | Gets or sets the thumbprint of the certificate. |
|
||||
| isExportable | boolean | No | Gets or sets the is exportable flag of the certificate. |
|
||||
|
||||
|
|
@ -1,53 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/compilationjobs template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/compilationjobs resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/compilationjobs",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"configuration": {
|
||||
"name": "string"
|
||||
},
|
||||
"parameters": {},
|
||||
"newNodeConfigurationBuildVersionRequired": "boolean"
|
||||
},
|
||||
"location": "string",
|
||||
"tags": {}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/compilationjobs" />
|
||||
### Microsoft.Automation/automationAccounts/compilationjobs object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | globally unique identifier |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/compilationjobs |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets the list of compilation job properties. - [DscCompilationJobCreateProperties object](#DscCompilationJobCreateProperties) |
|
||||
| location | string | No | Gets or sets the location of the resource. |
|
||||
| tags | object | No | Gets or sets the tags attached to the resource. |
|
||||
|
||||
|
||||
<a id="DscCompilationJobCreateProperties" />
|
||||
### DscCompilationJobCreateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| configuration | object | Yes | Gets or sets the configuration. - [DscConfigurationAssociationProperty object](#DscConfigurationAssociationProperty) |
|
||||
| parameters | object | No | Gets or sets the parameters of the job. |
|
||||
| newNodeConfigurationBuildVersionRequired | boolean | No | If a new build version of NodeConfiguration is required. |
|
||||
|
||||
|
||||
<a id="DscConfigurationAssociationProperty" />
|
||||
### DscConfigurationAssociationProperty object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | No | Gets or sets the name of the Dsc configuration. |
|
||||
|
||||
|
|
@ -1,74 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/configurations template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/configurations resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/configurations",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"logVerbose": "boolean",
|
||||
"logProgress": "boolean",
|
||||
"source": {
|
||||
"hash": {
|
||||
"algorithm": "string",
|
||||
"value": "string"
|
||||
},
|
||||
"type": "string",
|
||||
"value": "string",
|
||||
"version": "string"
|
||||
},
|
||||
"parameters": {},
|
||||
"description": "string"
|
||||
},
|
||||
"location": "string",
|
||||
"tags": {}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/configurations" />
|
||||
### Microsoft.Automation/automationAccounts/configurations object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/configurations |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets configuration create or update properties. - [DscConfigurationCreateOrUpdateProperties object](#DscConfigurationCreateOrUpdateProperties) |
|
||||
| location | string | No | Gets or sets the location of the resource. |
|
||||
| tags | object | No | Gets or sets the tags attached to the resource. |
|
||||
|
||||
|
||||
<a id="DscConfigurationCreateOrUpdateProperties" />
|
||||
### DscConfigurationCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| logVerbose | boolean | No | Gets or sets verbose log option. |
|
||||
| logProgress | boolean | No | Gets or sets progress log option. |
|
||||
| source | object | Yes | Gets or sets the source. - [ContentSource object](#ContentSource) |
|
||||
| parameters | object | No | Gets or sets the configuration parameters. |
|
||||
| description | string | No | Gets or sets the description of the configuration. |
|
||||
|
||||
|
||||
<a id="ContentSource" />
|
||||
### ContentSource object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| hash | object | No | Gets or sets the hash. - [ContentHash object](#ContentHash) |
|
||||
| type | enum | No | Gets or sets the content source type. - embeddedContent or uri |
|
||||
| value | string | No | Gets or sets the value of the content. This is based on the content source type. |
|
||||
| version | string | No | Gets or sets the version of the content. |
|
||||
|
||||
|
||||
<a id="ContentHash" />
|
||||
### ContentHash object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| algorithm | string | Yes | Gets or sets the content hash algorithm used to hash the content. |
|
||||
| value | string | Yes | Gets or sets expected hash value of the content. |
|
||||
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/connectionTypes template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/connectionTypes resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/connectionTypes",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"isGlobal": "boolean",
|
||||
"fieldDefinitions": {}
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/connectionTypes" />
|
||||
### Microsoft.Automation/automationAccounts/connectionTypes object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/connectionTypes |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets the value of the connection type. - [ConnectionTypeCreateOrUpdateProperties object](#ConnectionTypeCreateOrUpdateProperties) |
|
||||
|
||||
|
||||
<a id="ConnectionTypeCreateOrUpdateProperties" />
|
||||
### ConnectionTypeCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| isGlobal | boolean | No | Gets or sets a Boolean value to indicate if the connection type is global. |
|
||||
| fieldDefinitions | object | Yes | Gets or sets the field definitions of the connection type. |
|
||||
|
||||
|
|
@ -1,49 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/connections template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/connections resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/connections",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"description": "string",
|
||||
"connectionType": {
|
||||
"name": "string"
|
||||
},
|
||||
"fieldDefinitionValues": {}
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/connections" />
|
||||
### Microsoft.Automation/automationAccounts/connections object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/connections |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets the properties of the connection. - [ConnectionCreateOrUpdateProperties object](#ConnectionCreateOrUpdateProperties) |
|
||||
|
||||
|
||||
<a id="ConnectionCreateOrUpdateProperties" />
|
||||
### ConnectionCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| description | string | No | Gets or sets the description of the connection. |
|
||||
| connectionType | object | Yes | Gets or sets the connectionType of the connection. - [ConnectionTypeAssociationProperty object](#ConnectionTypeAssociationProperty) |
|
||||
| fieldDefinitionValues | object | No | Gets or sets the field definition properties of the connection. |
|
||||
|
||||
|
||||
<a id="ConnectionTypeAssociationProperty" />
|
||||
### ConnectionTypeAssociationProperty object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | No | Gets or sets the name of the connection type. |
|
||||
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/credentials template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/credentials resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/credentials",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"userName": "string",
|
||||
"password": "string",
|
||||
"description": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/credentials" />
|
||||
### Microsoft.Automation/automationAccounts/credentials object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/credentials |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets the properties of the credential. - [CredentialCreateOrUpdateProperties object](#CredentialCreateOrUpdateProperties) |
|
||||
|
||||
|
||||
<a id="CredentialCreateOrUpdateProperties" />
|
||||
### CredentialCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| userName | string | Yes | Gets or sets the user name of the credential. |
|
||||
| password | string | Yes | Gets or sets the password of the credential. |
|
||||
| description | string | No | Gets or sets the description of the credential. |
|
||||
|
||||
|
|
@ -1,60 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/jobSchedules template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/jobSchedules resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/jobSchedules",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"schedule": {
|
||||
"name": "string"
|
||||
},
|
||||
"runbook": {
|
||||
"name": "string"
|
||||
},
|
||||
"runOn": "string",
|
||||
"parameters": {}
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/jobSchedules" />
|
||||
### Microsoft.Automation/automationAccounts/jobSchedules object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | globally unique identifier |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/jobSchedules |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets the list of job schedule properties. - [JobScheduleCreateProperties object](#JobScheduleCreateProperties) |
|
||||
|
||||
|
||||
<a id="JobScheduleCreateProperties" />
|
||||
### JobScheduleCreateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| schedule | object | Yes | Gets or sets the schedule. - [ScheduleAssociationProperty object](#ScheduleAssociationProperty) |
|
||||
| runbook | object | Yes | Gets or sets the runbook. - [RunbookAssociationProperty object](#RunbookAssociationProperty) |
|
||||
| runOn | string | No | Gets or sets the hybrid worker group that the scheduled job should run on. |
|
||||
| parameters | object | No | Gets or sets a list of job properties. |
|
||||
|
||||
|
||||
<a id="ScheduleAssociationProperty" />
|
||||
### ScheduleAssociationProperty object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | No | Gets or sets the name of the schedule. |
|
||||
|
||||
|
||||
<a id="RunbookAssociationProperty" />
|
||||
### RunbookAssociationProperty object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | No | Gets or sets the name of the runbook. |
|
||||
|
||||
|
|
@ -1,53 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/jobs template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/jobs resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/jobs",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"runbook": {
|
||||
"name": "string"
|
||||
},
|
||||
"parameters": {},
|
||||
"runOn": "string"
|
||||
},
|
||||
"location": "string",
|
||||
"tags": {}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/jobs" />
|
||||
### Microsoft.Automation/automationAccounts/jobs object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | globally unique identifier |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/jobs |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets the list of job properties. - [JobCreateProperties object](#JobCreateProperties) |
|
||||
| location | string | No | Gets or sets the location of the resource. |
|
||||
| tags | object | No | Gets or sets the tags attached to the resource. |
|
||||
|
||||
|
||||
<a id="JobCreateProperties" />
|
||||
### JobCreateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| runbook | object | Yes | Gets or sets the runbook. - [RunbookAssociationProperty object](#RunbookAssociationProperty) |
|
||||
| parameters | object | No | Gets or sets the parameters of the job. |
|
||||
| runOn | string | No | Gets or sets the runOn which specifies the group name where the job is to be executed. |
|
||||
|
||||
|
||||
<a id="RunbookAssociationProperty" />
|
||||
### RunbookAssociationProperty object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | No | Gets or sets the name of the runbook. |
|
||||
|
||||
|
|
@ -1,64 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/modules template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/modules resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/modules",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"contentLink": {
|
||||
"uri": "string",
|
||||
"contentHash": {
|
||||
"algorithm": "string",
|
||||
"value": "string"
|
||||
},
|
||||
"version": "string"
|
||||
}
|
||||
},
|
||||
"location": "string",
|
||||
"tags": {}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/modules" />
|
||||
### Microsoft.Automation/automationAccounts/modules object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/modules |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets the module create properties. - [ModuleCreateOrUpdateProperties object](#ModuleCreateOrUpdateProperties) |
|
||||
| location | string | No | Gets or sets the location of the resource. |
|
||||
| tags | object | No | Gets or sets the tags attached to the resource. |
|
||||
|
||||
|
||||
<a id="ModuleCreateOrUpdateProperties" />
|
||||
### ModuleCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| contentLink | object | Yes | Gets or sets the module content link. - [ContentLink object](#ContentLink) |
|
||||
|
||||
|
||||
<a id="ContentLink" />
|
||||
### ContentLink object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| uri | string | No | Gets or sets the uri of the runbook content. |
|
||||
| contentHash | object | No | Gets or sets the hash. - [ContentHash object](#ContentHash) |
|
||||
| version | string | No | Gets or sets the version of the content. |
|
||||
|
||||
|
||||
<a id="ContentHash" />
|
||||
### ContentHash object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| algorithm | string | Yes | Gets or sets the content hash algorithm used to hash the content. |
|
||||
| value | string | Yes | Gets or sets expected hash value of the content. |
|
||||
|
||||
|
|
@ -1,66 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/nodeConfigurations template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/nodeConfigurations resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/nodeConfigurations",
|
||||
"apiVersion": "2015-10-31",
|
||||
"source": {
|
||||
"hash": {
|
||||
"algorithm": "string",
|
||||
"value": "string"
|
||||
},
|
||||
"type": "string",
|
||||
"value": "string",
|
||||
"version": "string"
|
||||
},
|
||||
"configuration": {
|
||||
"name": "string"
|
||||
},
|
||||
"newNodeConfigurationBuildVersionRequired": "boolean"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/nodeConfigurations" />
|
||||
### Microsoft.Automation/automationAccounts/nodeConfigurations object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/nodeConfigurations |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| source | object | Yes | Gets or sets the source. - [ContentSource object](#ContentSource) |
|
||||
| configuration | object | Yes | Gets or sets the configuration of the node. - [DscConfigurationAssociationProperty object](#DscConfigurationAssociationProperty) |
|
||||
| newNodeConfigurationBuildVersionRequired | boolean | No | If a new build version of NodeConfiguration is required. |
|
||||
|
||||
|
||||
<a id="ContentSource" />
|
||||
### ContentSource object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| hash | object | No | Gets or sets the hash. - [ContentHash object](#ContentHash) |
|
||||
| type | enum | No | Gets or sets the content source type. - embeddedContent or uri |
|
||||
| value | string | No | Gets or sets the value of the content. This is based on the content source type. |
|
||||
| version | string | No | Gets or sets the version of the content. |
|
||||
|
||||
|
||||
<a id="DscConfigurationAssociationProperty" />
|
||||
### DscConfigurationAssociationProperty object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | No | Gets or sets the name of the Dsc configuration. |
|
||||
|
||||
|
||||
<a id="ContentHash" />
|
||||
### ContentHash object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| algorithm | string | Yes | Gets or sets the content hash algorithm used to hash the content. |
|
||||
| value | string | Yes | Gets or sets expected hash value of the content. |
|
||||
|
||||
|
|
@ -1,104 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/runbooks template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/runbooks resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/runbooks",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"logVerbose": "boolean",
|
||||
"logProgress": "boolean",
|
||||
"runbookType": "string",
|
||||
"draft": {
|
||||
"inEdit": "boolean",
|
||||
"draftContentLink": {
|
||||
"uri": "string",
|
||||
"contentHash": {
|
||||
"algorithm": "string",
|
||||
"value": "string"
|
||||
},
|
||||
"version": "string"
|
||||
},
|
||||
"creationTime": "string",
|
||||
"lastModifiedTime": "string",
|
||||
"parameters": {},
|
||||
"outputTypes": [
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"publishContentLink": {
|
||||
"uri": "string",
|
||||
"contentHash": {
|
||||
"algorithm": "string",
|
||||
"value": "string"
|
||||
},
|
||||
"version": "string"
|
||||
},
|
||||
"description": "string",
|
||||
"logActivityTrace": "integer"
|
||||
},
|
||||
"location": "string",
|
||||
"tags": {}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/runbooks" />
|
||||
### Microsoft.Automation/automationAccounts/runbooks object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/runbooks |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets runbook create or update properties. - [RunbookCreateOrUpdateProperties object](#RunbookCreateOrUpdateProperties) |
|
||||
| location | string | No | Gets or sets the location of the resource. |
|
||||
| tags | object | No | Gets or sets the tags attached to the resource. |
|
||||
|
||||
|
||||
<a id="RunbookCreateOrUpdateProperties" />
|
||||
### RunbookCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| logVerbose | boolean | No | Gets or sets verbose log option. |
|
||||
| logProgress | boolean | No | Gets or sets progress log option. |
|
||||
| runbookType | enum | Yes | Gets or sets the type of the runbook. - Script, Graph, PowerShellWorkflow, PowerShell, GraphPowerShellWorkflow, GraphPowerShell |
|
||||
| draft | object | No | Gets or sets the draft runbook properties. - [RunbookDraft object](#RunbookDraft) |
|
||||
| publishContentLink | object | No | Gets or sets the published runbook content link. - [ContentLink object](#ContentLink) |
|
||||
| description | string | No | Gets or sets the description of the runbook. |
|
||||
| logActivityTrace | integer | No | Gets or sets the activity-level tracing options of the runbook. |
|
||||
|
||||
|
||||
<a id="RunbookDraft" />
|
||||
### RunbookDraft object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| inEdit | boolean | No | Gets or sets whether runbook is in edit mode. |
|
||||
| draftContentLink | object | No | Gets or sets the draft runbook content link. - [ContentLink object](#ContentLink) |
|
||||
| creationTime | string | No | Gets or sets the creation time of the runbook draft. |
|
||||
| lastModifiedTime | string | No | Gets or sets the last modified time of the runbook draft. |
|
||||
| parameters | object | No | Gets or sets the runbook draft parameters. |
|
||||
| outputTypes | array | No | Gets or sets the runbook output types. - string |
|
||||
|
||||
|
||||
<a id="ContentLink" />
|
||||
### ContentLink object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| uri | string | No | Gets or sets the uri of the runbook content. |
|
||||
| contentHash | object | No | Gets or sets the hash. - [ContentHash object](#ContentHash) |
|
||||
| version | string | No | Gets or sets the version of the content. |
|
||||
|
||||
|
||||
<a id="ContentHash" />
|
||||
### ContentHash object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| algorithm | string | Yes | Gets or sets the content hash algorithm used to hash the content. |
|
||||
| value | string | Yes | Gets or sets expected hash value of the content. |
|
||||
|
||||
|
|
@ -1,78 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/schedules template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/schedules resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/schedules",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"description": "string",
|
||||
"startTime": "string",
|
||||
"expiryTime": "string",
|
||||
"interval": {},
|
||||
"frequency": "string",
|
||||
"timeZone": "string",
|
||||
"advancedSchedule": {
|
||||
"weekDays": [
|
||||
"string"
|
||||
],
|
||||
"monthDays": [
|
||||
"integer"
|
||||
],
|
||||
"monthlyOccurrences": [
|
||||
{
|
||||
"occurrence": "integer",
|
||||
"day": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/schedules" />
|
||||
### Microsoft.Automation/automationAccounts/schedules object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/schedules |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets the list of schedule properties. - [ScheduleCreateOrUpdateProperties object](#ScheduleCreateOrUpdateProperties) |
|
||||
|
||||
|
||||
<a id="ScheduleCreateOrUpdateProperties" />
|
||||
### ScheduleCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| description | string | No | Gets or sets the description of the schedule. |
|
||||
| startTime | string | Yes | Gets or sets the start time of the schedule. |
|
||||
| expiryTime | string | No | Gets or sets the end time of the schedule. |
|
||||
| interval | object | No | Gets or sets the interval of the schedule. |
|
||||
| frequency | enum | Yes | OneTime, Day, Hour, Week, Month |
|
||||
| timeZone | string | No | Gets or sets the time zone of the schedule. |
|
||||
| advancedSchedule | object | No | Gets or sets the AdvancedSchedule. - [AdvancedSchedule object](#AdvancedSchedule) |
|
||||
|
||||
|
||||
<a id="AdvancedSchedule" />
|
||||
### AdvancedSchedule object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| weekDays | array | No | Days of the week that the job should execute on. - string |
|
||||
| monthDays | array | No | Days of the month that the job should execute on. Must be between 1 and 31. - integer |
|
||||
| monthlyOccurrences | array | No | Occurrences of days within a month. - [AdvancedScheduleMonthlyOccurrence object](#AdvancedScheduleMonthlyOccurrence) |
|
||||
|
||||
|
||||
<a id="AdvancedScheduleMonthlyOccurrence" />
|
||||
### AdvancedScheduleMonthlyOccurrence object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| occurrence | integer | No | Occurrence of the week within the month. Must be between 1 and 5 |
|
||||
| day | enum | No | Day of the occurrence. Must be one of monday, tuesday, wednesday,thursday, friday, saturday, sunday. - Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday |
|
||||
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/variables template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/variables resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/variables",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"value": "string",
|
||||
"description": "string",
|
||||
"isEncrypted": "boolean"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/variables" />
|
||||
### Microsoft.Automation/automationAccounts/variables object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/variables |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets the properties of the variable. - [VariableCreateOrUpdateProperties object](#VariableCreateOrUpdateProperties) |
|
||||
|
||||
|
||||
<a id="VariableCreateOrUpdateProperties" />
|
||||
### VariableCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| value | string | No | Gets or sets the value of the variable. |
|
||||
| description | string | No | Gets or sets the description of the variable. |
|
||||
| isEncrypted | boolean | No | Gets or sets the encrypted flag of the variable. |
|
||||
|
||||
|
|
@ -1,55 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/webhooks template reference
|
||||
API Version: 2015-10-31
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/webhooks resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/webhooks",
|
||||
"apiVersion": "2015-10-31",
|
||||
"properties": {
|
||||
"isEnabled": "boolean",
|
||||
"uri": "string",
|
||||
"expiryTime": "string",
|
||||
"parameters": {},
|
||||
"runbook": {
|
||||
"name": "string"
|
||||
},
|
||||
"runOn": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/webhooks" />
|
||||
### Microsoft.Automation/automationAccounts/webhooks object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/webhooks |
|
||||
| apiVersion | enum | Yes | 2015-10-31 |
|
||||
| properties | object | Yes | Gets or sets the properties of the webhook. - [WebhookCreateOrUpdateProperties object](#WebhookCreateOrUpdateProperties) |
|
||||
|
||||
|
||||
<a id="WebhookCreateOrUpdateProperties" />
|
||||
### WebhookCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| isEnabled | boolean | No | Gets or sets the value of the enabled flag of webhook. |
|
||||
| uri | string | No | Gets or sets the uri. |
|
||||
| expiryTime | string | No | Gets or sets the expiry time. |
|
||||
| parameters | object | No | Gets or sets the parameters of the job. |
|
||||
| runbook | object | No | Gets or sets the runbook. - [RunbookAssociationProperty object](#RunbookAssociationProperty) |
|
||||
| runOn | string | No | Gets or sets the name of the hybrid worker group the webhook job will run on. |
|
||||
|
||||
|
||||
<a id="RunbookAssociationProperty" />
|
||||
### RunbookAssociationProperty object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | No | Gets or sets the name of the runbook. |
|
||||
|
||||
|
|
@ -1,455 +0,0 @@
|
|||
{
|
||||
"id": "https://schema.management.azure.com/schemas/2017-05-15-preview/Microsoft.Automation.json#",
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "Microsoft.Automation",
|
||||
"description": "Microsoft Automation Resource Types",
|
||||
"resourceDefinitions": {
|
||||
"automationAccounts_softwareUpdateConfigurations": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.Automation/automationAccounts/softwareUpdateConfigurations"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-05-15-preview"
|
||||
]
|
||||
},
|
||||
"properties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/SoftwareUpdateConfigurationProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Software update configuration properties."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion",
|
||||
"properties"
|
||||
],
|
||||
"description": "Microsoft.Automation/automationAccounts/softwareUpdateConfigurations"
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"AdvancedSchedule": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"weekDays": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Days of the week that the job should execute on."
|
||||
},
|
||||
"monthDays": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Days of the month that the job should execute on. Must be between 1 and 31."
|
||||
},
|
||||
"monthlyOccurrences": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/AdvancedScheduleMonthlyOccurrence"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Occurrences of days within a month."
|
||||
}
|
||||
},
|
||||
"description": "The properties of the create Advanced Schedule."
|
||||
},
|
||||
"AdvancedScheduleMonthlyOccurrence": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"occurrence": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "integer"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Occurrence of the week within the month. Must be between 1 and 5"
|
||||
},
|
||||
"day": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Monday",
|
||||
"Tuesday",
|
||||
"Wednesday",
|
||||
"Thursday",
|
||||
"Friday",
|
||||
"Saturday",
|
||||
"Sunday"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Day of the occurrence. Must be one of monday, tuesday, wednesday,thursday, friday, saturday, sunday."
|
||||
}
|
||||
},
|
||||
"description": "The properties of the create advanced schedule monthly occurrence."
|
||||
},
|
||||
"ErrorResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "Error code"
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "Error message indicating why the operation failed."
|
||||
}
|
||||
},
|
||||
"description": "Error response of an operation failure"
|
||||
},
|
||||
"LinuxProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"includedPackageClassifications": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Unclassified",
|
||||
"Critical",
|
||||
"Security",
|
||||
"Other"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Update classifications included in the software update configuration."
|
||||
},
|
||||
"excludedPackageNameMasks": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "packages excluded from the software update configuration."
|
||||
}
|
||||
},
|
||||
"description": "Linux specific update configuration."
|
||||
},
|
||||
"ScheduleProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"startTime": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "Gets or sets the start time of the schedule."
|
||||
},
|
||||
"expiryTime": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "Gets or sets the end time of the schedule."
|
||||
},
|
||||
"expiryTimeOffsetMinutes": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Gets or sets the expiry time's offset in minutes."
|
||||
},
|
||||
"isEnabled": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Gets or sets a value indicating whether this schedule is enabled."
|
||||
},
|
||||
"nextRun": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "Gets or sets the next run time of the schedule."
|
||||
},
|
||||
"nextRunOffsetMinutes": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Gets or sets the next run time's offset in minutes."
|
||||
},
|
||||
"interval": {
|
||||
"type": "object",
|
||||
"properties": {},
|
||||
"description": "Gets or sets the interval of the schedule."
|
||||
},
|
||||
"frequency": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"OneTime",
|
||||
"Day",
|
||||
"Hour",
|
||||
"Week",
|
||||
"Month"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Gets or sets the frequency of the schedule."
|
||||
},
|
||||
"timeZone": {
|
||||
"type": "string",
|
||||
"description": "Gets or sets the time zone of the schedule."
|
||||
},
|
||||
"advancedSchedule": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/AdvancedSchedule"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Gets or sets the advanced schedule."
|
||||
},
|
||||
"creationTime": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "Gets or sets the creation time."
|
||||
},
|
||||
"lastModifiedTime": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "Gets or sets the last modified time."
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "Gets or sets the description."
|
||||
}
|
||||
},
|
||||
"description": "Definition of schedule parameters."
|
||||
},
|
||||
"SoftwareUpdateConfigurationProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"updateConfiguration": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/UpdateConfiguration"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "update specific properties for the Software update configuration"
|
||||
},
|
||||
"scheduleInfo": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ScheduleProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Schedule information for the Software update configuration"
|
||||
},
|
||||
"error": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ErrorResponse"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "detailes of provisioning error"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"updateConfiguration",
|
||||
"scheduleInfo"
|
||||
],
|
||||
"description": "Software update configuration properties."
|
||||
},
|
||||
"UpdateConfiguration": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"operatingSystem": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Windows",
|
||||
"Linux"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "operating system of target machines."
|
||||
},
|
||||
"windows": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/WindowsProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Windows specific update configuration."
|
||||
},
|
||||
"linux": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/LinuxProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Linux specific update configuration."
|
||||
},
|
||||
"duration": {
|
||||
"type": "string",
|
||||
"format": "duration",
|
||||
"description": "Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601"
|
||||
},
|
||||
"azureVirtualMachines": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "List of azure resource Ids for azure virtual machines targeted by the software update configuration."
|
||||
},
|
||||
"nonAzureComputerNames": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "List of names of non-azure machines targeted by the software update configuration."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"operatingSystem"
|
||||
],
|
||||
"description": "Update specifc properties of the software update configuration."
|
||||
},
|
||||
"WindowsProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"includedUpdateClassifications": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Unclassified",
|
||||
"Critical",
|
||||
"Security",
|
||||
"UpdateRollup",
|
||||
"FeaturePack",
|
||||
"ServicePack",
|
||||
"Definition",
|
||||
"Tools",
|
||||
"Updates"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Update classification included in the software update configuration. A comma separated string with required values."
|
||||
},
|
||||
"excludedKbNumbers": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "KB numbers excluded from the software update configuration."
|
||||
}
|
||||
},
|
||||
"description": "Windows specific update configuration."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,163 +0,0 @@
|
|||
# Microsoft.Automation/automationAccounts/softwareUpdateConfigurations template reference
|
||||
API Version: 2017-05-15-preview
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Automation/automationAccounts/softwareUpdateConfigurations resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Automation/automationAccounts/softwareUpdateConfigurations",
|
||||
"apiVersion": "2017-05-15-preview",
|
||||
"properties": {
|
||||
"updateConfiguration": {
|
||||
"operatingSystem": "string",
|
||||
"windows": {
|
||||
"includedUpdateClassifications": "string",
|
||||
"excludedKbNumbers": [
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"linux": {
|
||||
"includedPackageClassifications": "string",
|
||||
"excludedPackageNameMasks": [
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"duration": "string",
|
||||
"azureVirtualMachines": [
|
||||
"string"
|
||||
],
|
||||
"nonAzureComputerNames": [
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"scheduleInfo": {
|
||||
"startTime": "string",
|
||||
"expiryTime": "string",
|
||||
"expiryTimeOffsetMinutes": "number",
|
||||
"isEnabled": "boolean",
|
||||
"nextRun": "string",
|
||||
"nextRunOffsetMinutes": "number",
|
||||
"interval": {},
|
||||
"frequency": "string",
|
||||
"timeZone": "string",
|
||||
"advancedSchedule": {
|
||||
"weekDays": [
|
||||
"string"
|
||||
],
|
||||
"monthDays": [
|
||||
"integer"
|
||||
],
|
||||
"monthlyOccurrences": [
|
||||
{
|
||||
"occurrence": "integer",
|
||||
"day": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"creationTime": "string",
|
||||
"lastModifiedTime": "string",
|
||||
"description": "string"
|
||||
},
|
||||
"error": {
|
||||
"code": "string",
|
||||
"message": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Automation/automationAccounts/softwareUpdateConfigurations" />
|
||||
### Microsoft.Automation/automationAccounts/softwareUpdateConfigurations object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Automation/automationAccounts/softwareUpdateConfigurations |
|
||||
| apiVersion | enum | Yes | 2017-05-15-preview |
|
||||
| properties | object | Yes | Software update configuration properties. - [SoftwareUpdateConfigurationProperties object](#SoftwareUpdateConfigurationProperties) |
|
||||
|
||||
|
||||
<a id="SoftwareUpdateConfigurationProperties" />
|
||||
### SoftwareUpdateConfigurationProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| updateConfiguration | object | Yes | update specific properties for the Software update configuration - [UpdateConfiguration object](#UpdateConfiguration) |
|
||||
| scheduleInfo | object | Yes | Schedule information for the Software update configuration - [ScheduleProperties object](#ScheduleProperties) |
|
||||
| error | object | No | detailes of provisioning error - [ErrorResponse object](#ErrorResponse) |
|
||||
|
||||
|
||||
<a id="UpdateConfiguration" />
|
||||
### UpdateConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| operatingSystem | enum | Yes | operating system of target machines. - Windows or Linux |
|
||||
| windows | object | No | Windows specific update configuration. - [WindowsProperties object](#WindowsProperties) |
|
||||
| linux | object | No | Linux specific update configuration. - [LinuxProperties object](#LinuxProperties) |
|
||||
| duration | string | No | Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601 |
|
||||
| azureVirtualMachines | array | No | List of azure resource Ids for azure virtual machines targeted by the software update configuration. - string |
|
||||
| nonAzureComputerNames | array | No | List of names of non-azure machines targeted by the software update configuration. - string |
|
||||
|
||||
|
||||
<a id="ScheduleProperties" />
|
||||
### ScheduleProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| startTime | string | No | Gets or sets the start time of the schedule. |
|
||||
| expiryTime | string | No | Gets or sets the end time of the schedule. |
|
||||
| expiryTimeOffsetMinutes | number | No | Gets or sets the expiry time's offset in minutes. |
|
||||
| isEnabled | boolean | No | Gets or sets a value indicating whether this schedule is enabled. |
|
||||
| nextRun | string | No | Gets or sets the next run time of the schedule. |
|
||||
| nextRunOffsetMinutes | number | No | Gets or sets the next run time's offset in minutes. |
|
||||
| interval | object | No | Gets or sets the interval of the schedule. |
|
||||
| frequency | enum | No | Gets or sets the frequency of the schedule. - OneTime, Day, Hour, Week, Month |
|
||||
| timeZone | string | No | Gets or sets the time zone of the schedule. |
|
||||
| advancedSchedule | object | No | Gets or sets the advanced schedule. - [AdvancedSchedule object](#AdvancedSchedule) |
|
||||
| creationTime | string | No | Gets or sets the creation time. |
|
||||
| lastModifiedTime | string | No | Gets or sets the last modified time. |
|
||||
| description | string | No | Gets or sets the description. |
|
||||
|
||||
|
||||
<a id="ErrorResponse" />
|
||||
### ErrorResponse object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| code | string | No | Error code |
|
||||
| message | string | No | Error message indicating why the operation failed. |
|
||||
|
||||
|
||||
<a id="WindowsProperties" />
|
||||
### WindowsProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| includedUpdateClassifications | enum | No | Update classification included in the software update configuration. A comma separated string with required values. - Unclassified, Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools, Updates |
|
||||
| excludedKbNumbers | array | No | KB numbers excluded from the software update configuration. - string |
|
||||
|
||||
|
||||
<a id="LinuxProperties" />
|
||||
### LinuxProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| includedPackageClassifications | enum | No | Update classifications included in the software update configuration. - Unclassified, Critical, Security, Other |
|
||||
| excludedPackageNameMasks | array | No | packages excluded from the software update configuration. - string |
|
||||
|
||||
|
||||
<a id="AdvancedSchedule" />
|
||||
### AdvancedSchedule object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| weekDays | array | No | Days of the week that the job should execute on. - string |
|
||||
| monthDays | array | No | Days of the month that the job should execute on. Must be between 1 and 31. - integer |
|
||||
| monthlyOccurrences | array | No | Occurrences of days within a month. - [AdvancedScheduleMonthlyOccurrence object](#AdvancedScheduleMonthlyOccurrence) |
|
||||
|
||||
|
||||
<a id="AdvancedScheduleMonthlyOccurrence" />
|
||||
### AdvancedScheduleMonthlyOccurrence object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| occurrence | integer | No | Occurrence of the week within the month. Must be between 1 and 5 |
|
||||
| day | enum | No | Day of the occurrence. Must be one of monday, tuesday, wednesday,thursday, friday, saturday, sunday. - Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday |
|
||||
|
||||
|
|
@ -1,252 +0,0 @@
|
|||
{
|
||||
"id": "https://schema.management.azure.com/schemas/2015-12-01/Microsoft.Batch.json#",
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "Microsoft.Batch",
|
||||
"description": "Microsoft Batch Resource Types",
|
||||
"resourceDefinitions": {
|
||||
"batchAccounts": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.Batch/batchAccounts"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2015-12-01"
|
||||
]
|
||||
},
|
||||
"location": {
|
||||
"type": "string",
|
||||
"description": "The region in which to create the account."
|
||||
},
|
||||
"tags": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"properties": {}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The user specified tags associated with the account."
|
||||
},
|
||||
"properties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/BatchAccountBaseProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The properties of the account."
|
||||
},
|
||||
"resources": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/batchAccounts_applications_childResource"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion",
|
||||
"location",
|
||||
"properties"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts"
|
||||
},
|
||||
"batchAccounts_applications": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.Batch/batchAccounts/applications"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2015-12-01"
|
||||
]
|
||||
},
|
||||
"allowUpdates": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "A value indicating whether packages within the application may be overwritten using the same version string."
|
||||
},
|
||||
"displayName": {
|
||||
"type": "string",
|
||||
"description": "The display name for the application."
|
||||
},
|
||||
"resources": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/batchAccounts_applications_versions_childResource"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts/applications"
|
||||
},
|
||||
"batchAccounts_applications_versions": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.Batch/batchAccounts/applications/versions"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2015-12-01"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts/applications/versions"
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"AutoStorageBaseProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"storageAccountId": {
|
||||
"type": "string",
|
||||
"description": "The resource ID of the storage account to be used for auto storage account."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"storageAccountId"
|
||||
],
|
||||
"description": "The properties related to auto storage account."
|
||||
},
|
||||
"BatchAccountBaseProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"autoStorage": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/AutoStorageBaseProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The properties related to auto storage account."
|
||||
}
|
||||
},
|
||||
"description": "The properties of a Batch account."
|
||||
},
|
||||
"batchAccounts_applications_childResource": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"applications"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2015-12-01"
|
||||
]
|
||||
},
|
||||
"allowUpdates": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "A value indicating whether packages within the application may be overwritten using the same version string."
|
||||
},
|
||||
"displayName": {
|
||||
"type": "string",
|
||||
"description": "The display name for the application."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts/applications"
|
||||
},
|
||||
"batchAccounts_applications_versions_childResource": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"versions"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2015-12-01"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts/applications/versions"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,51 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts template reference
|
||||
API Version: 2015-12-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts",
|
||||
"apiVersion": "2015-12-01",
|
||||
"location": "string",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"autoStorage": {
|
||||
"storageAccountId": "string"
|
||||
}
|
||||
},
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts" />
|
||||
### Microsoft.Batch/batchAccounts object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts |
|
||||
| apiVersion | enum | Yes | 2015-12-01 |
|
||||
| location | string | Yes | The region in which to create the account. |
|
||||
| tags | object | No | The user specified tags associated with the account. |
|
||||
| properties | object | Yes | The properties of the account. - [BatchAccountBaseProperties object](#BatchAccountBaseProperties) |
|
||||
| resources | array | No | [applications](./batchAccounts/applications.md) |
|
||||
|
||||
|
||||
<a id="BatchAccountBaseProperties" />
|
||||
### BatchAccountBaseProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| autoStorage | object | No | The properties related to auto storage account. - [AutoStorageBaseProperties object](#AutoStorageBaseProperties) |
|
||||
|
||||
|
||||
<a id="AutoStorageBaseProperties" />
|
||||
### AutoStorageBaseProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| storageAccountId | string | Yes | The resource ID of the storage account to be used for auto storage account. |
|
||||
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts/applications template reference
|
||||
API Version: 2015-12-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts/applications resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts/applications",
|
||||
"apiVersion": "2015-12-01",
|
||||
"allowUpdates": "boolean",
|
||||
"displayName": "string",
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts/applications" />
|
||||
### Microsoft.Batch/batchAccounts/applications object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts/applications |
|
||||
| apiVersion | enum | Yes | 2015-12-01 |
|
||||
| allowUpdates | boolean | No | A value indicating whether packages within the application may be overwritten using the same version string. |
|
||||
| displayName | string | No | The display name for the application. |
|
||||
| resources | array | No | [versions](./applications/versions.md) |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts/applications/versions template reference
|
||||
API Version: 2015-12-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts/applications/versions resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts/applications/versions",
|
||||
"apiVersion": "2015-12-01"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts/applications/versions" />
|
||||
### Microsoft.Batch/batchAccounts/applications/versions object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts/applications/versions |
|
||||
| apiVersion | enum | Yes | 2015-12-01 |
|
||||
|
||||
|
|
@ -1,296 +0,0 @@
|
|||
{
|
||||
"id": "https://schema.management.azure.com/schemas/2017-01-01/Microsoft.Batch.json#",
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "Microsoft.Batch",
|
||||
"description": "Microsoft Batch Resource Types",
|
||||
"resourceDefinitions": {
|
||||
"batchAccounts": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.Batch/batchAccounts"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-01-01"
|
||||
]
|
||||
},
|
||||
"location": {
|
||||
"type": "string",
|
||||
"description": "The region in which to create the account."
|
||||
},
|
||||
"tags": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"properties": {}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The user specified tags associated with the account."
|
||||
},
|
||||
"properties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/BatchAccountBaseProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The properties of the Batch account."
|
||||
},
|
||||
"resources": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/batchAccounts_applications_childResource"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion",
|
||||
"location",
|
||||
"properties"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts"
|
||||
},
|
||||
"batchAccounts_applications": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.Batch/batchAccounts/applications"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-01-01"
|
||||
]
|
||||
},
|
||||
"allowUpdates": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "A value indicating whether packages within the application may be overwritten using the same version string."
|
||||
},
|
||||
"displayName": {
|
||||
"type": "string",
|
||||
"description": "The display name for the application."
|
||||
},
|
||||
"resources": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/batchAccounts_applications_versions_childResource"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts/applications"
|
||||
},
|
||||
"batchAccounts_applications_versions": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.Batch/batchAccounts/applications/versions"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-01-01"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts/applications/versions"
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"AutoStorageBaseProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"storageAccountId": {
|
||||
"type": "string",
|
||||
"description": "The resource ID of the storage account to be used for auto storage account."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"storageAccountId"
|
||||
],
|
||||
"description": "The properties related to auto storage account."
|
||||
},
|
||||
"BatchAccountBaseProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"autoStorage": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/AutoStorageBaseProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The properties related to auto storage account."
|
||||
},
|
||||
"poolAllocationMode": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"BatchService",
|
||||
"UserSubscription"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService."
|
||||
},
|
||||
"keyVaultReference": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/KeyVaultReference"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "A reference to the Azure key vault associated with the Batch account."
|
||||
}
|
||||
},
|
||||
"description": "The properties of a Batch account."
|
||||
},
|
||||
"batchAccounts_applications_childResource": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"applications"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-01-01"
|
||||
]
|
||||
},
|
||||
"allowUpdates": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "A value indicating whether packages within the application may be overwritten using the same version string."
|
||||
},
|
||||
"displayName": {
|
||||
"type": "string",
|
||||
"description": "The display name for the application."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts/applications"
|
||||
},
|
||||
"batchAccounts_applications_versions_childResource": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"versions"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-01-01"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts/applications/versions"
|
||||
},
|
||||
"KeyVaultReference": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The resource ID of the Azure key vault associated with the Batch account."
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"description": "The Url of the Azure key vault associated with the Batch account."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"url"
|
||||
],
|
||||
"description": "Identifies the Azure key vault associated with a Batch account."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,66 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts template reference
|
||||
API Version: 2017-01-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts",
|
||||
"apiVersion": "2017-01-01",
|
||||
"location": "string",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"autoStorage": {
|
||||
"storageAccountId": "string"
|
||||
},
|
||||
"poolAllocationMode": "string",
|
||||
"keyVaultReference": {
|
||||
"id": "string",
|
||||
"url": "string"
|
||||
}
|
||||
},
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts" />
|
||||
### Microsoft.Batch/batchAccounts object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts |
|
||||
| apiVersion | enum | Yes | 2017-01-01 |
|
||||
| location | string | Yes | The region in which to create the account. |
|
||||
| tags | object | No | The user specified tags associated with the account. |
|
||||
| properties | object | Yes | The properties of the Batch account. - [BatchAccountBaseProperties object](#BatchAccountBaseProperties) |
|
||||
| resources | array | No | [applications](./batchAccounts/applications.md) |
|
||||
|
||||
|
||||
<a id="BatchAccountBaseProperties" />
|
||||
### BatchAccountBaseProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| autoStorage | object | No | The properties related to auto storage account. - [AutoStorageBaseProperties object](#AutoStorageBaseProperties) |
|
||||
| poolAllocationMode | enum | No | The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService. - BatchService or UserSubscription |
|
||||
| keyVaultReference | object | No | A reference to the Azure key vault associated with the Batch account. - [KeyVaultReference object](#KeyVaultReference) |
|
||||
|
||||
|
||||
<a id="AutoStorageBaseProperties" />
|
||||
### AutoStorageBaseProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| storageAccountId | string | Yes | The resource ID of the storage account to be used for auto storage account. |
|
||||
|
||||
|
||||
<a id="KeyVaultReference" />
|
||||
### KeyVaultReference object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | Yes | The resource ID of the Azure key vault associated with the Batch account. |
|
||||
| url | string | Yes | The Url of the Azure key vault associated with the Batch account. |
|
||||
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts/applications template reference
|
||||
API Version: 2017-01-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts/applications resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts/applications",
|
||||
"apiVersion": "2017-01-01",
|
||||
"allowUpdates": "boolean",
|
||||
"displayName": "string",
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts/applications" />
|
||||
### Microsoft.Batch/batchAccounts/applications object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts/applications |
|
||||
| apiVersion | enum | Yes | 2017-01-01 |
|
||||
| allowUpdates | boolean | No | A value indicating whether packages within the application may be overwritten using the same version string. |
|
||||
| displayName | string | No | The display name for the application. |
|
||||
| resources | array | No | [versions](./applications/versions.md) |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts/applications/versions template reference
|
||||
API Version: 2017-01-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts/applications/versions resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts/applications/versions",
|
||||
"apiVersion": "2017-01-01"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts/applications/versions" />
|
||||
### Microsoft.Batch/batchAccounts/applications/versions object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts/applications/versions |
|
||||
| apiVersion | enum | Yes | 2017-01-01 |
|
||||
|
||||
|
|
@ -1,296 +0,0 @@
|
|||
{
|
||||
"id": "https://schema.management.azure.com/schemas/2017-05-01/Microsoft.Batch.json#",
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "Microsoft.Batch",
|
||||
"description": "Microsoft Batch Resource Types",
|
||||
"resourceDefinitions": {
|
||||
"batchAccounts": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.Batch/batchAccounts"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-05-01"
|
||||
]
|
||||
},
|
||||
"location": {
|
||||
"type": "string",
|
||||
"description": "The region in which to create the account."
|
||||
},
|
||||
"tags": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"properties": {}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The user-specified tags associated with the account."
|
||||
},
|
||||
"properties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/BatchAccountCreateProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The properties of the Batch account."
|
||||
},
|
||||
"resources": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/batchAccounts_applications_childResource"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion",
|
||||
"location",
|
||||
"properties"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts"
|
||||
},
|
||||
"batchAccounts_applications": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.Batch/batchAccounts/applications"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-05-01"
|
||||
]
|
||||
},
|
||||
"allowUpdates": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "A value indicating whether packages within the application may be overwritten using the same version string."
|
||||
},
|
||||
"displayName": {
|
||||
"type": "string",
|
||||
"description": "The display name for the application."
|
||||
},
|
||||
"resources": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/batchAccounts_applications_versions_childResource"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts/applications"
|
||||
},
|
||||
"batchAccounts_applications_versions": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.Batch/batchAccounts/applications/versions"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-05-01"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts/applications/versions"
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"AutoStorageBaseProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"storageAccountId": {
|
||||
"type": "string",
|
||||
"description": "The resource ID of the storage account to be used for auto-storage account."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"storageAccountId"
|
||||
],
|
||||
"description": "The properties related to the auto-storage account."
|
||||
},
|
||||
"BatchAccountCreateProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"autoStorage": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/AutoStorageBaseProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The properties related to the auto-storage account."
|
||||
},
|
||||
"poolAllocationMode": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"BatchService",
|
||||
"UserSubscription"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService."
|
||||
},
|
||||
"keyVaultReference": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/KeyVaultReference"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "A reference to the Azure key vault associated with the Batch account."
|
||||
}
|
||||
},
|
||||
"description": "The properties of a Batch account."
|
||||
},
|
||||
"batchAccounts_applications_childResource": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"applications"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-05-01"
|
||||
]
|
||||
},
|
||||
"allowUpdates": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "A value indicating whether packages within the application may be overwritten using the same version string."
|
||||
},
|
||||
"displayName": {
|
||||
"type": "string",
|
||||
"description": "The display name for the application."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts/applications"
|
||||
},
|
||||
"batchAccounts_applications_versions_childResource": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"versions"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2017-05-01"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion"
|
||||
],
|
||||
"description": "Microsoft.Batch/batchAccounts/applications/versions"
|
||||
},
|
||||
"KeyVaultReference": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The resource ID of the Azure key vault associated with the Batch account."
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"description": "The URL of the Azure key vault associated with the Batch account."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"url"
|
||||
],
|
||||
"description": "Identifies the Azure key vault associated with a Batch account."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,66 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts template reference
|
||||
API Version: 2017-05-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts",
|
||||
"apiVersion": "2017-05-01",
|
||||
"location": "string",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"autoStorage": {
|
||||
"storageAccountId": "string"
|
||||
},
|
||||
"poolAllocationMode": "string",
|
||||
"keyVaultReference": {
|
||||
"id": "string",
|
||||
"url": "string"
|
||||
}
|
||||
},
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts" />
|
||||
### Microsoft.Batch/batchAccounts object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts |
|
||||
| apiVersion | enum | Yes | 2017-05-01 |
|
||||
| location | string | Yes | The region in which to create the account. |
|
||||
| tags | object | No | The user-specified tags associated with the account. |
|
||||
| properties | object | Yes | The properties of the Batch account. - [BatchAccountCreateProperties object](#BatchAccountCreateProperties) |
|
||||
| resources | array | No | [applications](./batchAccounts/applications.md) |
|
||||
|
||||
|
||||
<a id="BatchAccountCreateProperties" />
|
||||
### BatchAccountCreateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| autoStorage | object | No | The properties related to the auto-storage account. - [AutoStorageBaseProperties object](#AutoStorageBaseProperties) |
|
||||
| poolAllocationMode | enum | No | The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService. - BatchService or UserSubscription |
|
||||
| keyVaultReference | object | No | A reference to the Azure key vault associated with the Batch account. - [KeyVaultReference object](#KeyVaultReference) |
|
||||
|
||||
|
||||
<a id="AutoStorageBaseProperties" />
|
||||
### AutoStorageBaseProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| storageAccountId | string | Yes | The resource ID of the storage account to be used for auto-storage account. |
|
||||
|
||||
|
||||
<a id="KeyVaultReference" />
|
||||
### KeyVaultReference object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | Yes | The resource ID of the Azure key vault associated with the Batch account. |
|
||||
| url | string | Yes | The URL of the Azure key vault associated with the Batch account. |
|
||||
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts/applications template reference
|
||||
API Version: 2017-05-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts/applications resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts/applications",
|
||||
"apiVersion": "2017-05-01",
|
||||
"allowUpdates": "boolean",
|
||||
"displayName": "string",
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts/applications" />
|
||||
### Microsoft.Batch/batchAccounts/applications object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts/applications |
|
||||
| apiVersion | enum | Yes | 2017-05-01 |
|
||||
| allowUpdates | boolean | No | A value indicating whether packages within the application may be overwritten using the same version string. |
|
||||
| displayName | string | No | The display name for the application. |
|
||||
| resources | array | No | [versions](./applications/versions.md) |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts/applications/versions template reference
|
||||
API Version: 2017-05-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts/applications/versions resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts/applications/versions",
|
||||
"apiVersion": "2017-05-01"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts/applications/versions" />
|
||||
### Microsoft.Batch/batchAccounts/applications/versions object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts/applications/versions |
|
||||
| apiVersion | enum | Yes | 2017-05-01 |
|
||||
|
||||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -1,66 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts template reference
|
||||
API Version: 2017-09-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts",
|
||||
"apiVersion": "2017-09-01",
|
||||
"location": "string",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"autoStorage": {
|
||||
"storageAccountId": "string"
|
||||
},
|
||||
"poolAllocationMode": "string",
|
||||
"keyVaultReference": {
|
||||
"id": "string",
|
||||
"url": "string"
|
||||
}
|
||||
},
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts" />
|
||||
### Microsoft.Batch/batchAccounts object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts |
|
||||
| apiVersion | enum | Yes | 2017-09-01 |
|
||||
| location | string | Yes | The region in which to create the account. |
|
||||
| tags | object | No | The user-specified tags associated with the account. |
|
||||
| properties | object | Yes | The properties of the Batch account. - [BatchAccountCreateProperties object](#BatchAccountCreateProperties) |
|
||||
| resources | array | No | [pools](./batchAccounts/pools.md) [certificates](./batchAccounts/certificates.md) [applications](./batchAccounts/applications.md) |
|
||||
|
||||
|
||||
<a id="BatchAccountCreateProperties" />
|
||||
### BatchAccountCreateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| autoStorage | object | No | The properties related to the auto-storage account. - [AutoStorageBaseProperties object](#AutoStorageBaseProperties) |
|
||||
| poolAllocationMode | enum | No | The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService. - BatchService or UserSubscription |
|
||||
| keyVaultReference | object | No | A reference to the Azure key vault associated with the Batch account. - [KeyVaultReference object](#KeyVaultReference) |
|
||||
|
||||
|
||||
<a id="AutoStorageBaseProperties" />
|
||||
### AutoStorageBaseProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| storageAccountId | string | Yes | The resource ID of the storage account to be used for auto-storage account. |
|
||||
|
||||
|
||||
<a id="KeyVaultReference" />
|
||||
### KeyVaultReference object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | Yes | The resource ID of the Azure key vault associated with the Batch account. |
|
||||
| url | string | Yes | The URL of the Azure key vault associated with the Batch account. |
|
||||
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts/applications template reference
|
||||
API Version: 2017-09-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts/applications resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts/applications",
|
||||
"apiVersion": "2017-09-01",
|
||||
"allowUpdates": "boolean",
|
||||
"displayName": "string",
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts/applications" />
|
||||
### Microsoft.Batch/batchAccounts/applications object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts/applications |
|
||||
| apiVersion | enum | Yes | 2017-09-01 |
|
||||
| allowUpdates | boolean | No | A value indicating whether packages within the application may be overwritten using the same version string. |
|
||||
| displayName | string | No | The display name for the application. |
|
||||
| resources | array | No | [versions](./applications/versions.md) |
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts/applications/versions template reference
|
||||
API Version: 2017-09-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts/applications/versions resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts/applications/versions",
|
||||
"apiVersion": "2017-09-01"
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts/applications/versions" />
|
||||
### Microsoft.Batch/batchAccounts/applications/versions object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts/applications/versions |
|
||||
| apiVersion | enum | Yes | 2017-09-01 |
|
||||
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts/certificates template reference
|
||||
API Version: 2017-09-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts/certificates resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts/certificates",
|
||||
"apiVersion": "2017-09-01",
|
||||
"properties": {
|
||||
"thumbprintAlgorithm": "string",
|
||||
"thumbprint": "string",
|
||||
"format": "string",
|
||||
"data": "string",
|
||||
"password": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts/certificates" />
|
||||
### Microsoft.Batch/batchAccounts/certificates object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5. |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts/certificates |
|
||||
| apiVersion | enum | Yes | 2017-09-01 |
|
||||
| properties | object | Yes | The properties associated with the certificate. - [CertificateCreateOrUpdateProperties object](#CertificateCreateOrUpdateProperties) |
|
||||
|
||||
|
||||
<a id="CertificateCreateOrUpdateProperties" />
|
||||
### CertificateCreateOrUpdateProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| thumbprintAlgorithm | string | No | This must match the first portion of the certificate name. Currently required to be 'SHA1'. |
|
||||
| thumbprint | string | No | This must match the thumbprint from the name. |
|
||||
| format | enum | No | The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. - Pfx or Cer |
|
||||
| data | string | Yes | The maximum size is 10KB. |
|
||||
| password | string | No | This is required if the certificate format is pfx and must be omitted if the certificate format is cer. |
|
||||
|
||||
|
|
@ -1,405 +0,0 @@
|
|||
# Microsoft.Batch/batchAccounts/pools template reference
|
||||
API Version: 2017-09-01
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Batch/batchAccounts/pools resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Batch/batchAccounts/pools",
|
||||
"apiVersion": "2017-09-01",
|
||||
"properties": {
|
||||
"displayName": "string",
|
||||
"vmSize": "string",
|
||||
"deploymentConfiguration": {
|
||||
"cloudServiceConfiguration": {
|
||||
"osFamily": "string",
|
||||
"targetOSVersion": "string",
|
||||
"currentOSVersion": "string"
|
||||
},
|
||||
"virtualMachineConfiguration": {
|
||||
"imageReference": {
|
||||
"publisher": "string",
|
||||
"offer": "string",
|
||||
"sku": "string",
|
||||
"version": "string",
|
||||
"id": "string"
|
||||
},
|
||||
"osDisk": {
|
||||
"caching": "string"
|
||||
},
|
||||
"nodeAgentSkuId": "string",
|
||||
"windowsConfiguration": {
|
||||
"enableAutomaticUpdates": "boolean"
|
||||
},
|
||||
"dataDisks": [
|
||||
{
|
||||
"lun": "integer",
|
||||
"caching": "string",
|
||||
"diskSizeGB": "integer",
|
||||
"storageAccountType": "string"
|
||||
}
|
||||
],
|
||||
"licenseType": "string"
|
||||
}
|
||||
},
|
||||
"scaleSettings": {
|
||||
"fixedScale": {
|
||||
"resizeTimeout": "string",
|
||||
"targetDedicatedNodes": "integer",
|
||||
"targetLowPriorityNodes": "integer",
|
||||
"nodeDeallocationOption": "string"
|
||||
},
|
||||
"autoScale": {
|
||||
"formula": "string",
|
||||
"evaluationInterval": "string"
|
||||
}
|
||||
},
|
||||
"interNodeCommunication": "string",
|
||||
"networkConfiguration": {
|
||||
"subnetId": "string",
|
||||
"endpointConfiguration": {
|
||||
"inboundNatPools": [
|
||||
{
|
||||
"name": "string",
|
||||
"protocol": "string",
|
||||
"backendPort": "integer",
|
||||
"frontendPortRangeStart": "integer",
|
||||
"frontendPortRangeEnd": "integer",
|
||||
"networkSecurityGroupRules": [
|
||||
{
|
||||
"priority": "integer",
|
||||
"access": "string",
|
||||
"sourceAddressPrefix": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"maxTasksPerNode": "integer",
|
||||
"taskSchedulingPolicy": {
|
||||
"nodeFillType": "string"
|
||||
},
|
||||
"userAccounts": [
|
||||
{
|
||||
"name": "string",
|
||||
"password": "string",
|
||||
"elevationLevel": "string",
|
||||
"linuxUserConfiguration": {
|
||||
"uid": "integer",
|
||||
"gid": "integer",
|
||||
"sshPrivateKey": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"metadata": [
|
||||
{
|
||||
"name": "string",
|
||||
"value": "string"
|
||||
}
|
||||
],
|
||||
"startTask": {
|
||||
"commandLine": "string",
|
||||
"resourceFiles": [
|
||||
{
|
||||
"blobSource": "string",
|
||||
"filePath": "string",
|
||||
"fileMode": "string"
|
||||
}
|
||||
],
|
||||
"environmentSettings": [
|
||||
{
|
||||
"name": "string",
|
||||
"value": "string"
|
||||
}
|
||||
],
|
||||
"userIdentity": {
|
||||
"userName": "string",
|
||||
"autoUser": {
|
||||
"scope": "string",
|
||||
"elevationLevel": "string"
|
||||
}
|
||||
},
|
||||
"maxTaskRetryCount": "integer",
|
||||
"waitForSuccess": "boolean"
|
||||
},
|
||||
"certificates": [
|
||||
{
|
||||
"id": "string",
|
||||
"storeLocation": "string",
|
||||
"storeName": "string",
|
||||
"visibility": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
],
|
||||
"applicationPackages": [
|
||||
{
|
||||
"id": "string",
|
||||
"version": "string"
|
||||
}
|
||||
],
|
||||
"applicationLicenses": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Batch/batchAccounts/pools" />
|
||||
### Microsoft.Batch/batchAccounts/pools object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | The pool name. This must be unique within the account. |
|
||||
| type | enum | Yes | Microsoft.Batch/batchAccounts/pools |
|
||||
| apiVersion | enum | Yes | 2017-09-01 |
|
||||
| properties | object | Yes | The properties associated with the pool. - [PoolProperties object](#PoolProperties) |
|
||||
|
||||
|
||||
<a id="PoolProperties" />
|
||||
### PoolProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| displayName | string | No | The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. |
|
||||
| vmSize | string | No | For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). |
|
||||
| deploymentConfiguration | object | No | Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS). - [DeploymentConfiguration object](#DeploymentConfiguration) |
|
||||
| scaleSettings | object | No | [ScaleSettings object](#ScaleSettings) |
|
||||
| interNodeCommunication | enum | No | This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. - Enabled or Disabled |
|
||||
| networkConfiguration | object | No | [NetworkConfiguration object](#NetworkConfiguration) |
|
||||
| maxTasksPerNode | integer | No | |
|
||||
| taskSchedulingPolicy | object | No | [TaskSchedulingPolicy object](#TaskSchedulingPolicy) |
|
||||
| userAccounts | array | No | [UserAccount object](#UserAccount) |
|
||||
| metadata | array | No | The Batch service does not assign any meaning to metadata; it is solely for the use of user code. - [MetadataItem object](#MetadataItem) |
|
||||
| startTask | object | No | In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. - [StartTask object](#StartTask) |
|
||||
| certificates | array | No | For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. - [CertificateReference object](#CertificateReference) |
|
||||
| applicationPackages | array | No | Changes to application packages affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. - [ApplicationPackageReference object](#ApplicationPackageReference) |
|
||||
| applicationLicenses | array | No | The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail. - string |
|
||||
|
||||
|
||||
<a id="DeploymentConfiguration" />
|
||||
### DeploymentConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| cloudServiceConfiguration | object | No | This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'. - [CloudServiceConfiguration object](#CloudServiceConfiguration) |
|
||||
| virtualMachineConfiguration | object | No | This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. - [VirtualMachineConfiguration object](#VirtualMachineConfiguration) |
|
||||
|
||||
|
||||
<a id="ScaleSettings" />
|
||||
### ScaleSettings object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| fixedScale | object | No | This property and autoScale are mutually exclusive and one of the properties must be specified. - [FixedScaleSettings object](#FixedScaleSettings) |
|
||||
| autoScale | object | No | This property and fixedScale are mutually exclusive and one of the properties must be specified. - [AutoScaleSettings object](#AutoScaleSettings) |
|
||||
|
||||
|
||||
<a id="NetworkConfiguration" />
|
||||
### NetworkConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| subnetId | string | No | The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes, and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. For pools created via virtualMachineConfiguration the Batch account must have poolAllocationMode userSubscription in order to use a VNet. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration |
|
||||
| endpointConfiguration | object | No | Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property. - [PoolEndpointConfiguration object](#PoolEndpointConfiguration) |
|
||||
|
||||
|
||||
<a id="TaskSchedulingPolicy" />
|
||||
### TaskSchedulingPolicy object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| nodeFillType | enum | Yes | Spread or Pack |
|
||||
|
||||
|
||||
<a id="UserAccount" />
|
||||
### UserAccount object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| password | string | Yes | |
|
||||
| elevationLevel | enum | No | nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. - NonAdmin or Admin |
|
||||
| linuxUserConfiguration | object | No | This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. - [LinuxUserConfiguration object](#LinuxUserConfiguration) |
|
||||
|
||||
|
||||
<a id="MetadataItem" />
|
||||
### MetadataItem object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| value | string | Yes | |
|
||||
|
||||
|
||||
<a id="StartTask" />
|
||||
### StartTask object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| commandLine | string | No | The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. |
|
||||
| resourceFiles | array | No | [ResourceFile object](#ResourceFile) |
|
||||
| environmentSettings | array | No | [EnvironmentSetting object](#EnvironmentSetting) |
|
||||
| userIdentity | object | No | If omitted, the task runs as a non-administrative user unique to the task. - [UserIdentity object](#UserIdentity) |
|
||||
| maxTaskRetryCount | integer | No | The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. |
|
||||
| waitForSuccess | boolean | No | If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is false. |
|
||||
|
||||
|
||||
<a id="CertificateReference" />
|
||||
### CertificateReference object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | Yes | |
|
||||
| storeLocation | enum | No | The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. - CurrentUser or LocalMachine |
|
||||
| storeName | string | No | This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My. |
|
||||
| visibility | array | No | Values are: starttask - The user account under which the start task is run. task - The accounts under which job tasks are run. remoteuser - The accounts under which users remotely access the node. You can specify more than one visibility in this collection. The default is all accounts. - StartTask, Task, RemoteUser |
|
||||
|
||||
|
||||
<a id="ApplicationPackageReference" />
|
||||
### ApplicationPackageReference object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | Yes | |
|
||||
| version | string | No | If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. |
|
||||
|
||||
|
||||
<a id="CloudServiceConfiguration" />
|
||||
### CloudServiceConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| osFamily | string | Yes | Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). |
|
||||
| targetOSVersion | string | No | The default value is * which specifies the latest operating system version for the specified OS family. |
|
||||
| currentOSVersion | string | No | This may differ from targetOSVersion if the pool state is Upgrading. In this case some virtual machines may be on the targetOSVersion and some may be on the currentOSVersion during the upgrade process. Once all virtual machines have upgraded, currentOSVersion is updated to be the same as targetOSVersion. |
|
||||
|
||||
|
||||
<a id="VirtualMachineConfiguration" />
|
||||
### VirtualMachineConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| imageReference | object | Yes | [ImageReference object](#ImageReference) |
|
||||
| osDisk | object | No | [OSDisk object](#OSDisk) |
|
||||
| nodeAgentSkuId | string | Yes | The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation. |
|
||||
| windowsConfiguration | object | No | This property must not be specified if the imageReference specifies a Linux OS image. - [WindowsConfiguration object](#WindowsConfiguration) |
|
||||
| dataDisks | array | No | This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. - [DataDisk object](#DataDisk) |
|
||||
| licenseType | string | No | This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. |
|
||||
|
||||
|
||||
<a id="FixedScaleSettings" />
|
||||
### FixedScaleSettings object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| resizeTimeout | string | No | The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). |
|
||||
| targetDedicatedNodes | integer | No | At least one of targetDedicatedNodes, targetLowPriority nodes must be set. |
|
||||
| targetLowPriorityNodes | integer | No | At least one of targetDedicatedNodes, targetLowPriority nodes must be set. |
|
||||
| nodeDeallocationOption | enum | No | If omitted, the default value is Requeue. - Requeue, Terminate, TaskCompletion, RetainedData |
|
||||
|
||||
|
||||
<a id="AutoScaleSettings" />
|
||||
### AutoScaleSettings object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| formula | string | Yes | |
|
||||
| evaluationInterval | string | No | If omitted, the default value is 15 minutes (PT15M). |
|
||||
|
||||
|
||||
<a id="PoolEndpointConfiguration" />
|
||||
### PoolEndpointConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| inboundNatPools | array | Yes | The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. - [InboundNatPool object](#InboundNatPool) |
|
||||
|
||||
|
||||
<a id="LinuxUserConfiguration" />
|
||||
### LinuxUserConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| uid | integer | No | The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. |
|
||||
| gid | integer | No | The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. |
|
||||
| sshPrivateKey | string | No | The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done). |
|
||||
|
||||
|
||||
<a id="ResourceFile" />
|
||||
### ResourceFile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| blobSource | string | Yes | This URL must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access. |
|
||||
| filePath | string | Yes | |
|
||||
| fileMode | string | No | This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. |
|
||||
|
||||
|
||||
<a id="EnvironmentSetting" />
|
||||
### EnvironmentSetting object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| value | string | No | |
|
||||
|
||||
|
||||
<a id="UserIdentity" />
|
||||
### UserIdentity object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| userName | string | No | The userName and autoUser properties are mutually exclusive; you must specify one but not both. |
|
||||
| autoUser | object | No | The userName and autoUser properties are mutually exclusive; you must specify one but not both. - [AutoUserSpecification object](#AutoUserSpecification) |
|
||||
|
||||
|
||||
<a id="ImageReference" />
|
||||
### ImageReference object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| publisher | string | No | For example, Canonical or MicrosoftWindowsServer. |
|
||||
| offer | string | No | For example, UbuntuServer or WindowsServer. |
|
||||
| sku | string | No | For example, 14.04.0-LTS or 2012-R2-Datacenter. |
|
||||
| version | string | No | A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. |
|
||||
| id | string | No | This property is mutually exclusive with other properties. The virtual machine image must be in the same region and subscription as the Azure Batch account. For information about the firewall settings for Batch node agent to communicate with Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration . |
|
||||
|
||||
|
||||
<a id="OSDisk" />
|
||||
### OSDisk object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| caching | enum | No | Default value is none. - None, ReadOnly, ReadWrite |
|
||||
|
||||
|
||||
<a id="WindowsConfiguration" />
|
||||
### WindowsConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| enableAutomaticUpdates | boolean | No | If omitted, the default value is true. |
|
||||
|
||||
|
||||
<a id="DataDisk" />
|
||||
### DataDisk object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| lun | integer | Yes | The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. |
|
||||
| caching | enum | No | Values are: none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write. The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. - None, ReadOnly, ReadWrite |
|
||||
| diskSizeGB | integer | Yes | |
|
||||
| storageAccountType | enum | No | If omitted, the default is "Standard_LRS". Values are: Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage. - Standard_LRS or Premium_LRS |
|
||||
|
||||
|
||||
<a id="InboundNatPool" />
|
||||
### InboundNatPool object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. |
|
||||
| protocol | enum | Yes | TCP or UDP |
|
||||
| backendPort | integer | Yes | This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. |
|
||||
| frontendPortRangeStart | integer | Yes | Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. |
|
||||
| frontendPortRangeEnd | integer | Yes | Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. |
|
||||
| networkSecurityGroupRules | array | No | The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. - [NetworkSecurityGroupRule object](#NetworkSecurityGroupRule) |
|
||||
|
||||
|
||||
<a id="AutoUserSpecification" />
|
||||
### AutoUserSpecification object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| scope | enum | No | pool - specifies that the task runs as the common auto user account which is created on every node in a pool. task - specifies that the service should create a new user for the task. The default value is task. - Task or Pool |
|
||||
| elevationLevel | enum | No | nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. - NonAdmin or Admin |
|
||||
|
||||
|
||||
<a id="NetworkSecurityGroupRule" />
|
||||
### NetworkSecurityGroupRule object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| priority | integer | Yes | Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 3500. If any reserved or duplicate values are provided the request fails with HTTP status code 400. |
|
||||
| access | enum | Yes | Allow or Deny |
|
||||
| sourceAddressPrefix | string | Yes | Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. |
|
||||
|
||||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -1,55 +0,0 @@
|
|||
# Microsoft.Compute/availabilitySets template reference
|
||||
API Version: 2015-06-15
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Compute/availabilitySets resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Compute/availabilitySets",
|
||||
"apiVersion": "2015-06-15",
|
||||
"location": "string",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"platformUpdateDomainCount": "integer",
|
||||
"platformFaultDomainCount": "integer",
|
||||
"virtualMachines": [
|
||||
{
|
||||
"id": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Compute/availabilitySets" />
|
||||
### Microsoft.Compute/availabilitySets object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Compute/availabilitySets |
|
||||
| apiVersion | enum | Yes | 2015-06-15 |
|
||||
| location | string | Yes | Resource location |
|
||||
| tags | object | No | Resource tags |
|
||||
| properties | object | Yes | [AvailabilitySetProperties object](#AvailabilitySetProperties) |
|
||||
|
||||
|
||||
<a id="AvailabilitySetProperties" />
|
||||
### AvailabilitySetProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| platformUpdateDomainCount | integer | No | Update Domain count. |
|
||||
| platformFaultDomainCount | integer | No | Fault Domain count. |
|
||||
| virtualMachines | array | No | A list of references to all virtual machines in the availability set. - [SubResource object](#SubResource) |
|
||||
|
||||
|
||||
<a id="SubResource" />
|
||||
### SubResource object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | No | Resource Id |
|
||||
|
||||
|
|
@ -1,409 +0,0 @@
|
|||
# Microsoft.Compute/virtualMachineScaleSets template reference
|
||||
API Version: 2015-06-15
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Compute/virtualMachineScaleSets resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Compute/virtualMachineScaleSets",
|
||||
"apiVersion": "2015-06-15",
|
||||
"location": "string",
|
||||
"tags": {},
|
||||
"sku": {
|
||||
"name": "string",
|
||||
"tier": "string",
|
||||
"capacity": "integer"
|
||||
},
|
||||
"properties": {
|
||||
"upgradePolicy": {
|
||||
"mode": "string"
|
||||
},
|
||||
"virtualMachineProfile": {
|
||||
"osProfile": {
|
||||
"computerNamePrefix": "string",
|
||||
"adminUsername": "string",
|
||||
"adminPassword": "string",
|
||||
"customData": "string",
|
||||
"windowsConfiguration": {
|
||||
"provisionVMAgent": "boolean",
|
||||
"enableAutomaticUpdates": "boolean",
|
||||
"timeZone": "string",
|
||||
"additionalUnattendContent": [
|
||||
{
|
||||
"passName": "OobeSystem",
|
||||
"componentName": "Microsoft-Windows-Shell-Setup",
|
||||
"settingName": "string",
|
||||
"content": "string"
|
||||
}
|
||||
],
|
||||
"winRM": {
|
||||
"listeners": [
|
||||
{
|
||||
"protocol": "string",
|
||||
"certificateUrl": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"linuxConfiguration": {
|
||||
"disablePasswordAuthentication": "boolean",
|
||||
"ssh": {
|
||||
"publicKeys": [
|
||||
{
|
||||
"path": "string",
|
||||
"keyData": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": [
|
||||
{
|
||||
"sourceVault": {
|
||||
"id": "string"
|
||||
},
|
||||
"vaultCertificates": [
|
||||
{
|
||||
"certificateUrl": "string",
|
||||
"certificateStore": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"storageProfile": {
|
||||
"imageReference": {
|
||||
"publisher": "string",
|
||||
"offer": "string",
|
||||
"sku": "string",
|
||||
"version": "string"
|
||||
},
|
||||
"osDisk": {
|
||||
"name": "string",
|
||||
"caching": "string",
|
||||
"createOption": "string",
|
||||
"osType": "string",
|
||||
"image": {
|
||||
"uri": "string"
|
||||
},
|
||||
"vhdContainers": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
},
|
||||
"networkProfile": {
|
||||
"networkInterfaceConfigurations": [
|
||||
{
|
||||
"id": "string",
|
||||
"name": "string",
|
||||
"properties": {
|
||||
"primary": "boolean",
|
||||
"ipConfigurations": [
|
||||
{
|
||||
"id": "string",
|
||||
"name": "string",
|
||||
"properties": {
|
||||
"subnet": {
|
||||
"id": "string"
|
||||
},
|
||||
"loadBalancerBackendAddressPools": [
|
||||
{
|
||||
"id": "string"
|
||||
}
|
||||
],
|
||||
"loadBalancerInboundNatPools": [
|
||||
{
|
||||
"id": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"extensionProfile": {
|
||||
"extensions": [
|
||||
{
|
||||
"id": "string",
|
||||
"name": "string",
|
||||
"properties": {
|
||||
"publisher": "string",
|
||||
"type": "string",
|
||||
"typeHandlerVersion": "string",
|
||||
"autoUpgradeMinorVersion": "boolean",
|
||||
"settings": {},
|
||||
"protectedSettings": {}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"provisioningState": "string",
|
||||
"overProvision": "boolean"
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Compute/virtualMachineScaleSets" />
|
||||
### Microsoft.Compute/virtualMachineScaleSets object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Compute/virtualMachineScaleSets |
|
||||
| apiVersion | enum | Yes | 2015-06-15 |
|
||||
| location | string | Yes | Resource location |
|
||||
| tags | object | No | Resource tags |
|
||||
| sku | object | No | The virtual machine scale set sku. - [Sku object](#Sku) |
|
||||
| properties | object | Yes | [VirtualMachineScaleSetProperties object](#VirtualMachineScaleSetProperties) |
|
||||
|
||||
|
||||
<a id="Sku" />
|
||||
### Sku object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | No | The sku name. |
|
||||
| tier | string | No | Specifies the tier of virtual machines in a scale set.<br /><br /> Possible Values:<br /><br /> **Standard**<br /><br /> **Basic** |
|
||||
| capacity | integer | No | Specifies the number of virtual machines in the scale set. |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetProperties" />
|
||||
### VirtualMachineScaleSetProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| upgradePolicy | object | No | The upgrade policy. - [UpgradePolicy object](#UpgradePolicy) |
|
||||
| virtualMachineProfile | object | No | The virtual machine profile. - [VirtualMachineScaleSetVMProfile object](#VirtualMachineScaleSetVMProfile) |
|
||||
| provisioningState | string | No | The provisioning state, which only appears in the response. |
|
||||
| overProvision | boolean | No | Specifies whether the Virtual Machine Scale Set should be overprovisioned. |
|
||||
|
||||
|
||||
<a id="UpgradePolicy" />
|
||||
### UpgradePolicy object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| mode | enum | No | Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> **Automatic** - All virtual machines in the scale set are automatically updated at the same time. - Automatic or Manual |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetVMProfile" />
|
||||
### VirtualMachineScaleSetVMProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| osProfile | object | No | The virtual machine scale set OS profile. - [VirtualMachineScaleSetOSProfile object](#VirtualMachineScaleSetOSProfile) |
|
||||
| storageProfile | object | No | The virtual machine scale set storage profile. - [VirtualMachineScaleSetStorageProfile object](#VirtualMachineScaleSetStorageProfile) |
|
||||
| networkProfile | object | No | The virtual machine scale set network profile. - [VirtualMachineScaleSetNetworkProfile object](#VirtualMachineScaleSetNetworkProfile) |
|
||||
| extensionProfile | object | No | The virtual machine scale set extension profile. - [VirtualMachineScaleSetExtensionProfile object](#VirtualMachineScaleSetExtensionProfile) |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetOSProfile" />
|
||||
### VirtualMachineScaleSetOSProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| computerNamePrefix | string | No | Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. |
|
||||
| adminUsername | string | No | Specifies the name of the administrator account. <br><br> **Windows-only restriction:** Cannot end in "." <br><br> **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". <br><br> **Minimum-length (Linux):** 1 character <br><br> **Max-length (Linux):** 64 characters <br><br> **Max-length (Windows):** 20 characters <br><br><li> For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)<br><li> For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) |
|
||||
| adminPassword | string | No | Specifies the password of the administrator account. <br><br> **Minimum-length (Windows):** 8 characters <br><br> **Minimum-length (Linux):** 6 characters <br><br> **Max-length (Windows):** 123 characters <br><br> **Max-length (Linux):** 72 characters <br><br> **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>Has upper characters <br> Has a digit <br> Has a special character (Regex match [\W_]) <br><br> **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" <br><br> For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) |
|
||||
| customData | string | No | A base-64 encoded string of custom data. |
|
||||
| windowsConfiguration | object | No | The Windows Configuration of the OS profile. - [WindowsConfiguration object](#WindowsConfiguration) |
|
||||
| linuxConfiguration | object | No | The Linux Configuration of the OS profile. - [LinuxConfiguration object](#LinuxConfiguration) |
|
||||
| secrets | array | No | The List of certificates for addition to the VM. - [VaultSecretGroup object](#VaultSecretGroup) |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetStorageProfile" />
|
||||
### VirtualMachineScaleSetStorageProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| imageReference | object | No | The image reference. - [ImageReference object](#ImageReference) |
|
||||
| osDisk | object | No | The OS disk. - [VirtualMachineScaleSetOSDisk object](#VirtualMachineScaleSetOSDisk) |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetNetworkProfile" />
|
||||
### VirtualMachineScaleSetNetworkProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| networkInterfaceConfigurations | array | No | The list of network configurations. - [VirtualMachineScaleSetNetworkConfiguration object](#VirtualMachineScaleSetNetworkConfiguration) |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetExtensionProfile" />
|
||||
### VirtualMachineScaleSetExtensionProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| extensions | array | No | The virtual machine scale set child extension resources. - [VirtualMachineScaleSetExtension object](#VirtualMachineScaleSetExtension) |
|
||||
|
||||
|
||||
<a id="WindowsConfiguration" />
|
||||
### WindowsConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| provisionVMAgent | boolean | No | Indicates whether virtual machine agent should be provisioned on the virtual machine. <br><br> When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. |
|
||||
| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. |
|
||||
| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" |
|
||||
| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) |
|
||||
| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) |
|
||||
|
||||
|
||||
<a id="LinuxConfiguration" />
|
||||
### LinuxConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. |
|
||||
| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) |
|
||||
|
||||
|
||||
<a id="VaultSecretGroup" />
|
||||
### VaultSecretGroup object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) |
|
||||
| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) |
|
||||
|
||||
|
||||
<a id="ImageReference" />
|
||||
### ImageReference object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| publisher | string | No | The image publisher. |
|
||||
| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. |
|
||||
| sku | string | No | The image SKU. |
|
||||
| version | string | No | Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetOSDisk" />
|
||||
### VirtualMachineScaleSetOSDisk object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | The disk name. |
|
||||
| caching | enum | No | Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite |
|
||||
| createOption | enum | Yes | Specifies how the virtual machines in the scale set should be created.<br><br> The only allowed value is: **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. - FromImage, Empty, Attach |
|
||||
| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**. - Windows or Linux |
|
||||
| image | object | No | The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist. - [VirtualHardDisk object](#VirtualHardDisk) |
|
||||
| vhdContainers | array | No | The list of virtual hard disk container uris. - string |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetNetworkConfiguration" />
|
||||
### VirtualMachineScaleSetNetworkConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | No | Resource Id |
|
||||
| name | string | Yes | The network configuration name. |
|
||||
| properties | object | No | [VirtualMachineScaleSetNetworkConfigurationProperties object](#VirtualMachineScaleSetNetworkConfigurationProperties) |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetExtension" />
|
||||
### VirtualMachineScaleSetExtension object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | No | Resource Id |
|
||||
| name | string | No | The name of the extension. |
|
||||
| properties | object | No | [VirtualMachineScaleSetExtensionProperties object](#VirtualMachineScaleSetExtensionProperties) |
|
||||
|
||||
|
||||
<a id="AdditionalUnattendContent" />
|
||||
### AdditionalUnattendContent object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem |
|
||||
| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup |
|
||||
| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands |
|
||||
| content | string | No | Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. |
|
||||
|
||||
|
||||
<a id="WinRMConfiguration" />
|
||||
### WinRMConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) |
|
||||
|
||||
|
||||
<a id="SshConfiguration" />
|
||||
### SshConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) |
|
||||
|
||||
|
||||
<a id="SubResource" />
|
||||
### SubResource object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | No | Resource Id |
|
||||
|
||||
|
||||
<a id="VaultCertificate" />
|
||||
### VaultCertificate object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| certificateUrl | string | No | This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> "data":"<Base64-encoded-certificate>",<br> "dataType":"pfx",<br> "password":"<pfx-file-password>"<br>} |
|
||||
| certificateStore | string | No | For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. <br><br>For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbpring>.prv for private key. Both of these files are .pem formatted. |
|
||||
|
||||
|
||||
<a id="VirtualHardDisk" />
|
||||
### VirtualHardDisk object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| uri | string | No | Specifies the virtual hard disk's uri. |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetNetworkConfigurationProperties" />
|
||||
### VirtualMachineScaleSetNetworkConfigurationProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| primary | boolean | No | Whether this is a primary NIC on a virtual machine. |
|
||||
| ipConfigurations | array | Yes | The virtual machine scale set IP Configuration. - [VirtualMachineScaleSetIPConfiguration object](#VirtualMachineScaleSetIPConfiguration) |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetExtensionProperties" />
|
||||
### VirtualMachineScaleSetExtensionProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| publisher | string | No | The name of the extension handler publisher. |
|
||||
| type | string | No | The type of the extension handler. |
|
||||
| typeHandlerVersion | string | No | The type version of the extension handler. |
|
||||
| autoUpgradeMinorVersion | boolean | No | Whether the extension handler should be automatically upgraded across minor versions. |
|
||||
| settings | object | No | Json formatted public settings for the extension. |
|
||||
| protectedSettings | object | No | Json formatted protected settings for the extension. |
|
||||
|
||||
|
||||
<a id="WinRMListener" />
|
||||
### WinRMListener object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| protocol | enum | No | Specifies the protocol of listener. <br><br> Possible values are: <br>**http** <br><br> **https**. - Http or Https |
|
||||
| certificateUrl | string | No | This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> "data":"<Base64-encoded-certificate>",<br> "dataType":"pfx",<br> "password":"<pfx-file-password>"<br>} |
|
||||
|
||||
|
||||
<a id="SshPublicKey" />
|
||||
### SshPublicKey object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| path | string | No | Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys |
|
||||
| keyData | string | No | SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. <br><br> For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetIPConfiguration" />
|
||||
### VirtualMachineScaleSetIPConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | No | Resource Id |
|
||||
| name | string | Yes | The IP configuration name. |
|
||||
| properties | object | No | [VirtualMachineScaleSetIPConfigurationProperties object](#VirtualMachineScaleSetIPConfigurationProperties) |
|
||||
|
||||
|
||||
<a id="VirtualMachineScaleSetIPConfigurationProperties" />
|
||||
### VirtualMachineScaleSetIPConfigurationProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| subnet | object | Yes | The subnet. - [ApiEntityReference object](#ApiEntityReference) |
|
||||
| loadBalancerBackendAddressPools | array | No | The load balancer backend address pools. - [SubResource object](#SubResource) |
|
||||
| loadBalancerInboundNatPools | array | No | The load balancer inbound nat pools. - [SubResource object](#SubResource) |
|
||||
|
||||
|
||||
<a id="ApiEntityReference" />
|
||||
### ApiEntityReference object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | No | The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... |
|
||||
|
||||
|
|
@ -1,406 +0,0 @@
|
|||
# Microsoft.Compute/virtualMachines template reference
|
||||
API Version: 2015-06-15
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Compute/virtualMachines resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Compute/virtualMachines",
|
||||
"apiVersion": "2015-06-15",
|
||||
"location": "string",
|
||||
"tags": {},
|
||||
"plan": {
|
||||
"name": "string",
|
||||
"publisher": "string",
|
||||
"product": "string",
|
||||
"promotionCode": "string"
|
||||
},
|
||||
"properties": {
|
||||
"hardwareProfile": {
|
||||
"vmSize": "string"
|
||||
},
|
||||
"storageProfile": {
|
||||
"imageReference": {
|
||||
"publisher": "string",
|
||||
"offer": "string",
|
||||
"sku": "string",
|
||||
"version": "string"
|
||||
},
|
||||
"osDisk": {
|
||||
"osType": "string",
|
||||
"encryptionSettings": {
|
||||
"diskEncryptionKey": {
|
||||
"secretUrl": "string",
|
||||
"sourceVault": {
|
||||
"id": "string"
|
||||
}
|
||||
},
|
||||
"keyEncryptionKey": {
|
||||
"keyUrl": "string",
|
||||
"sourceVault": {
|
||||
"id": "string"
|
||||
}
|
||||
},
|
||||
"enabled": "boolean"
|
||||
},
|
||||
"name": "string",
|
||||
"vhd": {
|
||||
"uri": "string"
|
||||
},
|
||||
"image": {
|
||||
"uri": "string"
|
||||
},
|
||||
"caching": "string",
|
||||
"createOption": "string",
|
||||
"diskSizeGB": "integer"
|
||||
},
|
||||
"dataDisks": [
|
||||
{
|
||||
"lun": "integer",
|
||||
"name": "string",
|
||||
"vhd": {
|
||||
"uri": "string"
|
||||
},
|
||||
"image": {
|
||||
"uri": "string"
|
||||
},
|
||||
"caching": "string",
|
||||
"createOption": "string",
|
||||
"diskSizeGB": "integer"
|
||||
}
|
||||
]
|
||||
},
|
||||
"osProfile": {
|
||||
"computerName": "string",
|
||||
"adminUsername": "string",
|
||||
"adminPassword": "string",
|
||||
"customData": "string",
|
||||
"windowsConfiguration": {
|
||||
"provisionVMAgent": "boolean",
|
||||
"enableAutomaticUpdates": "boolean",
|
||||
"timeZone": "string",
|
||||
"additionalUnattendContent": [
|
||||
{
|
||||
"passName": "OobeSystem",
|
||||
"componentName": "Microsoft-Windows-Shell-Setup",
|
||||
"settingName": "string",
|
||||
"content": "string"
|
||||
}
|
||||
],
|
||||
"winRM": {
|
||||
"listeners": [
|
||||
{
|
||||
"protocol": "string",
|
||||
"certificateUrl": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"linuxConfiguration": {
|
||||
"disablePasswordAuthentication": "boolean",
|
||||
"ssh": {
|
||||
"publicKeys": [
|
||||
{
|
||||
"path": "string",
|
||||
"keyData": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"secrets": [
|
||||
{
|
||||
"sourceVault": {
|
||||
"id": "string"
|
||||
},
|
||||
"vaultCertificates": [
|
||||
{
|
||||
"certificateUrl": "string",
|
||||
"certificateStore": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"networkProfile": {
|
||||
"networkInterfaces": [
|
||||
{
|
||||
"id": "string",
|
||||
"properties": {
|
||||
"primary": "boolean"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"diagnosticsProfile": {
|
||||
"bootDiagnostics": {
|
||||
"enabled": "boolean",
|
||||
"storageUri": "string"
|
||||
}
|
||||
},
|
||||
"availabilitySet": {
|
||||
"id": "string"
|
||||
},
|
||||
"licenseType": "string"
|
||||
},
|
||||
"resources": []
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Compute/virtualMachines" />
|
||||
### Microsoft.Compute/virtualMachines object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Compute/virtualMachines |
|
||||
| apiVersion | enum | Yes | 2015-06-15 |
|
||||
| location | string | Yes | Resource location |
|
||||
| tags | object | No | Resource tags |
|
||||
| plan | object | No | Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. - [Plan object](#Plan) |
|
||||
| properties | object | Yes | [VirtualMachineProperties object](#VirtualMachineProperties) |
|
||||
| resources | array | No | [extensions](./virtualMachines/extensions.md) |
|
||||
|
||||
|
||||
<a id="Plan" />
|
||||
### Plan object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | No | The plan ID. |
|
||||
| publisher | string | No | The publisher ID. |
|
||||
| product | string | No | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. |
|
||||
| promotionCode | string | No | The promotion code. |
|
||||
|
||||
|
||||
<a id="VirtualMachineProperties" />
|
||||
### VirtualMachineProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| hardwareProfile | object | No | Specifies the hardware settings for the virtual machine. - [HardwareProfile object](#HardwareProfile) |
|
||||
| storageProfile | object | No | Specifies the storage settings for the virtual machine disks. - [StorageProfile object](#StorageProfile) |
|
||||
| osProfile | object | No | Specifies the operating system settings for the virtual machine. - [OSProfile object](#OSProfile) |
|
||||
| networkProfile | object | No | Specifies the network interfaces of the virtual machine. - [NetworkProfile object](#NetworkProfile) |
|
||||
| diagnosticsProfile | object | No | Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15. - [DiagnosticsProfile object](#DiagnosticsProfile) |
|
||||
| availabilitySet | object | No | Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. - [SubResource object](#SubResource) |
|
||||
| licenseType | string | No | Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system. <br><br> Possible values are: <br><br> Windows_Client <br><br> Windows_Server <br><br> If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Minimum api-version: 2015-06-15 |
|
||||
|
||||
|
||||
<a id="HardwareProfile" />
|
||||
### HardwareProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| vmSize | enum | No | Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> The available VM sizes depend on region and availability set. For a list of available sizes use these APIs: <br><br> [List all available virtual machine sizes in an availability set](virtualmachines-list-sizes-availability-set.md) <br><br> [List all available virtual machine sizes in a region](virtualmachines-list-sizes-region.md) <br><br> [List all available virtual machine sizes for resizing](virtualmachines-list-sizes-for-resizing.md). - Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5 |
|
||||
|
||||
|
||||
<a id="StorageProfile" />
|
||||
### StorageProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| imageReference | object | No | Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. - [ImageReference object](#ImageReference) |
|
||||
| osDisk | object | No | Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - [OSDisk object](#OSDisk) |
|
||||
| dataDisks | array | No | Specifies the parameters that are used to add a data disk to a virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - [DataDisk object](#DataDisk) |
|
||||
|
||||
|
||||
<a id="OSProfile" />
|
||||
### OSProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| computerName | string | No | Specifies the host OS name of the virtual machine. <br><br> **Max-length (Windows):** 15 characters <br><br> **Max-length (Linux):** 64 characters. <br><br> For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). |
|
||||
| adminUsername | string | No | Specifies the name of the administrator account. <br><br> **Windows-only restriction:** Cannot end in "." <br><br> **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". <br><br> **Minimum-length (Linux):** 1 character <br><br> **Max-length (Linux):** 64 characters <br><br> **Max-length (Windows):** 20 characters <br><br><li> For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)<br><li> For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) |
|
||||
| adminPassword | string | No | Specifies the password of the administrator account. <br><br> **Minimum-length (Windows):** 8 characters <br><br> **Minimum-length (Linux):** 6 characters <br><br> **Max-length (Windows):** 123 characters <br><br> **Max-length (Linux):** 72 characters <br><br> **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>Has upper characters <br> Has a digit <br> Has a special character (Regex match [\W_]) <br><br> **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" <br><br> For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password) |
|
||||
| customData | string | No | Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. <br><br> For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) |
|
||||
| windowsConfiguration | object | No | Specifies Windows operating system settings on the virtual machine. - [WindowsConfiguration object](#WindowsConfiguration) |
|
||||
| linuxConfiguration | object | No | Specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) <br><br> For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - [LinuxConfiguration object](#LinuxConfiguration) |
|
||||
| secrets | array | No | Specifies set of certificates that should be installed onto the virtual machine. - [VaultSecretGroup object](#VaultSecretGroup) |
|
||||
|
||||
|
||||
<a id="NetworkProfile" />
|
||||
### NetworkProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| networkInterfaces | array | No | Specifies the list of resource Ids for the network interfaces associated with the virtual machine. - [NetworkInterfaceReference object](#NetworkInterfaceReference) |
|
||||
|
||||
|
||||
<a id="DiagnosticsProfile" />
|
||||
### DiagnosticsProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| bootDiagnostics | object | No | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> For Linux Virtual Machines, you can easily view the output of your console log. <br><br> For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor. - [BootDiagnostics object](#BootDiagnostics) |
|
||||
|
||||
|
||||
<a id="SubResource" />
|
||||
### SubResource object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | No | Resource Id |
|
||||
|
||||
|
||||
<a id="ImageReference" />
|
||||
### ImageReference object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| publisher | string | No | The image publisher. |
|
||||
| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. |
|
||||
| sku | string | No | The image SKU. |
|
||||
| version | string | No | Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. |
|
||||
|
||||
|
||||
<a id="OSDisk" />
|
||||
### OSDisk object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**. - Windows or Linux |
|
||||
| encryptionSettings | object | No | Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15 - [DiskEncryptionSettings object](#DiskEncryptionSettings) |
|
||||
| name | string | Yes | The disk name. |
|
||||
| vhd | object | Yes | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) |
|
||||
| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) |
|
||||
| caching | enum | No | Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite |
|
||||
| createOption | enum | Yes | Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. - FromImage, Empty, Attach |
|
||||
| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB |
|
||||
|
||||
|
||||
<a id="DataDisk" />
|
||||
### DataDisk object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| lun | integer | Yes | Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. |
|
||||
| name | string | Yes | The disk name. |
|
||||
| vhd | object | Yes | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) |
|
||||
| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) |
|
||||
| caching | enum | No | Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite |
|
||||
| createOption | enum | Yes | Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. - FromImage, Empty, Attach |
|
||||
| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB |
|
||||
|
||||
|
||||
<a id="WindowsConfiguration" />
|
||||
### WindowsConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| provisionVMAgent | boolean | No | Indicates whether virtual machine agent should be provisioned on the virtual machine. <br><br> When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. |
|
||||
| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. |
|
||||
| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" |
|
||||
| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) |
|
||||
| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) |
|
||||
|
||||
|
||||
<a id="LinuxConfiguration" />
|
||||
### LinuxConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. |
|
||||
| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) |
|
||||
|
||||
|
||||
<a id="VaultSecretGroup" />
|
||||
### VaultSecretGroup object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) |
|
||||
| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) |
|
||||
|
||||
|
||||
<a id="NetworkInterfaceReference" />
|
||||
### NetworkInterfaceReference object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | No | Resource Id |
|
||||
| properties | object | No | [NetworkInterfaceReferenceProperties object](#NetworkInterfaceReferenceProperties) |
|
||||
|
||||
|
||||
<a id="BootDiagnostics" />
|
||||
### BootDiagnostics object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| enabled | boolean | No | Whether boot diagnostics should be enabled on the Virtual Machine. |
|
||||
| storageUri | string | No | Uri of the storage account to use for placing the console output and screenshot. |
|
||||
|
||||
|
||||
<a id="DiskEncryptionSettings" />
|
||||
### DiskEncryptionSettings object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| diskEncryptionKey | object | Yes | Specifies the location of the disk encryption key, which is a Key Vault Secret. - [KeyVaultSecretReference object](#KeyVaultSecretReference) |
|
||||
| keyEncryptionKey | object | No | Specifies the location of the key encryption key in Key Vault. - [KeyVaultKeyReference object](#KeyVaultKeyReference) |
|
||||
| enabled | boolean | No | Specifies whether disk encryption should be enabled on the virtual machine. |
|
||||
|
||||
|
||||
<a id="VirtualHardDisk" />
|
||||
### VirtualHardDisk object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| uri | string | No | Specifies the virtual hard disk's uri. |
|
||||
|
||||
|
||||
<a id="AdditionalUnattendContent" />
|
||||
### AdditionalUnattendContent object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem |
|
||||
| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup |
|
||||
| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands |
|
||||
| content | string | No | Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. |
|
||||
|
||||
|
||||
<a id="WinRMConfiguration" />
|
||||
### WinRMConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) |
|
||||
|
||||
|
||||
<a id="SshConfiguration" />
|
||||
### SshConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) |
|
||||
|
||||
|
||||
<a id="VaultCertificate" />
|
||||
### VaultCertificate object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| certificateUrl | string | No | This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> "data":"<Base64-encoded-certificate>",<br> "dataType":"pfx",<br> "password":"<pfx-file-password>"<br>} |
|
||||
| certificateStore | string | No | For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. <br><br>For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbpring>.prv for private key. Both of these files are .pem formatted. |
|
||||
|
||||
|
||||
<a id="NetworkInterfaceReferenceProperties" />
|
||||
### NetworkInterfaceReferenceProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| primary | boolean | No | Specifies the primary network interface in case the virtual machine has more than 1 network interface. |
|
||||
|
||||
|
||||
<a id="KeyVaultSecretReference" />
|
||||
### KeyVaultSecretReference object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| secretUrl | string | Yes | The URL referencing a secret in a Key Vault. |
|
||||
| sourceVault | object | Yes | The relative URL of the Key Vault containing the secret. - [SubResource object](#SubResource) |
|
||||
|
||||
|
||||
<a id="KeyVaultKeyReference" />
|
||||
### KeyVaultKeyReference object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| keyUrl | string | Yes | The URL referencing a key encryption key in Key Vault. |
|
||||
| sourceVault | object | Yes | The relative URL of the Key Vault containing the key. - [SubResource object](#SubResource) |
|
||||
|
||||
|
||||
<a id="WinRMListener" />
|
||||
### WinRMListener object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| protocol | enum | No | Specifies the protocol of listener. <br><br> Possible values are: <br>**http** <br><br> **https**. - Http or Https |
|
||||
| certificateUrl | string | No | This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> "data":"<Base64-encoded-certificate>",<br> "dataType":"pfx",<br> "password":"<pfx-file-password>"<br>} |
|
||||
|
||||
|
||||
<a id="SshPublicKey" />
|
||||
### SshPublicKey object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| path | string | No | Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys |
|
||||
| keyData | string | No | SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. <br><br> For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). |
|
||||
|
||||
|
|
@ -1,98 +0,0 @@
|
|||
# Microsoft.Compute/virtualMachines/extensions template reference
|
||||
API Version: 2015-06-15
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Compute/virtualMachines/extensions resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Compute/virtualMachines/extensions",
|
||||
"apiVersion": "2015-06-15",
|
||||
"location": "string",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"forceUpdateTag": "string",
|
||||
"publisher": "string",
|
||||
"type": "string",
|
||||
"typeHandlerVersion": "string",
|
||||
"autoUpgradeMinorVersion": "boolean",
|
||||
"settings": {},
|
||||
"protectedSettings": {},
|
||||
"instanceView": {
|
||||
"name": "string",
|
||||
"type": "string",
|
||||
"typeHandlerVersion": "string",
|
||||
"substatuses": [
|
||||
{
|
||||
"code": "string",
|
||||
"level": "string",
|
||||
"displayStatus": "string",
|
||||
"message": "string",
|
||||
"time": "string"
|
||||
}
|
||||
],
|
||||
"statuses": [
|
||||
{
|
||||
"code": "string",
|
||||
"level": "string",
|
||||
"displayStatus": "string",
|
||||
"message": "string",
|
||||
"time": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Compute/virtualMachines/extensions" />
|
||||
### Microsoft.Compute/virtualMachines/extensions object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Compute/virtualMachines/extensions |
|
||||
| apiVersion | enum | Yes | 2015-06-15 |
|
||||
| location | string | Yes | Resource location |
|
||||
| tags | object | No | Resource tags |
|
||||
| properties | object | Yes | [VirtualMachineExtensionProperties object](#VirtualMachineExtensionProperties) |
|
||||
|
||||
|
||||
<a id="VirtualMachineExtensionProperties" />
|
||||
### VirtualMachineExtensionProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| forceUpdateTag | string | No | How the extension handler should be forced to update even if the extension configuration has not changed. |
|
||||
| publisher | string | No | The name of the extension handler publisher. |
|
||||
| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". |
|
||||
| typeHandlerVersion | string | No | Specifies the version of the script handler. |
|
||||
| autoUpgradeMinorVersion | boolean | No | Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. |
|
||||
| settings | object | No | Json formatted public settings for the extension. |
|
||||
| protectedSettings | object | No | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
|
||||
| instanceView | object | No | The virtual machine extension instance view. - [VirtualMachineExtensionInstanceView object](#VirtualMachineExtensionInstanceView) |
|
||||
|
||||
|
||||
<a id="VirtualMachineExtensionInstanceView" />
|
||||
### VirtualMachineExtensionInstanceView object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | No | The virtual machine extension name. |
|
||||
| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". |
|
||||
| typeHandlerVersion | string | No | Specifies the version of the script handler. |
|
||||
| substatuses | array | No | The resource status information. - [InstanceViewStatus object](#InstanceViewStatus) |
|
||||
| statuses | array | No | The resource status information. - [InstanceViewStatus object](#InstanceViewStatus) |
|
||||
|
||||
|
||||
<a id="InstanceViewStatus" />
|
||||
### InstanceViewStatus object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| code | string | No | The status code. |
|
||||
| level | enum | No | The level code. - Info, Warning, Error |
|
||||
| displayStatus | string | No | The short localizable label for the status. |
|
||||
| message | string | No | The detailed status message, including for alerts and error messages. |
|
||||
| time | string | No | The time of the status. |
|
||||
|
||||
|
|
@ -1,393 +0,0 @@
|
|||
{
|
||||
"id": "https://schema.management.azure.com/schemas/2015-11-01-preview/Microsoft.ContainerService.json#",
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "Microsoft.ContainerService",
|
||||
"description": "Microsoft ContainerService Resource Types",
|
||||
"resourceDefinitions": {
|
||||
"containerServices": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.ContainerService/containerServices"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2015-11-01-preview"
|
||||
]
|
||||
},
|
||||
"location": {
|
||||
"type": "string",
|
||||
"description": "Resource location"
|
||||
},
|
||||
"tags": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"properties": {}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Resource tags"
|
||||
},
|
||||
"properties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion",
|
||||
"location",
|
||||
"properties"
|
||||
],
|
||||
"description": "Microsoft.ContainerService/containerServices"
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"ContainerServiceAgentPoolProfile": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Unique name of the agent pool profile within the context of the subscription and resource group"
|
||||
},
|
||||
"count": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 100
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "No. of agents (VMs) that will host docker containers"
|
||||
},
|
||||
"vmSize": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Standard_A0",
|
||||
"Standard_A1",
|
||||
"Standard_A2",
|
||||
"Standard_A3",
|
||||
"Standard_A4",
|
||||
"Standard_A5",
|
||||
"Standard_A6",
|
||||
"Standard_A7",
|
||||
"Standard_A8",
|
||||
"Standard_A9",
|
||||
"Standard_A10",
|
||||
"Standard_A11",
|
||||
"Standard_D1",
|
||||
"Standard_D2",
|
||||
"Standard_D3",
|
||||
"Standard_D4",
|
||||
"Standard_D11",
|
||||
"Standard_D12",
|
||||
"Standard_D13",
|
||||
"Standard_D14",
|
||||
"Standard_D1_v2",
|
||||
"Standard_D2_v2",
|
||||
"Standard_D3_v2",
|
||||
"Standard_D4_v2",
|
||||
"Standard_D5_v2",
|
||||
"Standard_D11_v2",
|
||||
"Standard_D12_v2",
|
||||
"Standard_D13_v2",
|
||||
"Standard_D14_v2",
|
||||
"Standard_G1",
|
||||
"Standard_G2",
|
||||
"Standard_G3",
|
||||
"Standard_G4",
|
||||
"Standard_G5",
|
||||
"Standard_DS1",
|
||||
"Standard_DS2",
|
||||
"Standard_DS3",
|
||||
"Standard_DS4",
|
||||
"Standard_DS11",
|
||||
"Standard_DS12",
|
||||
"Standard_DS13",
|
||||
"Standard_DS14",
|
||||
"Standard_GS1",
|
||||
"Standard_GS2",
|
||||
"Standard_GS3",
|
||||
"Standard_GS4",
|
||||
"Standard_GS5"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Size of agent VMs."
|
||||
},
|
||||
"dnsPrefix": {
|
||||
"type": "string",
|
||||
"description": "DNS prefix to be used to create FQDN for this agent pool"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"dnsPrefix"
|
||||
],
|
||||
"description": "Profile for container service agent pool"
|
||||
},
|
||||
"ContainerServiceDiagnosticsProfile": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"vmDiagnostics": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceVMDiagnostics"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Profile for container service VM diagnostic agent"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContainerServiceLinuxProfile": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"adminUsername": {
|
||||
"type": "string",
|
||||
"description": "The administrator username to use for all Linux VMs"
|
||||
},
|
||||
"ssh": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceSshConfiguration"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Specifies the ssh key configuration for Linux VMs"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"adminUsername",
|
||||
"ssh"
|
||||
],
|
||||
"description": "Profile for Linux VM"
|
||||
},
|
||||
"ContainerServiceMasterProfile": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"count": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "integer"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Number of masters (VMs) in the container cluster"
|
||||
},
|
||||
"dnsPrefix": {
|
||||
"type": "string",
|
||||
"description": "DNS prefix to be used to create FQDN for master"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"dnsPrefix"
|
||||
],
|
||||
"description": "Profile for container service master"
|
||||
},
|
||||
"ContainerServiceOrchestratorProfile": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"orchestratorType": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Mesos",
|
||||
"SwarmPreview",
|
||||
"DCOS"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Specifies what orchestrator will be used to manage container cluster resources."
|
||||
}
|
||||
},
|
||||
"description": "Profile for Orchestrator"
|
||||
},
|
||||
"ContainerServiceProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"orchestratorProfile": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceOrchestratorProfile"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of orchestrator"
|
||||
},
|
||||
"masterProfile": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceMasterProfile"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of master agents"
|
||||
},
|
||||
"agentPoolProfiles": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ContainerServiceAgentPoolProfile"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of agent pools"
|
||||
},
|
||||
"windowsProfile": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceWindowsProfile"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of Windows VMs"
|
||||
},
|
||||
"linuxProfile": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceLinuxProfile"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties for Linux VMs"
|
||||
},
|
||||
"diagnosticsProfile": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceDiagnosticsProfile"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties for Diagnostic Agent"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"masterProfile",
|
||||
"agentPoolProfiles",
|
||||
"linuxProfile"
|
||||
],
|
||||
"description": "Properties of container service"
|
||||
},
|
||||
"ContainerServiceSshConfiguration": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"publicKeys": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ContainerServiceSshPublicKey"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Gets or sets the list of SSH public keys used to authenticate with Linux based VMs"
|
||||
}
|
||||
},
|
||||
"description": "SSH configuration for Linux based VMs running on Azure"
|
||||
},
|
||||
"ContainerServiceSshPublicKey": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"keyData": {
|
||||
"type": "string",
|
||||
"description": "Gets or sets Certificate public key used to authenticate with VM through SSH. The certificate must be in Pem format with or without headers."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"keyData"
|
||||
],
|
||||
"description": "Contains information about SSH certificate public key data."
|
||||
},
|
||||
"ContainerServiceVMDiagnostics": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Gets or sets whether VM Diagnostic Agent should be provisioned on the Virtual Machine."
|
||||
}
|
||||
},
|
||||
"description": "Describes VM Diagnostics."
|
||||
},
|
||||
"ContainerServiceWindowsProfile": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"adminUsername": {
|
||||
"type": "string",
|
||||
"description": "The administrator username to use for Windows jumpbox"
|
||||
},
|
||||
"adminPassword": {
|
||||
"type": "string",
|
||||
"description": "The administrator password to use for Windows jumpbox"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"adminUsername",
|
||||
"adminPassword"
|
||||
],
|
||||
"description": "Profile for Windows jumpbox"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,147 +0,0 @@
|
|||
# Microsoft.ContainerService/containerServices template reference
|
||||
API Version: 2015-11-01-preview
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.ContainerService/containerServices resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.ContainerService/containerServices",
|
||||
"apiVersion": "2015-11-01-preview",
|
||||
"location": "string",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"orchestratorProfile": {
|
||||
"orchestratorType": "string"
|
||||
},
|
||||
"masterProfile": {
|
||||
"count": "integer",
|
||||
"dnsPrefix": "string"
|
||||
},
|
||||
"agentPoolProfiles": [
|
||||
{
|
||||
"name": "string",
|
||||
"count": "integer",
|
||||
"vmSize": "string",
|
||||
"dnsPrefix": "string"
|
||||
}
|
||||
],
|
||||
"windowsProfile": {
|
||||
"adminUsername": "string",
|
||||
"adminPassword": "string"
|
||||
},
|
||||
"linuxProfile": {
|
||||
"adminUsername": "string",
|
||||
"ssh": {
|
||||
"publicKeys": [
|
||||
{
|
||||
"keyData": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"diagnosticsProfile": {
|
||||
"vmDiagnostics": {
|
||||
"enabled": "boolean"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.ContainerService/containerServices" />
|
||||
### Microsoft.ContainerService/containerServices object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.ContainerService/containerServices |
|
||||
| apiVersion | enum | Yes | 2015-11-01-preview |
|
||||
| location | string | Yes | Resource location |
|
||||
| tags | object | No | Resource tags |
|
||||
| properties | object | Yes | [ContainerServiceProperties object](#ContainerServiceProperties) |
|
||||
|
||||
|
||||
<a id="ContainerServiceProperties" />
|
||||
### ContainerServiceProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| orchestratorProfile | object | No | Properties of orchestrator - [ContainerServiceOrchestratorProfile object](#ContainerServiceOrchestratorProfile) |
|
||||
| masterProfile | object | Yes | Properties of master agents - [ContainerServiceMasterProfile object](#ContainerServiceMasterProfile) |
|
||||
| agentPoolProfiles | array | Yes | Properties of agent pools - [ContainerServiceAgentPoolProfile object](#ContainerServiceAgentPoolProfile) |
|
||||
| windowsProfile | object | No | Properties of Windows VMs - [ContainerServiceWindowsProfile object](#ContainerServiceWindowsProfile) |
|
||||
| linuxProfile | object | Yes | Properties for Linux VMs - [ContainerServiceLinuxProfile object](#ContainerServiceLinuxProfile) |
|
||||
| diagnosticsProfile | object | No | Properties for Diagnostic Agent - [ContainerServiceDiagnosticsProfile object](#ContainerServiceDiagnosticsProfile) |
|
||||
|
||||
|
||||
<a id="ContainerServiceOrchestratorProfile" />
|
||||
### ContainerServiceOrchestratorProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| orchestratorType | enum | No | Specifies what orchestrator will be used to manage container cluster resources. - Mesos, SwarmPreview, DCOS |
|
||||
|
||||
|
||||
<a id="ContainerServiceMasterProfile" />
|
||||
### ContainerServiceMasterProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| count | integer | No | Number of masters (VMs) in the container cluster |
|
||||
| dnsPrefix | string | Yes | DNS prefix to be used to create FQDN for master |
|
||||
|
||||
|
||||
<a id="ContainerServiceAgentPoolProfile" />
|
||||
### ContainerServiceAgentPoolProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | Unique name of the agent pool profile within the context of the subscription and resource group |
|
||||
| count | integer | No | No. of agents (VMs) that will host docker containers |
|
||||
| vmSize | enum | No | Size of agent VMs. - Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5 |
|
||||
| dnsPrefix | string | Yes | DNS prefix to be used to create FQDN for this agent pool |
|
||||
|
||||
|
||||
<a id="ContainerServiceWindowsProfile" />
|
||||
### ContainerServiceWindowsProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| adminUsername | string | Yes | The administrator username to use for Windows jumpbox |
|
||||
| adminPassword | string | Yes | The administrator password to use for Windows jumpbox |
|
||||
|
||||
|
||||
<a id="ContainerServiceLinuxProfile" />
|
||||
### ContainerServiceLinuxProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| adminUsername | string | Yes | The administrator username to use for all Linux VMs |
|
||||
| ssh | object | Yes | Specifies the ssh key configuration for Linux VMs - [ContainerServiceSshConfiguration object](#ContainerServiceSshConfiguration) |
|
||||
|
||||
|
||||
<a id="ContainerServiceDiagnosticsProfile" />
|
||||
### ContainerServiceDiagnosticsProfile object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| vmDiagnostics | object | No | Profile for container service VM diagnostic agent - [ContainerServiceVMDiagnostics object](#ContainerServiceVMDiagnostics) |
|
||||
|
||||
|
||||
<a id="ContainerServiceSshConfiguration" />
|
||||
### ContainerServiceSshConfiguration object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| publicKeys | array | No | Gets or sets the list of SSH public keys used to authenticate with Linux based VMs - [ContainerServiceSshPublicKey object](#ContainerServiceSshPublicKey) |
|
||||
|
||||
|
||||
<a id="ContainerServiceVMDiagnostics" />
|
||||
### ContainerServiceVMDiagnostics object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| enabled | boolean | No | Gets or sets whether VM Diagnostic Agent should be provisioned on the Virtual Machine. |
|
||||
|
||||
|
||||
<a id="ContainerServiceSshPublicKey" />
|
||||
### ContainerServiceSshPublicKey object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| keyData | string | Yes | Gets or sets Certificate public key used to authenticate with VM through SSH. The certificate must be in Pem format with or without headers. |
|
||||
|
||||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -1,406 +0,0 @@
|
|||
{
|
||||
"id": "https://schema.management.azure.com/schemas/2016-03-30/Microsoft.ContainerService.json#",
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "Microsoft.ContainerService",
|
||||
"description": "Microsoft ContainerService Resource Types",
|
||||
"resourceDefinitions": {
|
||||
"containerServices": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Microsoft.ContainerService/containerServices"
|
||||
]
|
||||
},
|
||||
"apiVersion": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"2016-03-30"
|
||||
]
|
||||
},
|
||||
"location": {
|
||||
"type": "string",
|
||||
"description": "Resource location"
|
||||
},
|
||||
"tags": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"properties": {}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Resource tags"
|
||||
},
|
||||
"properties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceProperties"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"type",
|
||||
"apiVersion",
|
||||
"location",
|
||||
"properties"
|
||||
],
|
||||
"description": "Microsoft.ContainerService/containerServices"
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"ContainerServiceAgentPoolProfile": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Unique name of the agent pool profile in the context of the subscription and resource group."
|
||||
},
|
||||
"count": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 100
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. "
|
||||
},
|
||||
"vmSize": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Standard_A0",
|
||||
"Standard_A1",
|
||||
"Standard_A2",
|
||||
"Standard_A3",
|
||||
"Standard_A4",
|
||||
"Standard_A5",
|
||||
"Standard_A6",
|
||||
"Standard_A7",
|
||||
"Standard_A8",
|
||||
"Standard_A9",
|
||||
"Standard_A10",
|
||||
"Standard_A11",
|
||||
"Standard_D1",
|
||||
"Standard_D2",
|
||||
"Standard_D3",
|
||||
"Standard_D4",
|
||||
"Standard_D11",
|
||||
"Standard_D12",
|
||||
"Standard_D13",
|
||||
"Standard_D14",
|
||||
"Standard_D1_v2",
|
||||
"Standard_D2_v2",
|
||||
"Standard_D3_v2",
|
||||
"Standard_D4_v2",
|
||||
"Standard_D5_v2",
|
||||
"Standard_D11_v2",
|
||||
"Standard_D12_v2",
|
||||
"Standard_D13_v2",
|
||||
"Standard_D14_v2",
|
||||
"Standard_G1",
|
||||
"Standard_G2",
|
||||
"Standard_G3",
|
||||
"Standard_G4",
|
||||
"Standard_G5",
|
||||
"Standard_DS1",
|
||||
"Standard_DS2",
|
||||
"Standard_DS3",
|
||||
"Standard_DS4",
|
||||
"Standard_DS11",
|
||||
"Standard_DS12",
|
||||
"Standard_DS13",
|
||||
"Standard_DS14",
|
||||
"Standard_GS1",
|
||||
"Standard_GS2",
|
||||
"Standard_GS3",
|
||||
"Standard_GS4",
|
||||
"Standard_GS5"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Size of agent VMs."
|
||||
},
|
||||
"dnsPrefix": {
|
||||
"type": "string",
|
||||
"description": "DNS prefix to be used to create the FQDN for the agent pool."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"vmSize",
|
||||
"dnsPrefix"
|
||||
],
|
||||
"description": "Profile for the container service agent pool."
|
||||
},
|
||||
"ContainerServiceDiagnosticsProfile": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"vmDiagnostics": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceVMDiagnostics"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Profile for the container service VM diagnostic agent."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"vmDiagnostics"
|
||||
]
|
||||
},
|
||||
"ContainerServiceLinuxProfile": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"adminUsername": {
|
||||
"type": "string",
|
||||
"description": "The administrator username to use for all Linux VMs"
|
||||
},
|
||||
"ssh": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceSshConfiguration"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The ssh key configuration for Linux VMs."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"adminUsername",
|
||||
"ssh"
|
||||
],
|
||||
"description": "Profile for Linux VMs in the container service cluster."
|
||||
},
|
||||
"ContainerServiceMasterProfile": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"count": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "integer",
|
||||
"default": "1"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1."
|
||||
},
|
||||
"dnsPrefix": {
|
||||
"type": "string",
|
||||
"description": "DNS prefix to be used to create the FQDN for master."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"dnsPrefix"
|
||||
],
|
||||
"description": "Profile for the container service master."
|
||||
},
|
||||
"ContainerServiceOrchestratorProfile": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"orchestratorType": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Swarm",
|
||||
"DCOS"
|
||||
]
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"orchestratorType"
|
||||
],
|
||||
"description": "Profile for the container service orchestrator."
|
||||
},
|
||||
"ContainerServiceProperties": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"orchestratorProfile": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceOrchestratorProfile"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of the orchestrator."
|
||||
},
|
||||
"masterProfile": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceMasterProfile"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of master agents."
|
||||
},
|
||||
"agentPoolProfiles": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ContainerServiceAgentPoolProfile"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of the agent pool."
|
||||
},
|
||||
"windowsProfile": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceWindowsProfile"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of Windows VMs."
|
||||
},
|
||||
"linuxProfile": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceLinuxProfile"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of Linux VMs."
|
||||
},
|
||||
"diagnosticsProfile": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/definitions/ContainerServiceDiagnosticsProfile"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Properties of the diagnostic agent."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"masterProfile",
|
||||
"agentPoolProfiles",
|
||||
"linuxProfile"
|
||||
],
|
||||
"description": "Properties of the container service."
|
||||
},
|
||||
"ContainerServiceSshConfiguration": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"publicKeys": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ContainerServiceSshPublicKey"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "the list of SSH public keys used to authenticate with Linux-based VMs."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"publicKeys"
|
||||
],
|
||||
"description": "SSH configuration for Linux-based VMs running on Azure."
|
||||
},
|
||||
"ContainerServiceSshPublicKey": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"keyData": {
|
||||
"type": "string",
|
||||
"description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"keyData"
|
||||
],
|
||||
"description": "Contains information about SSH certificate public key data."
|
||||
},
|
||||
"ContainerServiceVMDiagnostics": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression"
|
||||
}
|
||||
],
|
||||
"description": "Whether the VM diagnostic agent is provisioned on the VM."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"enabled"
|
||||
],
|
||||
"description": "Profile for diagnostics on the container service VMs."
|
||||
},
|
||||
"ContainerServiceWindowsProfile": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"adminUsername": {
|
||||
"type": "string",
|
||||
"description": "The administrator username to use for Windows VMs"
|
||||
},
|
||||
"adminPassword": {
|
||||
"type": "string",
|
||||
"description": "The administrator password to use for Windows VMs"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"adminUsername",
|
||||
"adminPassword"
|
||||
],
|
||||
"description": "Profile for Windows VMs in the container service cluster."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,55 +0,0 @@
|
|||
# Microsoft.Compute/availabilitySets template reference
|
||||
API Version: 2016-03-30
|
||||
## Template format
|
||||
|
||||
To create a Microsoft.Compute/availabilitySets resource, add the following JSON to the resources section of your template.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"type": "Microsoft.Compute/availabilitySets",
|
||||
"apiVersion": "2016-03-30",
|
||||
"location": "string",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"platformUpdateDomainCount": "integer",
|
||||
"platformFaultDomainCount": "integer",
|
||||
"virtualMachines": [
|
||||
{
|
||||
"id": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
## Property values
|
||||
|
||||
The following tables describe the values you need to set in the schema.
|
||||
|
||||
<a id="Microsoft.Compute/availabilitySets" />
|
||||
### Microsoft.Compute/availabilitySets object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| name | string | Yes | |
|
||||
| type | enum | Yes | Microsoft.Compute/availabilitySets |
|
||||
| apiVersion | enum | Yes | 2016-03-30 |
|
||||
| location | string | Yes | Resource location |
|
||||
| tags | object | No | Resource tags |
|
||||
| properties | object | Yes | [AvailabilitySetProperties object](#AvailabilitySetProperties) |
|
||||
|
||||
|
||||
<a id="AvailabilitySetProperties" />
|
||||
### AvailabilitySetProperties object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| platformUpdateDomainCount | integer | No | Update Domain count. |
|
||||
| platformFaultDomainCount | integer | No | Fault Domain count. |
|
||||
| virtualMachines | array | No | A list of references to all virtual machines in the availability set. - [SubResource object](#SubResource) |
|
||||
|
||||
|
||||
<a id="SubResource" />
|
||||
### SubResource object
|
||||
| Name | Type | Required | Value |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| id | string | No | Resource Id |
|
||||
|
||||
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче