AzureResourceManagerTemplateDeployment@3 – ARM-sablon üzembe helyezési v3-as feladata

Cikk
07/02/2024

Ezzel a feladatsal üzembe helyezhet egy Azure Resource Manager- (ARM-) sablont az összes üzembehelyezési hatókörben.

Syntax

# ARM template deployment v3
# Deploy an Azure Resource Manager (ARM) template to all the deployment scopes.
- task: AzureResourceManagerTemplateDeployment@3
  inputs:
  # Azure Details
    deploymentScope: 'Resource Group' # 'Management Group' | 'Subscription' | 'Resource Group'. Required. Deployment scope. Default: Resource Group.
    azureResourceManagerConnection: # string. Alias: ConnectedServiceName. Required. Azure Resource Manager connection. 
    #subscriptionId: # string. Alias: subscriptionName. Required when deploymentScope != Management Group. Subscription. 
    #action: 'Create Or Update Resource Group' # 'Create Or Update Resource Group' | 'DeleteRG'. Required when deploymentScope = Resource Group. Action. Default: Create Or Update Resource Group.
    #resourceGroupName: # string. Required when deploymentScope = Resource Group. Resource group. 
    #location: # string. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Location. 
  # Template
    #templateLocation: 'Linked artifact' # 'Linked artifact' | 'URL of the file'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Template location. Default: Linked artifact.
    #csmFileLink: # string. Required when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template link. 
    #csmParametersFileLink: # string. Optional. Use when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters link. 
    #csmFile: # string. Required when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template. 
    #csmParametersFile: # string. Optional. Use when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters. 
    #overrideParameters: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Override template parameters. 
    #deploymentMode: 'Incremental' # 'Incremental' | 'Complete' | 'Validation'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment mode. Default: Incremental.
  # Advanced
    #deploymentName: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment name. 
    #deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment outputs. 
    #addSpnToEnvironment: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Access service principal details in override parameters. Default: false.
    #useWithoutJSON: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Use individual output values without JSON.Stringify applied. Default: false.

# ARM template deployment v3
# Deploy an Azure Resource Manager (ARM) template to all the deployment scopes.
- task: AzureResourceManagerTemplateDeployment@3
  inputs:
  # Azure Details
    deploymentScope: 'Resource Group' # 'Management Group' | 'Subscription' | 'Resource Group'. Required. Deployment scope. Default: Resource Group.
    azureResourceManagerConnection: # string. Alias: ConnectedServiceName. Required. Azure Resource Manager connection. 
    #subscriptionId: # string. Alias: subscriptionName. Required when deploymentScope != Management Group. Subscription. 
    #action: 'Create Or Update Resource Group' # 'Create Or Update Resource Group' | 'DeleteRG'. Required when deploymentScope = Resource Group. Action. Default: Create Or Update Resource Group.
    #resourceGroupName: # string. Required when deploymentScope = Resource Group. Resource group. 
    #location: # string. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Location. 
  # Template
    #templateLocation: 'Linked artifact' # 'Linked artifact' | 'URL of the file'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Template location. Default: Linked artifact.
    #csmFileLink: # string. Required when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template link. 
    #csmParametersFileLink: # string. Optional. Use when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters link. 
    #csmFile: # string. Required when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template. 
    #csmParametersFile: # string. Optional. Use when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters. 
    #overrideParameters: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Override template parameters. 
    #deploymentMode: 'Incremental' # 'Incremental' | 'Complete' | 'Validation'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment mode. Default: Incremental.
  # Advanced
    #deploymentName: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment name. 
    #deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment outputs. 
    #addSpnToEnvironment: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Access service principal details in override parameters. Default: false.

Bevitelek

deploymentScope - Üzembehelyezési hatókör
string. Kötelező. Engedélyezett értékek: Management Group, Subscription, Resource Group. Alapértelmezett érték: Resource Group.

Az üzembe helyezés hatóköre. További információ az üzembehelyezési hatókörökről.

azureResourceManagerConnection - Azure Resource Manager-kapcsolat
Bemeneti alias: ConnectedServiceName. string. Kötelező.

Meghatározza az Azure Resource Manager szolgáltatáskapcsolatot, amely a kiválasztott üzembehelyezési hatókörhöz való hozzáféréssel rendelkezik.

subscriptionId - Előfizetés
Bemeneti alias: subscriptionName. string. Akkor szükséges, ha deploymentScope != Management Group.

Az Azure-előfizetést adja meg.

Fontos

A megadott értéknek az előfizetés-azonosítónak kell lennie, nem pedig az előfizetés nevének.

action - Akció
string. Akkor szükséges, ha deploymentScope = Resource Group. Engedélyezett értékek: Create Or Update Resource Group, DeleteRG (Erőforráscsoport törlése). Alapértelmezett érték: Create Or Update Resource Group.

Az Azure-erőforrásokon vagy -erőforráscsoporton végrehajtandó művelet.

resourceGroupName - Erőforráscsoport
string. Akkor szükséges, ha deploymentScope = Resource Group.

Megadja egy erőforráscsoport nevét.

