Deployments - Create Or Update At Subscription Scope
Nasadí prostředky v oboru předplatného.
Šablonu a parametry můžete zadat přímo v požadavku nebo můžete odkazovat na soubory JSON.
PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
deployment
|
path | True |
string |
Název nasazení. Vzor regulárního výrazu: |
subscription
|
path | True |
string |
ID předplatného Microsoft Azure. |
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 |
---|---|---|---|
properties | True |
Vlastnosti nasazení. |
|
location |
string |
Umístění pro uložení dat nasazení. |
|
tags |
object |
Značky nasazení |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
OK – vrátí informace o nasazení, včetně stavu zřizování. |
|
201 Created |
Vytvořeno – vrátí informace o nasazení, včetně stavu zřizování. |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
Create a deployment that will deploy a templateSpec with the given resourceId
Ukázkový požadavek
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment?api-version=2021-04-01
{
"location": "eastus",
"properties": {
"templateLink": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"
},
"parameters": {},
"mode": "Incremental"
}
}
Ukázková odpověď
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment",
"name": "my-deployment",
"type": "Microsoft.Resources/deployments",
"location": "eastus",
"properties": {
"templateLink": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
"contentVersion": "1.0.0.0"
},
"templateHash": "0000000000000000000",
"parameters": {},
"mode": "Incremental",
"provisioningState": "Succeeded",
"timestamp": "2020-06-05T01:51:58.6288067Z",
"duration": "PT1.2637681S",
"correlationId": "00000000-0000-0000-0000-000000000000",
"providers": [],
"dependencies": [],
"outputResources": []
}
}
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment",
"name": "my-deployment",
"type": "Microsoft.Resources/deployments",
"location": "eastus",
"properties": {
"templateLink": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
"contentVersion": "1.0.0.0"
},
"templateHash": "0000000000000000000",
"parameters": {},
"mode": "Incremental",
"provisioningState": "Accepted",
"timestamp": "2020-06-05T01:51:58.6288067Z",
"duration": "PT1.2637681S",
"correlationId": "00000000-0000-0000-0000-000000000000",
"providers": [],
"dependencies": []
}
}
Definice
Name | Description |
---|---|
Alias |
Typ aliasu. |
Alias |
Typ cest pro alias. |
Alias |
Atributy tokenu, na který odkazuje cesta k aliasu. |
Alias |
|
Alias |
Typ tokenu, na který odkazuje cesta k aliasu. |
Alias |
Typ vzoru pro cestu aliasu. |
Alias |
Typ vzoru aliasu |
Alias |
Typ aliasu. |
Api |
|
Basic |
Informace o závislostech nasazení. |
Cloud |
Chybová odpověď pro žádost o správu prostředků. |
Debug |
Nastavení ladění |
Dependency |
Informace o závislostech nasazení. |
Deployment |
Parametry operace nasazení. |
Deployment |
Informace o nasazení. |
Deployment |
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 režimu Dokončení se prostředky nasadí a stávající prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při používání režimu úplného dokončení buďte opatrní, protože můžete neúmyslně odstranit prostředky. |
Deployment |
Vlastnosti nasazení. |
Deployment |
Vlastnosti nasazení s dalšími podrobnostmi |
Error |
Další informace o chybě správy prostředků |
Error |
Odpověď na chybu |
Expression |
Určuje, jestli se výrazy šablony vyhodnocují v rámci rozsahu nadřazené šablony nebo vnořené šablony. |
Expression |
Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí ve vnořené šabloně. |
On |
Nasazení při chybovém chování. |
On |
Nasazení při chybovém chování s dalšími podrobnostmi. |
On |
Typ chování nasazení při chybě. Možné hodnoty jsou LastSuccessful a SpecificDeployment. |
Parameters |
Entita představující odkaz na parametry nasazení |
Provider |
Informace o poskytovateli prostředků. |
Provider |
Stav souhlasu s autorizací zprostředkovatele |
Provider |
Rozšířené umístění poskytovatele. |
Provider |
Typ prostředku spravovaný poskytovatelem prostředků. |
Provisioning |
Označuje stav zřizování. |
Resource |
Model ID prostředku. |
Template |
Entita představující odkaz na šablonu |
Zone |
Alias
Typ aliasu.
Name | Typ | Description |
---|---|---|
defaultMetadata |
Výchozí metadata cesty k aliasu. Platí pro výchozí cestu a pro každou cestu aliasu, která neobsahuje metadata. |
|
defaultPath |
string |
Výchozí cesta pro alias. |
defaultPattern |
Výchozí vzor pro alias. |
|
name |
string |
Název aliasu. |
paths |
Cesty pro alias. |
|
type |
Typ aliasu. |
AliasPath
Typ cest pro alias.
Name | Typ | Description |
---|---|---|
apiVersions |
string[] |
Verze rozhraní API |
metadata |
Metadata cesty aliasu. Pokud chybí, vraťte se k výchozím metadatům aliasu. |
|
path |
string |
Cesta aliasu. |
pattern |
Vzor pro cestu k aliasu |
AliasPathAttributes
Atributy tokenu, na který odkazuje cesta k aliasu.
Name | Typ | Description |
---|---|---|
Modifiable |
string |
Token, na který odkazuje cesta aliasu, je upravitelný pomocí zásad s efektem "modify". |
None |
string |
Token, na který odkazuje cesta aliasu, nemá žádné atributy. |
AliasPathMetadata
Name | Typ | Description |
---|---|---|
attributes |
Atributy tokenu, na který odkazuje cesta k aliasu. |
|
type |
Typ tokenu, na který odkazuje cesta k aliasu. |
AliasPathTokenType
Typ tokenu, na který odkazuje cesta k aliasu.
Name | Typ | Description |
---|---|---|
Any |
string |
Typ tokenu může být libovolný. |
Array |
string |
Typ tokenu je pole. |
Boolean |
string |
Typ tokenu je logický. |
Integer |
string |
Typ tokenu je celé číslo. |
NotSpecified |
string |
Typ tokenu není zadaný. |
Number |
string |
Typ tokenu je číslo. |
Object |
string |
Typ tokenu je objekt. |
String |
string |
Typ tokenu je řetězec. |
AliasPattern
Typ vzoru pro cestu aliasu.
Name | Typ | Description |
---|---|---|
phrase |
string |
Frázi vzoru aliasu |
type |
Typ vzoru aliasu |
|
variable |
string |
Proměnná vzoru aliasu |
AliasPatternType
Typ vzoru aliasu
Name | Typ | Description |
---|---|---|
Extract |
string |
Extrahování je jediná povolená hodnota. |
NotSpecified |
string |
Není povoleno. |
AliasType
Typ aliasu.
Name | Typ | Description |
---|---|---|
Mask |
string |
Hodnota aliasu je tajný klíč. |
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 |
Odpověď na chybu |
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 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 nasazování. Protokolováním informací o požadavku nebo odpovědi můžete potenciálně zveřejnit citlivá data, která se načítají prostřednictvím operací nasazení. |
Dependency
Informace o závislostech nasazení.
Name | Typ | Description |
---|---|---|
dependsOn |
Seznam závislostí. |
|
id |
string |
ID závislosti. |
resourceName |
string |
Název prostředku závislosti. |
resourceType |
string |
Typ prostředku závislosti. |
Deployment
Parametry operace nasazení.
Name | Typ | Description |
---|---|---|
location |
string |
Umístění pro uložení dat nasazení. |
properties |
Vlastnosti nasazení. |
|
tags |
object |
Značky nasazení |
DeploymentExtended
Informace o nasazení.
Name | Typ | Description |
---|---|---|
id |
string |
ID nasazení. |
location |
string |
umístění nasazení. |
name |
string |
Název nasazení. |
properties |
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 režimu Dokončení se prostředky nasadí a stávající prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při používání režimu úplného dokončení 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 |
Nastavení ladění nasazení. |
|
expressionEvaluationOptions |
Určuje, jestli se výrazy šablony vyhodnocují v rámci rozsahu nadřazené šablony nebo vnořené šablony. Platí jenom pro vnořené šablony. Pokud není zadán, výchozí hodnota je vnější. |
|
mode |
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 režimu Dokončení se prostředky nasadí a stávající prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při používání režimu úplného dokončení buďte opatrní, protože můžete neúmyslně odstranit prostředky. |
|
onErrorDeployment |
Chování nasazení při chybě. |
|
parameters |
object |
Páry název a hodnota, které definují parametry nasazení pro šablonu. 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 vlastnost parametersLink nebo vlastnost parameters, ale ne obě vlastnosti. Může to být JObject nebo dobře formátovaný řetězec JSON. |
parametersLink |
Identifikátor URI souboru parametrů. Tento prvek použijete k propojení s existujícím souborem parametrů. Použijte vlastnost parametersLink nebo vlastnost parameters, ale ne obě vlastnosti. |
|
template |
object |
Obsah šablony. Tento prvek použijete, když chcete předat syntaxi šablony přímo v požadavku místo propojení s existující šablonou. Může to být JObject nebo dobře formátovaný řetězec JSON. Použijte vlastnost templateLink nebo vlastnost šablony, ale ne obojí. |
templateLink |
Identifikátor URI šablony Použijte vlastnost templateLink nebo vlastnost šablony, ale ne obojí. |
DeploymentPropertiesExtended
Vlastnosti nasazení s dalšími podrobnostmi
Name | Typ | Description |
---|---|---|
correlationId |
string |
ID korelace nasazení. |
debugSetting |
Nastavení ladění nasazení. |
|
dependencies |
Seznam závislostí nasazení |
|
duration |
string |
Doba trvání nasazení šablony. |
error |
Odpověď na chybu |
|
mode |
Režim nasazení. Možné hodnoty jsou přírůstkové a dokončené. |
|
onErrorDeployment |
Chování nasazení při chybě. |
|
outputResources |
Pole zřízených prostředků |
|
outputs |
object |
Páry klíč/hodnota, které představují výstup nasazení. |
parameters |
object |
Parametry nasazení. |
parametersLink |
Identifikátor URI odkazující na parametry. |
|
providers |
Provider[] |
Seznam poskytovatelů prostředků potřebných pro nasazení |
provisioningState |
Označuje stav zřizování. |
|
templateHash |
string |
Hodnota hash vytvořená pro šablonu |
templateLink |
Identifikátor URI odkazující na šablonu |
|
timestamp |
string |
Časové razítko nasazení šablony |
validatedResources |
Pole ověřených prostředků |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Další typ informací. |
ErrorResponse
Odpověď na chybu
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě |
|
code |
string |
Kód chyby |
details |
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 rozsahu nadřazené šablony nebo vnořené šablony.
Name | Typ | Description |
---|---|---|
scope |
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 |
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í pro nasazení při chybě. |
type |
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 |
ParametersLink
Entita představující odkaz na parametry nasazení
Name | Typ | Description |
---|---|---|
contentVersion |
string |
Pokud je součástí, musí se shodovat s 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 |
Stav souhlasu s autorizací zprostředkovatele |
|
registrationPolicy |
string |
Zásady registrace poskytovatele prostředků. |
registrationState |
string |
Stav registrace poskytovatele prostředků. |
resourceTypes |
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 |
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 |
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 |
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. |
TemplateLink
Entita představující odkaz na šablonu
Name | Typ | Description |
---|---|---|
contentVersion |
string |
Pokud je součástí, musí se shodovat s 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í relativním k nadřazené. Pokud byla nadřazená šablona propojena se š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ých a relativních identifikátorů URI. |
uri |
string |
Identifikátor URI šablony, která se má nasadit. Použijte vlastnost URI nebo ID, ale ne obě vlastnosti. |
ZoneMapping
Name | Typ | Description |
---|---|---|
location |
string |
Umístění mapování zón. |
zones |
string[] |