Deployments - Create Or Update At Tenant Scope

Nasadí prostředky v oboru tenanta.
Šablonu a parametry můžete zadat přímo v požadavku nebo můžete odkazovat na soubory JSON.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
deploymentName
path True

string

Název nasazení.

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

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name Vyžadováno Typ Description
location True

string

Umístění pro uložení dat nasazení.

properties True

DeploymentProperties

Vlastnosti nasazení.

tags

object

Značky nasazení

Odpovědi

Name Typ Description
200 OK

DeploymentExtended

OK – vrátí informace o nasazení, včetně stavu zřizování.

201 Created

DeploymentExtended

Vytvořeno – vrátí informace o nasazení, včetně stavu zřizování.

Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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"
  }
}

Definice

Name Description
Alias

Typ aliasu.

AliasPath

Typ cest pro alias.

AliasPathAttributes

Atributy tokenu, na který odkazuje cesta aliasu.

AliasPathMetadata
AliasPathTokenType

Typ tokenu, na který cesta aliasu odkazuje.

AliasPattern

Typ vzoru pro cestu aliasu.

AliasPatternType

Typ vzoru aliasu

AliasType

Typ aliasu.

ApiProfile
BasicDependency

Informace o závislostech nasazení

CloudError

Chybová odpověď pro žádost o správu prostředků.

DebugSetting

Nastavení ladění

Dependency

Informace o závislostech nasazení

DeploymentExtended

Informace o nasazení.

DeploymentMode

Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo dokončená. V přírůstkovém režimu se prostředky nasadí bez odstranění existujících prostředků, které nejsou součástí šablony. V úplném režimu se prostředky nasadí a stávající prostředky ve skupině prostředků, které nejsou zahrnuté v šabloně, se odstraní. Při používání úplného režimu buďte opatrní, protože můžete neúmyslně odstranit prostředky.

DeploymentProperties

Vlastnosti nasazení.

DeploymentPropertiesExtended

Vlastnosti nasazení s dalšími podrobnostmi

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorResponse

Odpověď na chybu

ExpressionEvaluationOptions

Určuje, jestli se výrazy šablony vyhodnocují v rámci oboru nadřazené šablony nebo vnořené šablony.

ExpressionEvaluationOptionsScopeType

Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí ve vnořené šabloně.

OnErrorDeployment

Nasazení při chybovém chování.

OnErrorDeploymentExtended

Nasazení při chybovém chování s dalšími podrobnostmi.

OnErrorDeploymentType

Typ chování nasazení při chybě. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

ParametersLink

Entita představující odkaz na parametry nasazení.

Provider

Informace o poskytovateli prostředků.

ProviderAuthorizationConsentState

Stav souhlasu s autorizací zprostředkovatele.

ProviderExtendedLocation

Rozšířené umístění poskytovatele.

ProviderResourceType

Typ prostředku spravovaný poskytovatelem prostředků.

ProvisioningState

Označuje stav zřizování.

ResourceReference

Model ID prostředku.

ScopedDeployment

Parametry operace nasazení.

TemplateLink

Entita představující odkaz na šablonu

ZoneMapping

Alias

Typ aliasu.

Name Typ Description
defaultMetadata

AliasPathMetadata

Výchozí metadata cesty aliasu. Platí pro výchozí cestu a pro všechny cesty aliasu, které nemají metadata.

defaultPath

string

Výchozí cesta pro alias.

defaultPattern

AliasPattern

Výchozí vzor pro alias.

name

string

Název aliasu.

paths

AliasPath[]

Cesty pro alias.

type

AliasType

Typ aliasu.

AliasPath

Typ cest pro alias.

Name Typ Description
apiVersions

string[]

Verze rozhraní API.

metadata

AliasPathMetadata

Metadata cesty k aliasu. Pokud chybí, vraťte se k výchozím metadatům aliasu.

path

string

Cesta aliasu.

pattern

AliasPattern

Vzor pro cestu aliasu.

