Deployments - Create Or Update At Tenant Scope

Erőforrásokat helyez üzembe a bérlői hatókörben.
A sablont és a paramétereket közvetlenül a kérelemben vagy a JSON-fájlokra mutató hivatkozásban adhatja meg.

PUT https://management.azure.com/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01

URI-paraméterek

Name In Kötelező Típus Description
deploymentName
path True

string

Az üzembe helyezés neve.

Regex pattern: ^[-\w\._\(\)]+$

api-version
query True

string

A művelethez használandó API-verzió.

Kérelem törzse

Name Kötelező Típus Description
location True

string

Az üzembehelyezési adatok tárolásának helye.

properties True

DeploymentProperties

Az üzembehelyezési tulajdonságok.

tags

object

Üzembehelyezési címkék

Válaszok

Name Típus Description
200 OK

DeploymentExtended

OK – Az üzembe helyezéssel kapcsolatos információkat adja vissza, beleértve a kiépítési állapotot is.

201 Created

DeploymentExtended

Létrehozva – Az üzembe helyezéssel kapcsolatos információkat adja vissza, beleértve a kiépítési állapotot is.

Other Status Codes

CloudError

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

Create deployment at tenant scope.

Sample Request

PUT https://management.azure.com/providers/Microsoft.Resources/deployments/tenant-dep01?api-version=2021-04-01

{
  "location": "eastus",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Incremental"
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Sample Response

{
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "properties": {
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z",
    "duration": "PT1.2970875S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "resourceType": "policyDefinitions",
            "locations": [
              null
            ]
          },
          {
            "resourceType": "policyAssignments",
            "locations": [
              null
            ]
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "resourceType": "deployments",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions",
            "resourceName": "policy-definition-name"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments",
        "resourceName": "location-lock"
      }
    ]
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}
{
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "properties": {
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z",
    "duration": "PT1.2970875S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "resourceType": "policyDefinitions",
            "locations": [
              null
            ]
          },
          {
            "resourceType": "policyAssignments",
            "locations": [
              null
            ]
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "resourceType": "deployments",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions",
            "resourceName": "policy-definition-name"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments",
        "resourceName": "location-lock"
      }
    ]
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Definíciók

Name Description
Alias

Az alias típusa.

AliasPath

Az alias elérési útjainak típusa.

AliasPathAttributes

Annak a jogkivonatnak az attribútumai, amelyekre az alias elérési útja hivatkozik.

AliasPathMetadata
AliasPathTokenType

Annak a jogkivonatnak a típusa, amelyekre az alias elérési útja hivatkozik.

AliasPattern

Az alias elérési útjának mintájának típusa.

AliasPatternType

Az aliasminta típusa

AliasType

Az alias típusa.

ApiProfile
BasicDependency

Üzembehelyezési függőségi információk.

CloudError

Hibaválasz egy erőforrás-kezelési kéréshez.

DebugSetting

A hibakeresési beállítás.

Dependency

Üzembehelyezési függőségi információk.

DeploymentExtended

Üzembe helyezési információk.

DeploymentMode

Az erőforrások üzembe helyezéséhez használt mód. Ez az érték növekményes vagy befejezett lehet. Növekményes módban az erőforrások üzembe helyezése a sablonban nem szereplő meglévő erőforrások törlése nélkül történik. Teljes módban az erőforrások üzembe helyezése és a sablonban nem szereplő meglévő erőforrások törlődnek az erőforráscsoportban. Legyen óvatos a Teljes mód használatakor, mert előfordulhat, hogy véletlenül törli az erőforrásokat.

DeploymentProperties

Üzembehelyezési tulajdonságok.

DeploymentPropertiesExtended

Üzembehelyezési tulajdonságok további részletekkel.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

ErrorResponse

Hibaválasz

ExpressionEvaluationOptions

Meghatározza, hogy a sablonkifejezések kiértékelése a szülősablon vagy a beágyazott sablon hatókörén belül történik-e.

ExpressionEvaluationOptionsScopeType

