Artifacts - Generate Arm Template

Service:

Dev Test Labs

API-versie:

2018-09-15

Genereert een ARM-sjabloon voor het opgegeven artefact, uploadt de vereiste bestanden naar een opslagaccount en valideert het gegenereerde artefact.

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

URI-parameters

Name	In	Vereist	Type	Description
artifactSourceName	path	True	string	De naam van de artefactbron.
labName	path	True	string	De naam van het lab.
name	path	True	string	De naam van het artefact.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
fileUploadOptions	FileUploadOptions	Opties voor het uploaden van de bestanden voor het artefact. UploadFilesAndGenerateSasTokens is de standaardwaarde.
location	string	De locatie van de virtuele machine.
parameters	ParameterInfo[]	De parameters van de ARM-sjabloon.
virtualMachineName	string	De resourcenaam van de virtuele machine.

Antwoorden

Name	Type	Description
200 OK	ArmTemplateInfo	De Azure-bewerking is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Artifacts_GenerateArmTemplate

Voorbeeldaanvraag

HTTP

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

{
  "fileUploadOptions": "None",
  "location": "{location}",
  "virtualMachineName": "{vmName}"
}

Voorbeeldrespons

Statuscode:

200

{
  "parameters": {
    "extensionName": {
      "value": "{vmName}/CustomScriptExtension"
    },
    "location": {
      "value": "{location}"
    }
  },
  "template": {
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
      "extensionName": {
        "type": "string"
      },
      "location": {
        "type": "string"
      }
    },
    "resources": [
      {
        "name": "[parameters('extensionName')]",
        "type": "Microsoft.Compute/virtualMachines/extensions",
        "apiVersion": "2015-06-15",
        "location": "[parameters('location')]",
        "properties": {
          "type": "CustomScriptExtension",
          "autoUpgradeMinorVersion": "true",
          "forceUpdateTag": "15/10/2018 00:00:00 +00:00",
          "protectedSettings": {
            "commandToExecute": "[concat('cd {MsDtlScriptFolder}/scripts && ', variables('_commandToExecute'))]"
          },
          "publisher": "Microsoft.Compute",
          "settings": {
            "commandToExecute": "",
            "fileUris": [
              "{MsDtlArtifactFileUris}"
            ]
          },
          "typeHandlerVersion": "1.9"
        }
      }
    ],
    "variables": {
      "_commandToExecute": "{commandToExecute}."
    }
  }
}

Definities

Name	Description
ArmTemplateInfo	Informatie over een gegenereerde ARM-sjabloon.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
FileUploadOptions	Opties voor het uploaden van de bestanden voor het artefact. UploadFilesAndGenerateSasTokens is de standaardwaarde.
GenerateArmTemplateRequest	Parameters voor het genereren van een ARM-sjabloon voor het implementeren van artefacten.
ParameterInfo	Informatie over de parameter van een artefact.

ArmTemplateInfo

Object

Informatie over een gegenereerde ARM-sjabloon.

Name	Type	Description
parameters		De parameters van de ARM-sjabloon.
template		De inhoud van de sjabloon.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

FileUploadOptions

Opsomming

Opties voor het uploaden van de bestanden voor het artefact. UploadFilesAndGenerateSasTokens is de standaardwaarde.

Waarde	Description
UploadFilesAndGenerateSasTokens
None

GenerateArmTemplateRequest

Object

Parameters voor het genereren van een ARM-sjabloon voor het implementeren van artefacten.

Name	Type	Description
fileUploadOptions	FileUploadOptions	Opties voor het uploaden van de bestanden voor het artefact. UploadFilesAndGenerateSasTokens is de standaardwaarde.
location	string	De locatie van de virtuele machine.
parameters	ParameterInfo[]	De parameters van de ARM-sjabloon.
virtualMachineName	string	De resourcenaam van de virtuele machine.

ParameterInfo

Object

Informatie over de parameter van een artefact.

Name	Type	Description
name	string	De naam van de artefactparameter.
value	string	De waarde van de artefactparameter.