AliasPathAttributes

Atributy tokenu, na který odkazuje cesta aliasu.

Name Typ Description
Modifiable

string

Token, na který cesta aliasu odkazuje, je upravitelný zásadami s účinkem modify.

None

string

Token, na který cesta aliasu odkazuje, nemá žádné atributy.

AliasPathMetadata

Name Typ Description
attributes

AliasPathAttributes

Atributy tokenu, na který odkazuje cesta aliasu.

type

AliasPathTokenType

Typ tokenu, na který cesta aliasu odkazuje.

AliasPathTokenType

Typ tokenu, na který cesta aliasu odkazuje.

Name Typ Description
Any

string

Typ tokenu může být libovolný.

Array

string

Typ tokenu je array.

Boolean

string

Typ tokenu je logický.

Integer

string

Typ tokenu je celé číslo.

NotSpecified

string

Typ tokenu není zadán.

Number

string

Typ tokenu je číslo.

Object

string

Typ tokenu je object.

String

string

Typ tokenu je string.

AliasPattern

Typ vzoru pro cestu aliasu.

Name Typ Description
phrase

string

Fráze vzoru aliasu

type

AliasPatternType

Typ vzoru aliasu

variable

string

Proměnná vzoru aliasu

AliasPatternType

Typ vzoru aliasu

Name Typ Description
Extract

string

Extrahovat je jediná povolená hodnota.

NotSpecified

string

Není povoleno.

AliasType

Typ aliasu.

Name Typ Description
Mask

string

Hodnota aliasu je tajný kód.

NotSpecified

string

Typ aliasu je neznámý (stejný jako nezadá typ aliasu).

PlainText

string

Hodnota aliasu není tajná.

ApiProfile

Name Typ Description
apiVersion

string

Verze rozhraní API.

profileVersion

string

Verze profilu.

BasicDependency

Informace o závislostech nasazení

Name Typ Description
id

string

ID závislosti.

resourceName

string

Název prostředku závislosti.

resourceType

string

Typ prostředku závislosti.

CloudError

Chybová odpověď pro žádost o správu prostředků.

Name Typ Description
error

ErrorResponse

Odpověď na chybu
Běžná chybová odpověď pro všechna rozhraní API azure Resource Manager, která vrací podrobnosti o chybě pro neúspěšné operace. (Tento formát také odpovídá formátu odpovědi na chybu OData.)

DebugSetting

Nastavení ladění

Name Typ Description
detailLevel

string

Určuje typ informací, které se mají protokolovat pro ladění. Povolené hodnoty jsou none, requestContent, responseContent nebo obě hodnoty requestContent a responseContent oddělené čárkami. Výchozí hodnota je none. Při nastavování této hodnoty pečlivě zvažte typ informací, které předáváte během nasazení. Protokolováním informací o požadavku nebo odpovědi můžete potenciálně zpřístupnit citlivá data, která se načítají prostřednictvím operací nasazení.

Dependency

Informace o závislostech nasazení

Name Typ Description
dependsOn

BasicDependency[]

Seznam závislostí.

id

string

ID závislosti.

resourceName

string

Název prostředku závislosti.

resourceType

string

Typ prostředku závislosti.

DeploymentExtended

Informace o nasazení.

Name Typ Description
id

string

ID nasazení.

location

string

umístění nasazení.

name

string

Název nasazení.

properties

DeploymentPropertiesExtended

Vlastnosti nasazení.

tags

object

Značky nasazení

type

string

Typ nasazení.

DeploymentMode

Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo dokončená. V přírůstkovém režimu se prostředky nasadí bez odstranění existujících prostředků, které nejsou součástí šablony. V úplném režimu se prostředky nasadí a stávající prostředky ve skupině prostředků, které nejsou zahrnuté v šabloně, se odstraní. Při používání úplného režimu buďte opatrní, protože můžete neúmyslně odstranit prostředky.

Name Typ Description
Complete

string

Incremental

string

DeploymentProperties