A paraméterek, változók és függvények beágyazott sablonban való kiértékeléséhez használandó hatókör.

OnErrorDeployment

Üzembe helyezés hibaviselkedés esetén.

OnErrorDeploymentExtended

Üzembe helyezés hibaviselkedés esetén további részletekkel.

OnErrorDeploymentType

Az üzembe helyezés hibaviselkedési típuson. Lehetséges értékek: LastSuccessful és SpecificDeployment.

ParametersLink

Az üzembehelyezési paraméterekre mutató hivatkozást jelölő entitás.

Provider

Erőforrás-szolgáltató adatai.

ProviderAuthorizationConsentState

A szolgáltató engedélyezési hozzájárulási állapota.

ProviderExtendedLocation

A szolgáltató kiterjesztett helye.

ProviderResourceType

Az erőforrás-szolgáltató által kezelt erőforrástípus.

ProvisioningState

A kiépítés állapotát jelöli.

ResourceReference

Az erőforrás-azonosító modellje.

ScopedDeployment

Üzembehelyezési művelet paraméterei.

TemplateLink

A sablonra mutató hivatkozást képviselő entitás.

ZoneMapping

Alias

Az alias típusa.

Name Típus Description
defaultMetadata

AliasPathMetadata

Az alapértelmezett aliaselérési út metaadatai. Az alapértelmezett elérési útra és minden olyan aliasútvonalra vonatkozik, amely nem rendelkezik metaadatokkal

defaultPath

string

Az alias alapértelmezett elérési útja.

defaultPattern

AliasPattern

Az alias alapértelmezett mintája.

name

string

Az alias neve.

paths

AliasPath[]

Egy alias elérési útjai.

type

AliasType

Az alias típusa.

AliasPath

Az alias elérési útjainak típusa.

Name Típus Description
apiVersions

string[]

Az API-verziók.

metadata

AliasPathMetadata

Az alias elérési útjának metaadatai. Ha hiányzik, térjen vissza az alias alapértelmezett metaadataira.

path

string

Egy alias elérési útja.

pattern

AliasPattern

Az alias elérési útjának mintája.

AliasPathAttributes

Annak a jogkivonatnak az attribútumai, amelyekre az alias elérési útja hivatkozik.

Name Típus Description
Modifiable

string

Az alias elérési útja által hivatkozott jogkivonat módosítható a "módosítás" effektusú szabályzatokkal.

None

string

Az alias elérési útja által hivatkozott tokennek nincsenek attribútumai.

AliasPathMetadata

Name Típus Description
attributes

AliasPathAttributes

Annak a jogkivonatnak az attribútumai, amelyekre az alias elérési útja hivatkozik.

type

AliasPathTokenType

Annak a jogkivonatnak a típusa, amelyekre az alias elérési útja hivatkozik.

AliasPathTokenType

Annak a jogkivonatnak a típusa, amelyekre az alias elérési útja hivatkozik.

Name Típus Description
Any

string

A jogkivonat típusa bármi lehet.

Array

string

A jogkivonat típusa tömb.

Boolean

string

A jogkivonat típusa logikai.

Integer

string

A token típusa egész szám.

NotSpecified

string

A jogkivonat típusa nincs megadva.

Number

string

A jogkivonat típusa szám.

Object

string

A jogkivonat típusa objektum.

String

string

A jogkivonat típusa sztring.

AliasPattern

Az alias elérési útjának mintájának típusa.

Name Típus Description
phrase

string

Az alias mintakifejezés.

type

AliasPatternType

Az aliasminta típusa

variable

string

Az alias mintaváltozója.

AliasPatternType

Az aliasminta típusa

Name Típus Description
Extract

string

A kivonat az egyetlen engedélyezett érték.

NotSpecified

string

A NotSpecified nem engedélyezett.

AliasType

Az alias típusa.

Name Típus Description
Mask

string

Az alias értéke titkos.

NotSpecified

string

Az alias típusa ismeretlen (ugyanaz, mintha nem ad meg aliastípust).

PlainText

string

Az alias értéke nem titkos.