location - Helyen
string. Akkor szükséges, ha action = Create Or Update Resource Group || deploymentScope != Resource Group.

Erőforráscsoport üzembehelyezési hatókörei: Az erőforráscsoport üzembe helyezésének helye. Ha az erőforráscsoport már létezik az Azure-előfizetésben, a rendszer figyelmen kívül hagyja ezt az értéket. Egyéb üzembehelyezési hatókörök: Az üzembehelyezési metaadatok tárolásának helye.

templateLocation - Sablon helye
string. Akkor szükséges, ha action = Create Or Update Resource Group || deploymentScope != Resource Group. Engedélyezett értékek: Linked artifact, URL of the file. Alapértelmezett érték: Linked artifact.

A sablon helye és a Parameters JSON-fájlok. Válassza a Csatolt összetevő lehetőséget, ha a fájlok a csatolt kód/buildösszetevők részét képezik. Csatolt összetevők esetén megadhatja a Bicep-fájlok elérési útját is. Válassza a fájl URL-címét , ha a JSON-fájlok bármely nyilvánosan elérhető http/https URL-címen találhatók. Ha privát tárfiókban tárolt fájlt szeretne használni, kérje le és adja meg a közös hozzáférésű jogosultságkód (SAS) tokent a sablon URL-címében. Példa: <blob_storage_url>/template.json?. Ha paraméterfájlt szeretne feltölteni egy tárfiókba, és SAS-jogkivonatot szeretne létrehozni, használhatja az Azure-fájlmásolási feladatot , vagy kövesse a lépéseket a PowerShell vagy az Azure CLI használatával.

csmFileLink - Sablonhivatkozás
string. Akkor szükséges, ha templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group.

Megadja a sablonfájl URL-címét. Példa URL-cím: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.json

Privát tárfiókban tárolt sablon üzembe helyezéséhez kérje le és foglalja bele a közös hozzáférésű jogosultságkód (SAS) tokent a sablon URL-címében. Példa: <blob_storage_url>/template.json?<SAStoken>. Ha sablonfájlt (vagy csatolt sablont) szeretne feltölteni egy tárfiókba, és SAS-jogkivonatot szeretne létrehozni, használja az Azure-fájlmásolási feladatot, vagy kövesse a lépéseket a PowerShell vagy az Azure CLI használatával.

A sablonparaméterek rácsban való megtekintéséhez kattintson a ... sablonparaméterek felülbírálása szövegmező mellett. Ehhez a funkcióhoz engedélyezni kell a CORS-szabályokat a forrásnál. Ha a sablonok egy Azure Storage-blobban találhatók, a CORS engedélyezéséhez tekintse meg az eltérő eredetű erőforrások megosztását ismertető cikket.

csmParametersFileLink - Sablonparaméterek hivatkozása
string. Választható. Használja a következőt: templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group.

A paraméterfájl URL-címét adja meg. Példa URL-cím: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.parameters.json

Ha privát tárfiókban tárolt fájlt szeretne használni, kérje le és adja meg a közös hozzáférésű jogosultságkód (SAS) tokent a sablon URL-címében. Példa: <blob_storage_url>/template.json?<SAStoken>. Ha sablonfájlt (vagy csatolt sablont) szeretne feltölteni egy tárfiókba, és SAS-jogkivonatot szeretne létrehozni, használja az Azure-fájlmásolási feladatot, vagy kövesse a lépéseket a PowerShell vagy az Azure CLI használatával.

A sablonparaméterek rácsban való megtekintéséhez kattintson a ... Sablonparaméterek felülbírálása szövegmező mellett. Ehhez a funkcióhoz engedélyezni kell a CORS-szabályokat a forrásnál. Ha a sablonok egy Azure Storage-blobban találhatók, a CORS engedélyezéséhez tekintse meg az eltérő eredetű erőforrások megosztását ismertető cikket.

csmFile - Sablon
string. Akkor szükséges, ha templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group.

Megadja az Azure Resource Manager-sablonra mutató útvonalat vagy mintát. További információ az Azure Resource Manager-sablonokról. Az első lépésekhez használja ezt a mintasablont. Támogatja a Bicep-fájlokat az Azure CLI 2.20.0-s verziójában > .

csmParametersFile - Sablonparaméterek
string. Választható. Használja a következőt: templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group.

Adja meg az Azure Resource Manager sablon paraméterfájljának elérési útját vagy mintáját. Támogatja a Bicep Param-fájlokat az Azure CLI 2.47.0-s verziója > esetén.

overrideParameters - Sablonparaméterek felülbírálása
string. Választható. Használja a következőt: action = Create Or Update Resource Group || deploymentScope != Resource Group.

Megadja a felülbírálandó sablonparamétereket.

A sablonparaméterek rácsban való megtekintéséhez kattintson a ... Paraméterek felülbírálása szövegmező mellett. Ehhez a funkcióhoz engedélyezni kell a CORS-szabályokat a forrásnál. Ha a sablonok az Azure Storage-blobban találhatók, hivatkozzon erre a sztringre a CORS engedélyezéséhez, vagy írja be a felülbírálandó sablonparamétereket a szövegmezőbe.