Vlastnosti nasazení.

Name Typ Description
debugSetting

DebugSetting

Nastavení ladění nasazení.

expressionEvaluationOptions

ExpressionEvaluationOptions

Určuje, jestli se výrazy šablony vyhodnocují v rámci oboru nadřazené šablony nebo vnořené šablony. Platí jenom pro vnořené šablony. Pokud není zadán, je výchozí hodnota vnější.

mode

DeploymentMode

Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo dokončená. V přírůstkovém režimu se prostředky nasadí bez odstranění existujících prostředků, které nejsou součástí šablony. V úplném režimu se prostředky nasadí a stávající prostředky ve skupině prostředků, které nejsou zahrnuté v šabloně, se odstraní. Při používání úplného režimu buďte opatrní, protože můžete neúmyslně odstranit prostředky.

onErrorDeployment

OnErrorDeployment

Chování nasazení při chybě.

parameters

object

Páry název a hodnota, které definují parametry nasazení šablony. Tento prvek použijete, když chcete zadat hodnoty parametrů přímo v požadavku místo propojení s existujícím souborem parametrů. Použijte buď vlastnost parametersLink, nebo vlastnost parameters, ale ne obojí. Může to být JObject nebo řetězec JSON ve správném formátu.

parametersLink

ParametersLink

Identifikátor URI souboru parametrů. Tento element použijete k propojení s existujícím souborem parametrů. Použijte buď vlastnost parametersLink, nebo vlastnost parameters, ale ne obojí.

template

object

Obsah šablony. Tento prvek použijete, když chcete předat syntaxi šablony přímo v požadavku místo odkazu na existující šablonu. Může to být JObject nebo řetězec JSON ve správném formátu. Použijte buď vlastnost templateLink, nebo vlastnost šablony, ale ne obě.

templateLink

TemplateLink

Identifikátor URI šablony Použijte buď vlastnost templateLink, nebo vlastnost šablony, ale ne obě.

DeploymentPropertiesExtended

Vlastnosti nasazení s dalšími podrobnostmi

Name Typ Description
correlationId

string

ID korelace nasazení.

debugSetting

DebugSetting

Nastavení ladění nasazení.

dependencies

Dependency[]

Seznam závislostí nasazení.

duration

string

Doba trvání nasazení šablony.

error

ErrorResponse

Odpověď na chybu
Chyba nasazení.

mode

DeploymentMode

Režim nasazení. Možné hodnoty jsou Přírůstkové a Dokončené.

onErrorDeployment

OnErrorDeploymentExtended

Chování nasazení při chybě.

outputResources

ResourceReference[]

Pole zřízených prostředků

outputs

object

Páry klíč/hodnota, které představují výstup nasazení.

parameters

object

Parametry nasazení.

parametersLink

ParametersLink

Identifikátor URI odkazující na parametry.

providers

Provider[]

Seznam poskytovatelů prostředků potřebných pro nasazení.

provisioningState

ProvisioningState

Označuje stav zřizování.

templateHash

string

Hodnota hash vytvořená pro šablonu.

templateLink

TemplateLink

Identifikátor URI odkazující na šablonu

timestamp

string

Časové razítko nasazení šablony.

validatedResources

ResourceReference[]

Pole ověřených prostředků

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Typ další informace.

ErrorResponse

Odpověď na chybu

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

code

string

Kód chyby

details

ErrorResponse[]

Podrobnosti o chybě.

message

string

Chybová zpráva

target

string

Cíl chyby.

ExpressionEvaluationOptions

Určuje, jestli se výrazy šablony vyhodnocují v rámci oboru nadřazené šablony nebo vnořené šablony.

Name Typ Description
scope

ExpressionEvaluationOptionsScopeType

Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí ve vnořené šabloně.

ExpressionEvaluationOptionsScopeType

Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí ve vnořené šabloně.

Name Typ Description
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Nasazení při chybovém chování.

Name Typ Description
deploymentName

string

Nasazení, které se má použít v případě chyby.

type

OnErrorDeploymentType

Typ chování nasazení při chybě. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

OnErrorDeploymentExtended

Nasazení při chybovém chování s dalšími podrobnostmi.

Name Typ Description
deploymentName

string

Nasazení, které se má použít v případě chyby.

provisioningState

string

Stav zřizování nasazení při chybě.

type

OnErrorDeploymentType

Typ chování nasazení při chybě. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

OnErrorDeploymentType

Typ chování nasazení při chybě. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

Name Typ Description
LastSuccessful

string

SpecificDeployment

string

Entita představující odkaz na parametry nasazení.

Name Typ Description
contentVersion

string

Pokud je součástí, musí odpovídat hodnotě ContentVersion v šabloně.

uri

string

Identifikátor URI souboru parametrů.

Provider

Informace o poskytovateli prostředků.

Name Typ Description
id

string

ID zprostředkovatele.

namespace

string

Obor názvů poskytovatele prostředků.

providerAuthorizationConsentState

ProviderAuthorizationConsentState

Stav souhlasu s autorizací zprostředkovatele.

registrationPolicy

string

Zásady registrace poskytovatele prostředků.

registrationState

string

Stav registrace poskytovatele prostředků.

resourceTypes

ProviderResourceType[]

Kolekce typů prostředků poskytovatele.

ProviderAuthorizationConsentState

Stav souhlasu s autorizací zprostředkovatele.

Name Typ Description
Consented

string

NotRequired

string

NotSpecified

string

Required

string

ProviderExtendedLocation

Rozšířené umístění poskytovatele.

Name Typ Description
extendedLocations

string[]

Rozšířená umístění pro umístění Azure.

location

string

Umístění Azure.

type

string

Typ rozšířeného umístění.

ProviderResourceType

Typ prostředku spravovaný poskytovatelem prostředků.

Name Typ Description
aliases

Alias[]

Aliasy podporované tímto typem prostředku.

apiProfiles

ApiProfile[]

Profily rozhraní API pro poskytovatele prostředků.

apiVersions

string[]

Verze rozhraní API.

capabilities

string

Další možnosti, které tento typ prostředku nabízí.

defaultApiVersion

string

Výchozí verze rozhraní API.

locationMappings

ProviderExtendedLocation[]

Mapování umístění podporovaná tímto typem prostředku.

locations

string[]

Kolekce umístění, kde lze tento typ prostředku vytvořit.

properties

object

Vlastnosti.

resourceType

string

Typ prostředku.

zoneMappings

ZoneMapping[]

ProvisioningState

Označuje stav zřizování.

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

Model ID prostředku.

Name Typ Description
id

string

Plně kvalifikované ID prostředku.

ScopedDeployment

Parametry operace nasazení.

Name Typ Description
location

string

Umístění pro uložení dat nasazení.

properties

DeploymentProperties

Vlastnosti nasazení.

tags

object

Značky nasazení

Entita představující odkaz na šablonu

Name Typ Description
contentVersion

string

Pokud je součástí, musí odpovídat hodnotě ContentVersion v šabloně.

id

string

ID prostředku specifikace šablony. Použijte buď vlastnost id, nebo URI, ale ne obě.

queryString

string

Řetězec dotazu (například token SAS), který se má použít s identifikátorem URI templateLink.

relativePath

string

Vlastnost relativePath lze použít k nasazení propojené šablony v umístění vzhledem k nadřazené. Pokud byla nadřazená šablona propojena šablonou TemplateSpec, bude odkazovat na artefakt v TemplateSpec. Pokud byl nadřazený objekt propojený pomocí identifikátoru URI, podřízené nasazení bude kombinací nadřazeného a relativního identifikátoru URI.

uri

string

Identifikátor URI šablony, kterou chcete nasadit. Použijte buď vlastnost URI, nebo id, ale ne obojí.

ZoneMapping

Name Typ Description
location

string

Umístění mapování zóny.

zones

string[]