ApiProfile

Name Típus Description
apiVersion

string

Az API verziója.

profileVersion

string

A profil verziója.

BasicDependency

Üzembehelyezési függőségi információk.

Name Típus Description
id

string

A függőség azonosítója.

resourceName

string

A függőségi erőforrás neve.

resourceType

string

A függőségi erőforrás típusa.

CloudError

Hibaválasz egy erőforrás-kezelési kéréshez.

Name Típus Description
error

ErrorResponse

Hibaválasz
Az azure Resource Manager API-k gyakori hibaválasza a meghiúsult műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

DebugSetting

A hibakeresési beállítás.

Name Típus Description
detailLevel

string

Megadja a hibakereséshez naplózandó információk típusát. Az engedélyezett értékek a következők: requestContent, responseContent, vagy requestContent és responseContent is, vesszővel elválasztva. Az alapértelmezett érték a none. Ennek az értéknek a beállításakor alaposan gondolja át, hogy milyen típusú információkat ad át az üzembe helyezés során. A kéréssel vagy válaszsal kapcsolatos információk naplózásával potenciálisan közzéteheti az üzembehelyezési műveletek során lekért bizalmas adatokat.

Dependency

Üzembehelyezési függőségi információk.

Name Típus Description
dependsOn

BasicDependency[]

A függőségek listája.

id

string

A függőség azonosítója.

resourceName

string

A függőségi erőforrás neve.

resourceType

string

A függőségi erőforrás típusa.

DeploymentExtended

Üzembe helyezési információk.

Name Típus Description
id

string

Az üzembe helyezés azonosítója.

location

string

az üzembe helyezés helye.

name

string

Az üzembe helyezés neve.

properties

DeploymentPropertiesExtended

Üzembehelyezési tulajdonságok.

tags

object

Üzembehelyezési címkék

type

string

Az üzembe helyezés típusa.

DeploymentMode

Az erőforrások üzembe helyezéséhez használt mód. Ez az érték növekményes vagy befejezett lehet. Növekményes módban az erőforrások üzembe helyezése a sablonban nem szereplő meglévő erőforrások törlése nélkül történik. Teljes módban az erőforrások üzembe helyezése és a sablonban nem szereplő meglévő erőforrások törlődnek az erőforráscsoportban. Legyen óvatos a Teljes mód használatakor, mert előfordulhat, hogy véletlenül törli az erőforrásokat.

Name Típus Description
Complete

string

Incremental

string

DeploymentProperties

Üzembehelyezési tulajdonságok.

Name Típus Description
debugSetting

DebugSetting

Az üzembe helyezés hibakeresési beállítása.

expressionEvaluationOptions

ExpressionEvaluationOptions

Meghatározza, hogy a sablonkifejezések kiértékelése a szülősablon vagy a beágyazott sablon hatókörén belül történik-e. Csak beágyazott sablonokra alkalmazható. Ha nincs megadva, az alapértelmezett érték külső.

mode

DeploymentMode

Az erőforrások üzembe helyezéséhez használt mód. Ez az érték növekményes vagy befejezett lehet. Növekményes módban az erőforrások üzembe helyezése a sablonban nem szereplő meglévő erőforrások törlése nélkül történik. Teljes módban az erőforrások üzembe helyezése és a sablonban nem szereplő meglévő erőforrások törlődnek az erőforráscsoportban. Legyen óvatos a Teljes mód használatakor, mert előfordulhat, hogy véletlenül törli az erőforrásokat.

onErrorDeployment

OnErrorDeployment

Az üzembe helyezés hibaviselkedés esetén.

parameters

object

A sablon üzembehelyezési paramétereit meghatározó név- és értékpárok. Ezt az elemet akkor használja, ha közvetlenül a kérelemben szeretné megadni a paraméterértékeket, nem pedig egy meglévő paraméterfájlra mutató hivatkozást. Használja a parametersLink tulajdonságot vagy a parameters tulajdonságot, de mindkettőt nem. Ez lehet JObject vagy jól formázott JSON-sztring.

