Deployments - Create Or Update At Subscription Scope
Menyebarkan sumber daya pada cakupan langganan.
Anda dapat menyediakan templat dan parameter langsung dalam permintaan atau tautan ke file JSON.
PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
deployment
|
path | True |
string |
Nama penyebaran. Pola regex: |
subscription
|
path | True |
string |
ID langganan Microsoft Azure. |
api-version
|
query | True |
string |
Versi API yang digunakan untuk operasi ini. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
properties | True |
Properti penyebaran. |
|
location |
string |
Lokasi untuk menyimpan data penyebaran. |
|
tags |
object |
Tag penyebaran |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
OK - Mengembalikan informasi tentang penyebaran, termasuk status provisi. |
|
201 Created |
Dibuat - Mengembalikan informasi tentang penyebaran, termasuk status provisi. |
|
Other Status Codes |
Respons kesalahan yang menjelaskan mengapa operasi gagal. |
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory
Jenis:
oauth2
Alur:
implicit
URL Otorisasi:
https://login.microsoftonline.com/common/oauth2/authorize
Cakupan
Nama | Deskripsi |
---|---|
user_impersonation | meniru akun pengguna Anda |
Contoh
Create a deployment that will deploy a templateSpec with the given resourceId
Permintaan sampel
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"
}
}
Respon sampel
{
"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": []
}
}
Definisi
Nama | Deskripsi |
---|---|
Alias |
Jenis alias. |
Alias |
Jenis jalur untuk alias. |
Alias |
Atribut token yang dimaksud jalur alias. |
Alias |
|
Alias |
Jenis token yang dimaksud jalur alias. |
Alias |
Jenis pola untuk jalur alias. |
Alias |
Jenis pola alias |
Alias |
Jenis alias. |
Api |
|
Basic |
Informasi dependensi penyebaran. |
Cloud |
Respons kesalahan untuk permintaan manajemen sumber daya. |
Debug |
Pengaturan debug. |
Dependency |
Informasi dependensi penyebaran. |
Deployment |
Parameter operasi penyebaran. |
Deployment |
Informasi penyebaran. |
Deployment |
Mode yang digunakan untuk menyebarkan sumber daya. Nilai ini dapat berupa Inkremental atau Complete. Dalam mode Inkremental, sumber daya disebarkan tanpa menghapus sumber daya yang ada yang tidak disertakan dalam templat. Dalam mode Lengkap, sumber daya disebarkan dan sumber daya yang ada dalam grup sumber daya yang tidak disertakan dalam templat dihapus. Berhati-hatilah saat menggunakan mode Lengkap karena Anda mungkin secara tidak sengaja menghapus sumber daya. |
Deployment |
Properti penyebaran. |
Deployment |
Properti penyebaran dengan detail tambahan. |
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Respons Kesalahan |
Expression |
Menentukan apakah ekspresi templat dievaluasi dalam cakupan templat induk atau templat berlapis. |
Expression |
Cakupan yang akan digunakan untuk evaluasi parameter, variabel, dan fungsi dalam templat berlapis. |
On |
Penyebaran pada perilaku kesalahan. |
On |
Penyebaran pada perilaku kesalahan dengan detail tambahan. |
On |
Penyebaran pada jenis perilaku kesalahan. Nilai yang mungkin adalah LastSuccessful dan SpecificDeployment. |
Parameters |
Entitas yang mewakili referensi ke parameter penyebaran. |
Provider |
Informasi penyedia sumber daya. |
Provider |
Status persetujuan otorisasi penyedia. |
Provider |
Lokasi penyedia diperluas. |
Provider |
Jenis sumber daya yang dikelola oleh penyedia sumber daya. |
Provisioning |
Menunjukkan status penyediaan. |
Resource |
Model Id sumber daya. |
Template |
Entitas yang mewakili referensi ke templat. |
Zone |
Alias
Jenis alias.
Nama | Jenis | Deskripsi |
---|---|---|
defaultMetadata |
Metadata jalur alias default. Berlaku untuk jalur default dan ke jalur alias apa pun yang tidak memiliki metadata |
|
defaultPath |
string |
Jalur default untuk alias. |
defaultPattern |
Pola default untuk alias. |
|
name |
string |
Nama alias. |
paths |
Jalur untuk alias. |
|
type |
Jenis alias. |
AliasPath
Jenis jalur untuk alias.
Nama | Jenis | Deskripsi |
---|---|---|
apiVersions |
string[] |
Versi API. |
metadata |
Metadata jalur alias. Jika hilang, kembali ke metadata default alias. |
|
path |
string |
Jalur alias. |
pattern |
Pola untuk jalur alias. |
AliasPathAttributes
Atribut token yang dimaksud jalur alias.
Nama | Jenis | Deskripsi |
---|---|---|
Modifiable |
string |
Token yang dimaksud jalur alias dapat dimodifikasi oleh kebijakan dengan efek 'modifikasi'. |
None |
string |
Token yang dimaksud jalur alias tidak memiliki atribut. |
AliasPathMetadata
Nama | Jenis | Deskripsi |
---|---|---|
attributes |
Atribut token yang dimaksud jalur alias. |
|
type |
Jenis token yang dimaksud jalur alias. |
AliasPathTokenType
Jenis token yang dimaksud jalur alias.
Nama | Jenis | Deskripsi |
---|---|---|
Any |
string |
Jenis token bisa apa saja. |
Array |
string |
Jenis token adalah array. |
Boolean |
string |
Jenis token adalah boolean. |
Integer |
string |
Jenis token adalah bilangan bulat. |
NotSpecified |
string |
Jenis token tidak ditentukan. |
Number |
string |
Jenis token adalah angka. |
Object |
string |
Jenis token adalah objek. |
String |
string |
Jenis token adalah string. |
AliasPattern
Jenis pola untuk jalur alias.
Nama | Jenis | Deskripsi |
---|---|---|
phrase |
string |
Frasa pola alias. |
type |
Jenis pola alias |
|
variable |
string |
Variabel pola alias. |
AliasPatternType
Jenis pola alias
Nama | Jenis | Deskripsi |
---|---|---|
Extract |
string |
Ekstrak adalah satu-satunya nilai yang diizinkan. |
NotSpecified |
string |
Tidak Ditentukan tidak diperbolehkan. |
AliasType
Jenis alias.
Nama | Jenis | Deskripsi |
---|---|---|
Mask |
string |
Nilai alias adalah rahasia. |
NotSpecified |
string |
Jenis alias tidak diketahui (sama dengan tidak menyediakan jenis alias). |
PlainText |
string |
Nilai alias bukan rahasia. |
ApiProfile
Nama | Jenis | Deskripsi |
---|---|---|
apiVersion |
string |
Versi API. |
profileVersion |
string |
Versi profil. |
BasicDependency
Informasi dependensi penyebaran.
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
ID dependensi. |
resourceName |
string |
Nama sumber daya dependensi. |
resourceType |
string |
Jenis sumber daya dependensi. |
CloudError
Respons kesalahan untuk permintaan manajemen sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
error |
Respons Kesalahan |
DebugSetting
Pengaturan debug.
Nama | Jenis | Deskripsi |
---|---|---|
detailLevel |
string |
Menentukan jenis informasi yang akan dicatat untuk penelusuran kesalahan. Nilai yang diizinkan tidak ada, requestContent, responseContent, atau requestContent dan responseContent yang dipisahkan oleh koma. Defaultnya tidak ada. Saat mengatur nilai ini, pertimbangkan dengan cermat jenis informasi yang Anda berikan selama penyebaran. Dengan mencatat informasi tentang permintaan atau respons, Anda berpotensi mengekspos data sensitif yang diambil melalui operasi penyebaran. |
Dependency
Informasi dependensi penyebaran.
Nama | Jenis | Deskripsi |
---|---|---|
dependsOn |
Daftar dependensi. |
|
id |
string |
ID dependensi. |
resourceName |
string |
Nama sumber daya dependensi. |
resourceType |
string |
Jenis sumber daya dependensi. |
Deployment
Parameter operasi penyebaran.
Nama | Jenis | Deskripsi |
---|---|---|
location |
string |
Lokasi untuk menyimpan data penyebaran. |
properties |
Properti penyebaran. |
|
tags |
object |
Tag penyebaran |
DeploymentExtended
Informasi penyebaran.
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
ID penyebaran. |
location |
string |
lokasi penyebaran. |
name |
string |
Nama penyebaran. |
properties |
Properti penyebaran. |
|
tags |
object |
Tag penyebaran |
type |
string |
Jenis penyebaran. |
DeploymentMode
Mode yang digunakan untuk menyebarkan sumber daya. Nilai ini dapat berupa Inkremental atau Complete. Dalam mode Inkremental, sumber daya disebarkan tanpa menghapus sumber daya yang ada yang tidak disertakan dalam templat. Dalam mode Lengkap, sumber daya disebarkan dan sumber daya yang ada dalam grup sumber daya yang tidak disertakan dalam templat dihapus. Berhati-hatilah saat menggunakan mode Lengkap karena Anda mungkin secara tidak sengaja menghapus sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
Complete |
string |
|
Incremental |
string |
DeploymentProperties
Properti penyebaran.
Nama | Jenis | Deskripsi |
---|---|---|
debugSetting |
Pengaturan debug penyebaran. |
|
expressionEvaluationOptions |
Menentukan apakah ekspresi templat dievaluasi dalam cakupan templat induk atau templat berlapis. Hanya berlaku untuk templat berlapis. Jika tidak ditentukan, nilai defaultnya adalah luar. |
|
mode |
Mode yang digunakan untuk menyebarkan sumber daya. Nilai ini dapat berupa Inkremental atau Complete. Dalam mode Inkremental, sumber daya disebarkan tanpa menghapus sumber daya yang ada yang tidak disertakan dalam templat. Dalam mode Lengkap, sumber daya disebarkan dan sumber daya yang ada dalam grup sumber daya yang tidak disertakan dalam templat dihapus. Berhati-hatilah saat menggunakan mode Lengkap karena Anda mungkin secara tidak sengaja menghapus sumber daya. |
|
onErrorDeployment |
Penyebaran pada perilaku kesalahan. |
|
parameters |
object |
Pasangan nama dan nilai yang menentukan parameter penyebaran untuk templat. Anda menggunakan elemen ini ketika Anda ingin memberikan nilai parameter langsung dalam permintaan daripada menautkan ke file parameter yang ada. Gunakan properti parametersLink atau properti parameter, tetapi tidak keduanya. Ini bisa menjadi JObject atau string JSON yang terbentuk dengan baik. |
parametersLink |
URI file parameter. Anda menggunakan elemen ini untuk menautkan ke file parameter yang ada. Gunakan properti parametersLink atau properti parameter, tetapi tidak keduanya. |
|
template |
object |
Konten templat. Anda menggunakan elemen ini saat Anda ingin meneruskan sintaks templat langsung dalam permintaan daripada menautkan ke templat yang ada. Ini bisa menjadi string JObject atau JSON yang terbentuk dengan baik. Gunakan properti templateLink atau properti templat, tetapi tidak keduanya. |
templateLink |
URI templat. Gunakan properti templateLink atau properti templat, tetapi tidak keduanya. |
DeploymentPropertiesExtended
Properti penyebaran dengan detail tambahan.
Nama | Jenis | Deskripsi |
---|---|---|
correlationId |
string |
ID korelasi penyebaran. |
debugSetting |
Pengaturan debug penyebaran. |
|
dependencies |
Daftar dependensi penyebaran. |
|
duration |
string |
Durasi penyebaran templat. |
error |
Respons Kesalahan |
|
mode |
Mode penyebaran. Nilai yang mungkin bertahap dan Lengkap. |
|
onErrorDeployment |
Penyebaran pada perilaku kesalahan. |
|
outputResources |
Array sumber daya yang disediakan. |
|
outputs |
object |
Pasangan kunci/nilai yang mewakili output penyebaran. |
parameters |
object |
Parameter penyebaran. |
parametersLink |
URI yang mereferensikan parameter. |
|
providers |
Provider[] |
Daftar penyedia sumber daya yang diperlukan untuk penyebaran. |
provisioningState |
Menunjukkan status penyediaan. |
|
templateHash |
string |
Hash yang diproduksi untuk templat. |
templateLink |
URI yang mereferensikan templat. |
|
timestamp |
string |
Tanda waktu penyebaran templat. |
validatedResources |
Array sumber daya yang divalidasi. |
ErrorAdditionalInfo
Info tambahan kesalahan manajemen sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
info |
object |
Info tambahan. |
type |
string |
Jenis info tambahan. |
ErrorResponse
Respons Kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
additionalInfo |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ExpressionEvaluationOptions
Menentukan apakah ekspresi templat dievaluasi dalam cakupan templat induk atau templat berlapis.
Nama | Jenis | Deskripsi |
---|---|---|
scope |
Cakupan yang akan digunakan untuk evaluasi parameter, variabel, dan fungsi dalam templat berlapis. |
ExpressionEvaluationOptionsScopeType
Cakupan yang akan digunakan untuk evaluasi parameter, variabel, dan fungsi dalam templat berlapis.
Nama | Jenis | Deskripsi |
---|---|---|
Inner |
string |
|
NotSpecified |
string |
|
Outer |
string |
OnErrorDeployment
Penyebaran pada perilaku kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
deploymentName |
string |
Penyebaran yang akan digunakan pada kasus kesalahan. |
type |
Penyebaran pada jenis perilaku kesalahan. Nilai yang mungkin adalah LastSuccessful dan SpecificDeployment. |
OnErrorDeploymentExtended
Penyebaran pada perilaku kesalahan dengan detail tambahan.
Nama | Jenis | Deskripsi |
---|---|---|
deploymentName |
string |
Penyebaran yang akan digunakan pada kasus kesalahan. |
provisioningState |
string |
Status penyediaan untuk penyebaran pada kesalahan. |
type |
Penyebaran pada jenis perilaku kesalahan. Nilai yang mungkin adalah LastSuccessful dan SpecificDeployment. |
OnErrorDeploymentType
Penyebaran pada jenis perilaku kesalahan. Nilai yang mungkin adalah LastSuccessful dan SpecificDeployment.
Nama | Jenis | Deskripsi |
---|---|---|
LastSuccessful |
string |
|
SpecificDeployment |
string |
ParametersLink
Entitas yang mewakili referensi ke parameter penyebaran.
Nama | Jenis | Deskripsi |
---|---|---|
contentVersion |
string |
Jika disertakan, harus cocok dengan ContentVersion dalam templat. |
uri |
string |
URI file parameter. |
Provider
Informasi penyedia sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
ID penyedia. |
namespace |
string |
Namespace penyedia sumber daya. |
providerAuthorizationConsentState |
Status persetujuan otorisasi penyedia. |
|
registrationPolicy |
string |
Kebijakan pendaftaran penyedia sumber daya. |
registrationState |
string |
Status pendaftaran penyedia sumber daya. |
resourceTypes |
Kumpulan jenis sumber daya penyedia. |
ProviderAuthorizationConsentState
Status persetujuan otorisasi penyedia.
Nama | Jenis | Deskripsi |
---|---|---|
Consented |
string |
|
NotRequired |
string |
|
NotSpecified |
string |
|
Required |
string |
ProviderExtendedLocation
Lokasi penyedia diperluas.
Nama | Jenis | Deskripsi |
---|---|---|
extendedLocations |
string[] |
Lokasi yang diperluas untuk lokasi azure. |
location |
string |
Lokasi azure. |
type |
string |
Jenis lokasi yang diperluas. |
ProviderResourceType
Jenis sumber daya yang dikelola oleh penyedia sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
aliases |
Alias[] |
Alias yang didukung oleh jenis sumber daya ini. |
apiProfiles |
Profil API untuk penyedia sumber daya. |
|
apiVersions |
string[] |
Versi API. |
capabilities |
string |
Kemampuan tambahan yang ditawarkan oleh jenis sumber daya ini. |
defaultApiVersion |
string |
Versi API default. |
locationMappings |
Pemetaan lokasi yang didukung oleh jenis sumber daya ini. |
|
locations |
string[] |
Kumpulan lokasi tempat jenis sumber daya ini dapat dibuat. |
properties |
object |
Properti. |
resourceType |
string |
Jenis sumber daya. |
zoneMappings |
ProvisioningState
Menunjukkan status penyediaan.
Nama | Jenis | Deskripsi |
---|---|---|
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 sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
Id sumber daya yang sepenuhnya memenuhi syarat. |
TemplateLink
Entitas yang mewakili referensi ke templat.
Nama | Jenis | Deskripsi |
---|---|---|
contentVersion |
string |
Jika disertakan, harus cocok dengan ContentVersion dalam templat. |
id |
string |
Id sumber daya dari Spesifikasi Templat. Gunakan properti id atau uri, tetapi tidak keduanya. |
queryString |
string |
String kueri (misalnya, token SAS) yang akan digunakan dengan templateLink URI. |
relativePath |
string |
Properti relativePath dapat digunakan untuk menyebarkan templat yang ditautkan di lokasi yang relatif terhadap induk. Jika templat induk ditautkan dengan TemplateSpec, ini akan mereferensikan artefak di TemplateSpec. Jika induk ditautkan dengan URI, penyebaran anak akan menjadi kombinasi dari URI induk dan relativePath |
uri |
string |
URI templat yang akan disebarkan. Gunakan properti uri atau id, tetapi tidak keduanya. |
ZoneMapping
Nama | Jenis | Deskripsi |
---|---|---|
location |
string |
Lokasi pemetaan zona. |
zones |
string[] |