Deployments - Create Or Update At Tenant Scope

Menyebarkan sumber daya di cakupan penyewa.
Anda dapat menyediakan templat dan parameter langsung dalam permintaan atau tautan ke file JSON.

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

Parameter URI

Name In Required Type Description
deploymentName
path True
  • string

Nama penyebaran.

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

api-version
query True
  • string

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Name Required Type Description
location True
  • string

Lokasi untuk menyimpan data penyebaran.

properties True

Properti penyebaran.

tags
  • object

Tag penyebaran

Respons

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

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

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

Definisi

Alias

Jenis alias.

AliasPath

Jenis jalur untuk alias.

AliasPathAttributes

Atribut token yang dimaksud jalur alias.

AliasPathMetadata
AliasPathTokenType

Jenis token yang dimaksud jalur alias.

AliasPattern

Jenis pola untuk jalur alias.

AliasPatternType

Jenis pola alias

AliasType

Jenis alias.

ApiProfile
BasicDependency

Informasi dependensi penyebaran.

CloudError

Respons kesalahan untuk permintaan manajemen sumber daya.

DebugSetting

Pengaturan debug.

Dependency

Informasi dependensi penyebaran.

DeploymentExtended

Informasi 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 Selesai, 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.

DeploymentProperties

Properti penyebaran.

DeploymentPropertiesExtended

Properti penyebaran dengan detail tambahan.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

ErrorResponse

Respons Kesalahan

ExpressionEvaluationOptions

Menentukan apakah ekspresi templat dievaluasi dalam cakupan templat induk atau templat berlapis.

ExpressionEvaluationOptionsScopeType

Cakupan yang akan digunakan untuk evaluasi parameter, variabel, dan fungsi dalam templat berlapis.

OnErrorDeployment

Penyebaran pada perilaku kesalahan.

OnErrorDeploymentExtended

Penyebaran pada perilaku kesalahan dengan detail tambahan.

OnErrorDeploymentType

Penyebaran pada jenis perilaku kesalahan. Nilai yang mungkin adalah LastSuccessful dan SpecificDeployment.

ParametersLink

Entitas yang mewakili referensi ke parameter penyebaran.

Provider

Informasi penyedia sumber daya.

ProviderAuthorizationConsentState

Status persetujuan otorisasi penyedia.

ProviderExtendedLocation

Lokasi penyedia diperluas.

ProviderResourceType

Jenis sumber daya yang dikelola oleh penyedia sumber daya.

ProvisioningState

Menunjukkan status penyediaan.

ResourceReference

Model Id sumber daya.

ScopedDeployment

Parameter operasi penyebaran.

TemplateLink

Entitas yang mewakili referensi ke templat.

ZoneMapping

Alias

Jenis alias.

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

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

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

Name Type Description
attributes

Atribut token yang dimaksud jalur alias.

type

Jenis token yang dimaksud jalur alias.

AliasPathTokenType

Jenis token yang dimaksud jalur alias.

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

Name Type Description
phrase
  • string

Frasa pola alias.

type

Jenis pola alias

variable
  • string

Variabel pola alias.

AliasPatternType

Jenis pola alias

Name Type Description
Extract
  • string

Ekstrak adalah satu-satunya nilai yang diizinkan.

NotSpecified
  • string

Tidak Ditentukan tidak diperbolehkan.

AliasType

Jenis alias.

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

Name Type Description
apiVersion
  • string

Versi API.

profileVersion
  • string

Versi profil.

BasicDependency

Informasi dependensi penyebaran.

Name Type Description
id
  • string

ID dependensi.

resourceName
  • string

Nama sumber daya dependensi.

resourceType
  • string

Jenis sumber daya dependensi.

CloudError

Respons kesalahan untuk permintaan manajemen sumber daya.

Name Type Description
error

Respons Kesalahan
Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.)

DebugSetting

Pengaturan debug.

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

Name Type Description
dependsOn

Daftar dependensi.

id
  • string

ID dependensi.

resourceName
  • string

Nama sumber daya dependensi.

resourceType
  • string

Jenis sumber daya dependensi.

DeploymentExtended

Informasi penyebaran.

Name Type Description
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 Selesai, 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.

Name Type Description
Complete
  • string
Incremental
  • string

DeploymentProperties

Properti penyebaran.

Name Type Description
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 Selesai, 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.

Name Type Description
correlationId
  • string

ID korelasi penyebaran.

debugSetting

Pengaturan debug penyebaran.

dependencies

Daftar dependensi penyebaran.

duration
  • string

Durasi penyebaran templat.

error

Respons Kesalahan
Kesalahan penyebaran.

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

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.

Name Type Description
info
  • object

Info tambahan.

type
  • string

Jenis info tambahan.

ErrorResponse

Respons Kesalahan

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

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

Name Type Description
Inner
  • string
NotSpecified
  • string
Outer
  • string

OnErrorDeployment

Penyebaran pada perilaku kesalahan.

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

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

Name Type Description
LastSuccessful
  • string
SpecificDeployment
  • string

Entitas yang mewakili referensi ke parameter penyebaran.

Name Type Description
contentVersion
  • string

Jika disertakan, harus cocok dengan ContentVersion dalam templat.

uri
  • string

URI file parameter.

Provider

Informasi penyedia sumber daya.

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

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

ProviderExtendedLocation

Lokasi penyedia diperluas.

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

Name Type Description
aliases

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.

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

Model Id sumber daya.

Name Type Description
id
  • string

Id sumber daya yang sepenuhnya memenuhi syarat.

ScopedDeployment

Parameter operasi penyebaran.

Name Type Description
location
  • string

Lokasi untuk menyimpan data penyebaran.

properties

Properti penyebaran.

tags
  • object

Tag penyebaran

Entitas yang mewakili referensi ke templat.

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

Name Type Description
location
  • string

Lokasi pemetaan zona.

zones
  • string[]