parametersLink

ParametersLink

A paraméterfájl URI-ja. Ezzel az elemmel hivatkozhat egy meglévő paraméterfájlra. Használja a parametersLink tulajdonságot vagy a parameters tulajdonságot, de mindkettőt nem.

template

object

A sablon tartalma. Ezt az elemet akkor használja, ha a sablon szintaxisát közvetlenül a kérelemben szeretné átadni, nem pedig egy meglévő sablonra mutató hivatkozást. Ez lehet JObject vagy jól formázott JSON-sztring. Használja a templateLink tulajdonságot vagy a sablontulajdonságot, de mindkettőt nem.

templateLink

TemplateLink

A sablon URI-ja. Használja a templateLink tulajdonságot vagy a sablontulajdonságot, de mindkettőt nem.

DeploymentPropertiesExtended

Üzembehelyezési tulajdonságok további részletekkel.

Name Típus Description
correlationId

string

Az üzembe helyezés korrelációs azonosítója.

debugSetting

DebugSetting

Az üzembe helyezés hibakeresési beállítása.

dependencies

Dependency[]

Az üzembehelyezési függőségek listája.

duration

string

A sablon üzembe helyezésének időtartama.

error

ErrorResponse

Hibaválasz
Az üzembehelyezési hiba.

mode

DeploymentMode

Az üzembehelyezési mód. A lehetséges értékek növekményesek és készek.

onErrorDeployment

OnErrorDeploymentExtended

Az üzembe helyezés hibaviselkedés esetén.

outputResources

ResourceReference[]

Kiépített erőforrások tömbje.

outputs

object

Az üzembehelyezési kimenetet képviselő kulcs-/érték párok.

parameters

object

Üzembehelyezési paraméterek.

parametersLink

ParametersLink

A paraméterekre hivatkozó URI.

providers

Provider[]

Az üzembe helyezéshez szükséges erőforrás-szolgáltatók listája.

provisioningState

ProvisioningState

A kiépítés állapotát jelöli.

templateHash

string

A sablonhoz létrehozott kivonat.

templateLink

TemplateLink

A sablonra hivatkozó URI.

timestamp

string

A sablon üzembe helyezésének időbélyege.

validatedResources

ResourceReference[]

Ellenőrzött erőforrások tömbje.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name Típus Description
info

object

A további információk.

type

string

A további adattípus.

ErrorResponse

Hibaválasz

Name Típus Description
additionalInfo

ErrorAdditionalInfo[]

A hiba további információi.

code

string

A hibakód.

details

ErrorResponse[]

A hiba részletei.

message

string

A hibaüzenet.

target

string

A hiba célja.

ExpressionEvaluationOptions

Meghatározza, hogy a sablonkifejezések kiértékelése a szülősablon vagy a beágyazott sablon hatókörén belül történik-e.

Name Típus Description
scope

ExpressionEvaluationOptionsScopeType

A paraméterek, változók és függvények beágyazott sablonban való kiértékeléséhez használandó hatókör.

ExpressionEvaluationOptionsScopeType

A paraméterek, változók és függvények beágyazott sablonban való kiértékeléséhez használandó hatókör.

Name Típus Description
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Üzembe helyezés hibaviselkedés esetén.

Name Típus Description
deploymentName

string

A hibaesetben használandó üzembe helyezés.

type

OnErrorDeploymentType

Az üzembe helyezés hibaviselkedési típuson. Lehetséges értékek: LastSuccessful és SpecificDeployment.

OnErrorDeploymentExtended

Üzembe helyezés hibaviselkedés esetén további részletekkel.

Name Típus Description
deploymentName

string

A hibaesetben használandó üzembe helyezés.

provisioningState

string

A hibaalapú üzembe helyezés kiépítésének állapota.

type

OnErrorDeploymentType

Az üzembe helyezés hibaviselkedési típuson. Lehetséges értékek: LastSuccessful és SpecificDeployment.

OnErrorDeploymentType

Az üzembe helyezés hibaviselkedési típuson. Lehetséges értékek: LastSuccessful és SpecificDeployment.

Name Típus Description
LastSuccessful

string

SpecificDeployment

string

Az üzembehelyezési paraméterekre mutató hivatkozást jelölő entitás.

Name Típus Description
contentVersion

string

Ha szerepel benne, akkor meg kell egyeznie a sablon ContentVersion elemével.

uri

string

A paraméterfájl URI-ja.

Provider

Erőforrás-szolgáltató adatai.

Name Típus Description
id

string

A szolgáltató azonosítója.

namespace

string

Az erőforrás-szolgáltató névtere.

providerAuthorizationConsentState

ProviderAuthorizationConsentState

A szolgáltató engedélyezési hozzájárulási állapota.

registrationPolicy

string

Az erőforrás-szolgáltató regisztrációs szabályzata.

registrationState

string

Az erőforrás-szolgáltató regisztrációs állapota.

resourceTypes

ProviderResourceType[]

A szolgáltatói erőforrástípusok gyűjteménye.

ProviderAuthorizationConsentState

A szolgáltató engedélyezési hozzájárulási állapota.

Name Típus Description
Consented

string

NotRequired

string

NotSpecified

string

Required

string

ProviderExtendedLocation

A szolgáltató kiterjesztett helye.

Name Típus Description
extendedLocations

string[]

Az Azure-hely kiterjesztett helyei.

location

string

Az Azure helye.

type

string

A kiterjesztett hely típusa.

ProviderResourceType

Az erőforrás-szolgáltató által kezelt erőforrástípus.

Name Típus Description
aliases

Alias[]

Az ilyen erőforrástípus által támogatott aliasok.

apiProfiles

ApiProfile[]

Az erőforrás-szolgáltató API-profiljai.

apiVersions

string[]

Az API verziója.

capabilities

string

Az erőforrástípus által kínált további képességek.

defaultApiVersion

string

Az ALAPÉRTELMEZETT API-verzió.

locationMappings

ProviderExtendedLocation[]

Az erőforrástípus által támogatott helyleképezések.

locations

string[]

Azon helyek gyűjteménye, ahol ez az erőforrástípus létrehozható.

properties

object

A tulajdonságok.

resourceType

string

Az erőforrás típusa.

zoneMappings

ZoneMapping[]

ProvisioningState

A kiépítés állapotát jelöli.

Name Típus Description
Accepted

string

Canceled

string

Created

string

Creating

string

Deleted

string

Deleting

string

Failed

string

NotSpecified

string

Ready

string

Running

string

Succeeded

string

Updating

string

ResourceReference

Az erőforrás-azonosító modellje.

Name Típus Description
id

string

A teljes erőforrás-azonosító.

ScopedDeployment

Üzembehelyezési művelet paraméterei.

Name Típus Description
location

string

Az üzembehelyezési adatok tárolásának helye.

properties

DeploymentProperties

Az üzembehelyezési tulajdonságok.

tags

object

Üzembehelyezési címkék

A sablonra mutató hivatkozást képviselő entitás.

Name Típus Description
contentVersion

string

Ha szerepel benne, akkor meg kell egyeznie a sablon ContentVersion elemével.

id

string

Egy sablonspecifikáció erőforrás-azonosítója. Használja az id vagy az URI tulajdonságot, de mindkettőt nem.

queryString

string

A templateLink URI-val használandó lekérdezési sztring (például SAS-jogkivonat).

relativePath

string

A relativePath tulajdonság használatával egy csatolt sablont helyezhet üzembe a szülőhöz képest egy helyen. Ha a szülősablont egy TemplateSpec elemhez csatolták, az a TemplateSpec egyik összetevőjére fog hivatkozni. Ha a szülő URI-val lett összekapcsolva, a gyermektelepítés a szülő és a relatívPath URI-k kombinációja lesz

uri

string

Az üzembe helyezni kívánt sablon URI-ja. Használja az URI vagy az id tulajdonságot, de mindkettőt nem.

ZoneMapping

Name Típus Description
location

string

A zónaleképezés helye.

zones

string[]