Deployments - Create Or Update At Tenant Scope

Erőforrásokat helyez üzembe 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 Required Type 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 Required Type Description
location True
  • string

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

properties True

Az üzembehelyezési tulajdonságok.

tags
  • object

Üzembehelyezési címkék

Válaszok

Name Type Description
200 OK

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

201 Created

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

Other Status Codes

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

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, amellyel az alias elérési útja hivatkozik.

AliasPattern

Az alias elérési útjának mintázatá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

Egy erőforrás-kezelési kérelem hibaválasza.

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 a sablonban nem szereplő meglévő erőforrások törlése nélkül lesznek üzembe helyezve. Teljes módban az erőforrások üzembe lesznek helyezve, és a sablonban nem szereplő meglévő erőforrások törlődnek az erőforráscsoportból. Legyen óvatos a Teljes mód használatakor, mivel 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 rendszer kiértékelje-e a sablonkifejezéseket a szülősablon vagy a beágyazott sablon hatókörén belül.

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. A lehetséges értékek a LastSuccessful és a 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ó modell.

ScopedDeployment

Üzembehelyezési művelet paraméterei.

TemplateLink

A sablonra mutató hivatkozást jelölő entitás.

ZoneMapping

Alias

Az alias típusa.

Name Type Description
defaultMetadata

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

defaultPath
  • string

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

defaultPattern

Az aliasok alapértelmezett mintája.

name
  • string

Az alias neve.

paths

Egy alias elérési útjai.

type

Az alias típusa.

AliasPath

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

Name Type Description
apiVersions
  • string[]

Az API-verziók.

metadata

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

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 Type 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 útjának hivatkozó jogkivonatnak nincsenek attribútumai.

AliasPathMetadata

Name Type Description
attributes

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

type

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

AliasPathTokenType

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

Name Type 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 jogkivonat 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ázatának típusa.

Name Type Description
phrase
  • string

Az alias mintakifejezés.

type

Az aliasminta típusa

variable
  • string

Az aliasminta változója.

AliasPatternType

Az aliasminta típusa

Name Type Description
Extract
  • string

A kinyerés az egyetlen engedélyezett érték.

NotSpecified
  • string

A NotSpecified nem engedélyezett.

AliasType

Az alias típusa.

Name Type 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 Type Description
apiVersion
  • string

Az API verziója.

profileVersion
  • string

A profil verziója.

BasicDependency

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

Name Type 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

Egy erőforrás-kezelési kérelem hibaválasza.

Name Type Description
error

Hibaválasz
Az azure Resource Manager API-k gyakori hibaválasza a sikertelen 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 Type Description
detailLevel
  • string

Meghatározza a hibakereséshez naplózandó információk típusát. Az engedélyezett értékek: requestContent, responseContent, vagy requestContent és responseContent vesszővel elválasztva. Az alapértelmezett érték a none. Az érték 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 Type Description
dependsOn

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 Type 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

Ü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 a sablonban nem szereplő meglévő erőforrások törlése nélkül lesznek üzembe helyezve. Teljes módban az erőforrások üzembe lesznek helyezve, és a sablonban nem szereplő meglévő erőforrások törlődnek az erőforráscsoportból. Legyen óvatos a Teljes mód használatakor, mivel előfordulhat, hogy véletlenül törli az erőforrásokat.

Name Type Description
Complete
  • string
Incremental
  • string

DeploymentProperties

Üzembehelyezési tulajdonságok.

Name Type Description
debugSetting

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

expressionEvaluationOptions

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

mode

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 a sablonban nem szereplő meglévő erőforrások törlése nélkül lesznek üzembe helyezve. Teljes módban az erőforrások üzembe lesznek helyezve, és a sablonban nem szereplő meglévő erőforrások törlődnek az erőforráscsoportból. Legyen óvatos a Teljes mód használatakor, mivel előfordulhat, hogy véletlenül törli az erőforrásokat.

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 a paraméterértékeket közvetlenül a kérelemben szeretné megadni, nem pedig egy meglévő paraméterfájlra mutató hivatkozást. Használja a parametersLink tulajdonságot vagy a paramétertulajdonságot, de mindkettőt nem. Ez lehet JObject vagy jól formázott JSON-sztring.

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 paramétertulajdonsá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

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 Type Description
correlationId
  • string

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

debugSetting

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

dependencies

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

duration
  • string

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

error

Hibaválasz
Az üzembehelyezési hiba.

mode

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

onErrorDeployment

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

outputResources

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

A paraméterekre hivatkozó URI.

providers

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

provisioningState

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

templateHash
  • string

A sablonhoz létrehozott kivonat.

templateLink

A sablonra hivatkozó URI.

timestamp
  • string

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

validatedResources

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

ErrorAdditionalInfo

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

Name Type Description
info
  • object

A további információk.

type
  • string

A további információtípus.

ErrorResponse

Hibaválasz

Name Type Description
additionalInfo

A hiba további információi.

code
  • string

A hibakód.

details

A hiba részletei.

message
  • string

A hibaüzenet.

target
  • string

A hiba célja.

ExpressionEvaluationOptions

Meghatározza, hogy a rendszer kiértékelje-e a sablonkifejezéseket a szülősablon vagy a beágyazott sablon hatókörén belül.

Name Type Description
scope

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 Type Description
Inner
  • string
NotSpecified
  • string
Outer
  • string

OnErrorDeployment

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

Name Type Description
deploymentName
  • string

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

type

Az üzembe helyezés hibaviselkedési típuson. A lehetséges értékek a LastSuccessful és a SpecificDeployment.

OnErrorDeploymentExtended

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

Name Type Description
deploymentName
  • string

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

provisioningState
  • string

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

type

Az üzembe helyezés hibaviselkedési típuson. A lehetséges értékek a LastSuccessful és a SpecificDeployment.

OnErrorDeploymentType

Az üzembe helyezés hibaviselkedési típuson. A lehetséges értékek a LastSuccessful és a SpecificDeployment.

Name Type Description
LastSuccessful
  • string
SpecificDeployment
  • string

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

Name Type Description
contentVersion
  • string

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

uri
  • string

A paraméterfájl URI-ja.

Provider

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

Name Type Description
id
  • string

A szolgáltató azonosítója.

namespace
  • string

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

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

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

ProviderAuthorizationConsentState

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

Name Type Description
Consented
  • string
NotRequired
  • string
NotSpecified
  • string
Required
  • string

ProviderExtendedLocation

A szolgáltató kiterjesztett helye.

Name Type 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 Type Description
aliases

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

apiProfiles

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

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

locations
  • string[]

Azoknak a helyeknek a 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

ProvisioningState

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

Name Type 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ó modell.

Name Type Description
id
  • string

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

ScopedDeployment

Üzembehelyezési művelet paraméterei.

Name Type Description
location
  • string

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

properties

Az üzembehelyezési tulajdonságok.

tags
  • object

Üzembehelyezési címkék

A sablonra mutató hivatkozást jelölő entitás.

Name Type Description
contentVersion
  • string

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

id
  • string

Egy sablon specifikációjának 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álható csatolt sablon üzembe helyezésére a szülőhöz képest egy helyen. Ha a szülősablon egy TemplateSpec elemhez lett csatolva, akkor ez 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 helyezendő sablon URI-ja. Használja az uri vagy az azonosító tulajdonságot, de mindkettőt nem.

ZoneMapping

Name Type Description
location
  • string

A zónaleképezés helye.

zones
  • string[]