Példa: -storageName fabrikam -adminUsername $(vmusername) -adminPassword (ConvertTo-SecureString -String '$(password)' -AsPlainText -Force) -azureKeyVaultName $(fabrikamFibre).

Ha a paraméter értéke több szóval is rendelkezik, akkor is foglalja idézőjelekbe a szavakat, ha változók használatával adja át az értéket. Például: -name "parameter value" -name2 "$(var)". Az objektumtípus paramétereinek felülbírálásához sztringezett JSON-objektumokat használjon. Például: -options ["option1"] -map {"key1": "value1" }.

deploymentMode - Üzembehelyezési mód
string. Akkor szükséges, ha action = Create Or Update Resource Group || deploymentScope != Resource Group. Engedélyezett értékek: Incremental, Complete, Validation (csak érvényesítés). Alapértelmezett érték: Incremental.

A Incremental mód az üzemelő példányokat az erőforráscsoport növekményes frissítéseként kezeli. Változatlan erőforrásokat hagy az erőforráscsoportban, de nincsenek megadva a sablonban.

Complete A mód törli a sablonban nem szereplő erőforrásokat. A teljes mód viszonylag több időt vesz igénybe, mint a növekményes mód. Ha a feladat túllépi az időkorlátot, érdemes lehet növelni az időtúllépést, vagy átváltani a Incremental módra.

Figyelmeztetés

A kész mód törli a sablonban nem megadott erőforráscsoport összes meglévő erőforrását. Ellenőrizze, hogy az üzembe helyezendő erőforráscsoport nem tartalmaz-e olyan szükséges erőforrásokat, amelyek nincsenek megadva a sablonban. Validate A mód lehetővé teszi, hogy a tényleges erőforrások létrehozása előtt problémákat találjon a sablonnal kapcsolatban.

Megjegyzés

A Validate mód mindig létrehoz egy erőforráscsoportot, még akkor is, ha nincsenek üzembe helyezve erőforrások. További információ az üzembe helyezési módokról.

deploymentName - Üzembe helyezés neve
string. Választható. Használja a következőt: action = Create Or Update Resource Group || deploymentScope != Resource Group.

Megadja a létrehozandó erőforráscsoport-telepítés nevét.

deploymentOutputs - Üzembehelyezési kimenetek
string. Választható. Használja a következőt: action = Create Or Update Resource Group || deploymentScope != Resource Group.

A kimeneti változó változójának nevét adja meg, amely az aktuális üzembehelyezési objektum kimenetek szakaszát tartalmazza sztringformátumban. A PowerShell-parancsmaggal ConvertFrom-Json elemezheti a JSON-objektumot, és hozzáférhet az egyes kimeneti értékekhez. További információ az üzembehelyezési kimenetekről.

addSpnToEnvironment - A szolgáltatásnév részleteinek elérése a felülbírálási paraméterekben
boolean. Választható. Használja a következőt: action = Create Or Update Resource Group || deploymentScope != Resource Group. Alapértelmezett érték: false.

Hozzáadja a szkript végrehajtási környezetének választott Azure-végpont egyszerű szolgáltatásazonosítóját és kulcsát. A változók $servicePrincipalId és $servicePrincipalKey lehetnek felülbírálási paraméterek, például -key $servicePrincipalKey.

useWithoutJSON - Egyéni kimeneti értékek használata JSON nélkül. Sztringesítés alkalmazva
boolean. Választható. Használja a következőt: action = Create Or Update Resource Group || deploymentScope != Resource Group. Alapértelmezett érték: false.

Az egyes kimeneti értékek JSON-kapcsolaton keresztül lesznek konvertálva. Sztringesítés alapértelmezés szerint. Ha úgy szeretné használni a kimeneti értékeket, ahogy van, anélkül, hogy JSON-kapcsolaton keresztül konvertálja őket. Sztringbefűz, engedélyezze ezt a beállítást. További részletekért tekintse meg ezt a témakört.

Feladatvezérlési lehetőségek

Minden feladathoz tartoznak vezérlési lehetőségek is a feladat bemenetei mellett. További információ: Vezérlési beállítások és gyakori feladattulajdonságok.

Kimeneti változók

Nincsenek.

Megjegyzések

Megjegyzés

Ez a feladat támogatja a Bicep-fájlokat az Azure CLI 2.20.0-s verziójának használatakor > .

Az üzembe helyezés támogatása az összes üzembehelyezési hatókörhöz hozzáadva.
- Eltávolította a virtuális géppel kapcsolatos összes műveletet.

Követelmények

Követelmény	Leírás
Folyamattípusok	YAML, klasszikus build, klasszikus kiadás
Futtatás	Ügynök, DeploymentGroup
Igények	None
Képességek	Ez a feladat nem felel meg a feladat későbbi tevékenységeire vonatkozó követelményeknek.
Parancskorlátozások	Bármelyik
Változók beállítása	Bármelyik
Ügynök verziója	2.119.1 vagy újabb
Feladatkategória	Üzembe helyezés

Megosztás a következőn keresztül: