Deployments - Create Or Update At Subscription Scope

Kaynakları abonelik kapsamında dağıtır.
Şablonu ve parametreleri doğrudan istekte sağlayabilir veya JSON dosyalarına bağlanabilirsiniz.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
deploymentName
path True

string

Dağıtımın adı.

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

subscriptionId
path True

string

Microsoft Azure abonelik kimliği.

api-version
query True

string

Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name Gerekli Tür Description
properties True

DeploymentProperties

Dağıtım özellikleri.

location

string

Dağıtım verilerini depolama konumu.

tags

object

Dağıtım etiketleri

Yanıtlar

Name Tür Description
200 OK

DeploymentExtended

Tamam - Sağlama durumu da dahil olmak üzere dağıtım hakkındaki bilgileri döndürür.

201 Created

DeploymentExtended

Oluşturuldu - Sağlama durumu da dahil olmak üzere dağıtım hakkındaki bilgileri döndürür.

Other Status Codes

CloudError

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

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 kullanıcı hesabınızın kimliğine bürünme

Örnekler

Create a deployment that will deploy a templateSpec with the given resourceId

Sample Request

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

Sample Response

{
  "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": []
  }
}

Tanımlar

Name Description
Alias

Diğer ad türü.

AliasPath

Diğer ad için yolların türü.

AliasPathAttributes

Diğer ad yolunun başvurduğunu belirtecin öznitelikleri.

AliasPathMetadata
AliasPathTokenType

Diğer ad yolunun başvurduğunu belirtecin türü.

AliasPattern

Diğer ad yolu için desenin türü.

AliasPatternType

Diğer ad deseninin türü

AliasType

Diğer adın türü.

ApiProfile
BasicDependency

Dağıtım bağımlılığı bilgileri.

CloudError

Kaynak yönetimi isteği için hata yanıtı.

DebugSetting

Hata ayıklama ayarı.

Dependency

Dağıtım bağımlılığı bilgileri.

Deployment

Dağıtım işlemi parametreleri.

DeploymentExtended

Dağıtım bilgileri.

DeploymentMode

Kaynakları dağıtmak için kullanılan mod. Bu değer Artımlı veya Tamamlandı olabilir. Artımlı modda, kaynaklar şablona dahil edilmeyen mevcut kaynaklar silinmeden dağıtılır. Tamamlandı modunda kaynaklar dağıtılır ve kaynak grubundaki şablona dahil olmayan mevcut kaynaklar silinir. Kaynakları istemeden sildiğinizden, Tamamlama modunu kullanırken dikkatli olun.

DeploymentProperties

Dağıtım özellikleri.

DeploymentPropertiesExtended

Ek ayrıntılarla birlikte dağıtım özellikleri.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorResponse

Hata Yanıtı

ExpressionEvaluationOptions

Şablon ifadelerinin üst şablon kapsamında mı yoksa iç içe yerleştirilmiş şablon kapsamında mı değerlendirildiğini belirtir.

ExpressionEvaluationOptionsScopeType

İç içe geçmiş bir şablondaki parametrelerin, değişkenlerin ve işlevlerin değerlendirilmesi için kullanılacak kapsam.

OnErrorDeployment

Hata davranışında dağıtım.

OnErrorDeploymentExtended

Ek ayrıntılarla birlikte hata davranışında dağıtım.

OnErrorDeploymentType

Hata davranışı türündeki dağıtım. Olası değerler LastSuccessful ve SpecificDeployment değerleridir.

ParametersLink

Dağıtım parametrelerine başvuruyu temsil eden varlık.

Provider

Kaynak sağlayıcısı bilgileri.

ProviderAuthorizationConsentState

Sağlayıcı yetkilendirme onayı durumu.

ProviderExtendedLocation

Sağlayıcı genişletilmiş konumu.

ProviderResourceType

Kaynak sağlayıcısı tarafından yönetilen kaynak türü.

ProvisioningState

Sağlama durumunu belirtir.

ResourceReference

Kaynak kimliği modeli.

TemplateLink

Şablon başvuruyu temsil eden varlık.

ZoneMapping

Alias

Diğer ad türü.

Name Tür Description
defaultMetadata

AliasPathMetadata

Varsayılan diğer ad yolu meta verileri. Varsayılan yol ve meta verileri olmayan diğer ad yolları için geçerlidir

defaultPath

string

Diğer ad için varsayılan yol.

defaultPattern

AliasPattern

Diğer ad için varsayılan desen.

name

string

Diğer ad.

paths

AliasPath[]

Diğer adın yolları.

type

AliasType

Diğer adın türü.

AliasPath

Diğer ad için yolların türü.

Name Tür Description
apiVersions

string[]

API sürümleri.

metadata

AliasPathMetadata

Diğer ad yolunun meta verileri. Eksikse diğer adın varsayılan meta verilerine geri dönün.

path

string

Diğer adın yolu.

pattern

AliasPattern

Diğer ad yolunun deseni.

AliasPathAttributes

Diğer ad yolunun başvurduğunu belirtecin öznitelikleri.

Name Tür Description
Modifiable

string

Diğer ad yolunun başvurduğunu belirteç, 'değiştir' etkisi olan ilkeler tarafından değiştirilebilir.

None

string

Diğer ad yolunun başvurduğunu belirtecin özniteliği yoktur.

AliasPathMetadata

Name Tür Description
attributes

AliasPathAttributes

Diğer ad yolunun başvurduğunu belirtecin öznitelikleri.

type

AliasPathTokenType

Diğer ad yolunun başvurduğunu belirtecin türü.

AliasPathTokenType

Diğer ad yolunun başvurduğunu belirtecin türü.

Name Tür Description
Any

string

Belirteç türü herhangi bir şey olabilir.

Array

string

Belirteç türü dizidir.

Boolean

string

Belirteç türü boole değeridir.

Integer

string

Belirteç türü tamsayıdır.

NotSpecified

string

Belirteç türü belirtilmemiş.

Number

string

Belirteç türü sayıdır.

Object

string

Belirteç türü nesnedir.

String

string

Belirteç türü dizedir.

AliasPattern

Diğer ad yolu için desenin türü.

Name Tür Description
phrase

string

Diğer ad deseni tümceciği.

type

AliasPatternType

Diğer ad deseninin türü

variable

string

Diğer ad desen değişkeni.

AliasPatternType

Diğer ad deseninin türü

Name Tür Description
Extract

string

Ayıkla, izin verilen tek değerdir.

NotSpecified

string

NotSpecified'a izin verilmiyor.

AliasType

Diğer adın türü.

Name Tür Description
Mask

string

Diğer ad değeri gizlidir.

NotSpecified

string

Diğer ad türü bilinmiyor (diğer ad türü sağlamamayla aynıdır).

PlainText

string

Diğer ad değeri gizli değil.

ApiProfile

Name Tür Description
apiVersion

string

API sürümü.

profileVersion

string

Profil sürümü.

BasicDependency

Dağıtım bağımlılığı bilgileri.

Name Tür Description
id

string

Bağımlılığın kimliği.

resourceName

string

Bağımlılık kaynağı adı.

resourceType

string

Bağımlılık kaynak türü.

CloudError

Kaynak yönetimi isteği için hata yanıtı.

Name Tür Description
error

ErrorResponse

Hata Yanıtı
Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıtı biçimini de izler.)

DebugSetting

Hata ayıklama ayarı.

Name Tür Description
detailLevel

string

Hata ayıklama için günlüğe kaydedilecek bilgi türünü belirtir. İzin verilen değerler hiçbiri, requestContent, responseContent veya virgülle ayrılmış requestContent ve responseContent değerleridir. Varsayılan değer none'dır. Bu değeri ayarlarken, dağıtım sırasında geçirdiğiniz bilgi türünü dikkatle göz önünde bulundurun. İstek veya yanıt hakkındaki bilgileri günlüğe kaydederek, dağıtım işlemleri aracılığıyla alınan hassas verileri potansiyel olarak kullanıma açabilirsiniz.

Dependency

Dağıtım bağımlılığı bilgileri.

Name Tür Description
dependsOn

BasicDependency[]

Bağımlılık listesi.

id

string

Bağımlılığın kimliği.

resourceName

string

Bağımlılık kaynağı adı.

resourceType

string

Bağımlılık kaynak türü.

Deployment

Dağıtım işlemi parametreleri.

Name Tür Description
location

string

Dağıtım verilerini depolama konumu.

properties

DeploymentProperties

Dağıtım özellikleri.

tags

object

Dağıtım etiketleri

DeploymentExtended

Dağıtım bilgileri.

Name Tür Description
id

string

Dağıtımın kimliği.

location

string

dağıtımın konumu.

name

string

Dağıtımın adı.

properties

DeploymentPropertiesExtended

Dağıtım özellikleri.

tags

object

Dağıtım etiketleri

type

string

Dağıtımın türü.

DeploymentMode

Kaynakları dağıtmak için kullanılan mod. Bu değer Artımlı veya Tamamlandı olabilir. Artımlı modda, kaynaklar şablona dahil edilmeyen mevcut kaynaklar silinmeden dağıtılır. Tamamlandı modunda kaynaklar dağıtılır ve kaynak grubundaki şablona dahil olmayan mevcut kaynaklar silinir. Kaynakları istemeden sildiğinizden, Tamamlama modunu kullanırken dikkatli olun.

Name Tür Description
Complete

string

Incremental

string

DeploymentProperties

Dağıtım özellikleri.

Name Tür Description
debugSetting

DebugSetting

Dağıtımın hata ayıklama ayarı.

expressionEvaluationOptions

ExpressionEvaluationOptions

Şablon ifadelerinin üst şablon kapsamında mı yoksa iç içe yerleştirilmiş şablon kapsamında mı değerlendirildiğini belirtir. Yalnızca iç içe yerleştirilmiş şablonlar için geçerlidir. Belirtilmezse, varsayılan değer dıştır.

mode

DeploymentMode

Kaynakları dağıtmak için kullanılan mod. Bu değer Artımlı veya Tamamlandı olabilir. Artımlı modda, kaynaklar şablona dahil edilmeyen mevcut kaynaklar silinmeden dağıtılır. Tamamlandı modunda kaynaklar dağıtılır ve kaynak grubundaki şablona dahil olmayan mevcut kaynaklar silinir. Kaynakları istemeden sildiğinizden, Tamamlama modunu kullanırken dikkatli olun.

onErrorDeployment

OnErrorDeployment

Hata davranışında dağıtım.

parameters

object

Şablon için dağıtım parametrelerini tanımlayan ad ve değer çiftleri. Parametre değerlerini varolan bir parametre dosyasına bağlamak yerine doğrudan istekte sağlamak istediğinizde bu öğeyi kullanırsınız. parametersLink özelliğini veya parameters özelliğini kullanın, ancak ikisini birden kullanmayın. Bu bir JObject veya iyi biçimlendirilmiş bir JSON dizesi olabilir.

parametersLink

ParametersLink

Parametre dosyasının URI'sini. Var olan bir parametre dosyasına bağlanmak için bu öğeyi kullanırsınız. parametersLink özelliğini veya parameters özelliğini kullanın, ancak ikisini birden kullanmayın.

template

object

Şablon içeriği. Şablon söz dizimini varolan bir şablona bağlamak yerine doğrudan istekte geçirmek istediğinizde bu öğeyi kullanırsınız. JObject veya iyi biçimlendirilmiş bir JSON dizesi olabilir. templateLink özelliğini veya template özelliğini kullanın, ancak ikisini birden kullanmayın.

templateLink

TemplateLink

Şablonun URI'si. templateLink özelliğini veya template özelliğini kullanın, ancak ikisini birden kullanmayın.

DeploymentPropertiesExtended

Ek ayrıntılarla birlikte dağıtım özellikleri.

Name Tür Description
correlationId

string

Dağıtımın bağıntı kimliği.

debugSetting

DebugSetting

Dağıtımın hata ayıklama ayarı.

dependencies

Dependency[]

Dağıtım bağımlılıklarının listesi.

duration

string

Şablon dağıtımının süresi.

error

ErrorResponse

Hata Yanıtı
Dağıtım hatası.

mode

DeploymentMode

Dağıtım modu. Olası değerler Artımlı ve Tamamlandı'dır.

onErrorDeployment

OnErrorDeploymentExtended

Hata davranışında dağıtım.

outputResources

ResourceReference[]

Sağlanan kaynak dizisi.

outputs

object

Dağıtım çıkışını temsil eden anahtar/değer çiftleri.

parameters

object

Dağıtım parametreleri.

parametersLink

ParametersLink

Parametrelere başvuran URI.

providers

Provider[]

Dağıtım için gereken kaynak sağlayıcılarının listesi.

provisioningState

ProvisioningState

Sağlama durumunu belirtir.

templateHash

string

Şablon için oluşturulan karma.

templateLink

TemplateLink

Şablona başvuran URI.

timestamp

string

Şablon dağıtımının zaman damgası.

validatedResources

ResourceReference[]

Doğrulanmış kaynak dizisi.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorResponse

Hata Yanıtı

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.

code

string

Hata kodu.

details

ErrorResponse[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi.

ExpressionEvaluationOptions

Şablon ifadelerinin üst şablon kapsamında mı yoksa iç içe yerleştirilmiş şablon kapsamında mı değerlendirildiğini belirtir.

Name Tür Description
scope

ExpressionEvaluationOptionsScopeType

İç içe geçmiş bir şablondaki parametrelerin, değişkenlerin ve işlevlerin değerlendirilmesi için kullanılacak kapsam.

ExpressionEvaluationOptionsScopeType

İç içe geçmiş bir şablondaki parametrelerin, değişkenlerin ve işlevlerin değerlendirilmesi için kullanılacak kapsam.

Name Tür Description
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Hata davranışında dağıtım.

Name Tür Description
deploymentName

string

Hata durumunda kullanılacak dağıtım.

type

OnErrorDeploymentType

Hata davranışı türündeki dağıtım. Olası değerler LastSuccessful ve SpecificDeployment değerleridir.

OnErrorDeploymentExtended

Ek ayrıntılarla birlikte hata davranışında dağıtım.

Name Tür Description
deploymentName

string

Hata durumunda kullanılacak dağıtım.

provisioningState

string

Hata dağıtımı için sağlamanın durumu.

type

OnErrorDeploymentType

Hata davranışı türünde dağıtım. Olası değerler LastSuccessful ve SpecificDeployment değerleridir.

OnErrorDeploymentType

Hata davranışı türündeki dağıtım. Olası değerler LastSuccessful ve SpecificDeployment değerleridir.

Name Tür Description
LastSuccessful

string

SpecificDeployment

string

Dağıtım parametrelerine başvuruyu temsil eden varlık.

Name Tür Description
contentVersion

string

Varsa, şablondaki ContentVersion ile eşleşmelidir.

uri

string

Parametre dosyasının URI'sini.

Provider

Kaynak sağlayıcısı bilgileri.

Name Tür Description
id

string

Sağlayıcı kimliği.

namespace

string

Kaynak sağlayıcısının ad alanı.

providerAuthorizationConsentState

ProviderAuthorizationConsentState

Sağlayıcı yetkilendirme onayı durumu.

registrationPolicy

string

Kaynak sağlayıcısının kayıt ilkesi.

registrationState

string

Kaynak sağlayıcısının kayıt durumu.

resourceTypes

ProviderResourceType[]

Sağlayıcı kaynak türlerinin koleksiyonu.

ProviderAuthorizationConsentState

Sağlayıcı yetkilendirme onayı durumu.

Name Tür Description
Consented

string

NotRequired

string

NotSpecified

string

Required

string

ProviderExtendedLocation

Sağlayıcı genişletilmiş konumu.

Name Tür Description
extendedLocations

string[]

Azure konumu için genişletilmiş konumlar.

location

string

Azure konumu.

type

string

Genişletilmiş konum türü.

ProviderResourceType

Kaynak sağlayıcısı tarafından yönetilen kaynak türü.

Name Tür Description
aliases

Alias[]

Bu kaynak türü tarafından desteklenen diğer adlar.

apiProfiles

ApiProfile[]

Kaynak sağlayıcısı için API profilleri.

apiVersions

string[]

API sürümü.

capabilities

string

Bu kaynak türü tarafından sunulan ek özellikler.

defaultApiVersion

string

Varsayılan API sürümü.

locationMappings

ProviderExtendedLocation[]

Bu kaynak türü tarafından desteklenen konum eşlemeleri.

locations

string[]

Bu kaynak türünün oluşturulabileceği konum koleksiyonu.

properties

object

Özellikler.

resourceType

string

Kaynak türü.

zoneMappings

ZoneMapping[]

ProvisioningState

Sağlama durumunu belirtir.

Name Tür 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

Kaynak kimliği modeli.

Name Tür Description
id

string

Tam kaynak kimliği.

Şablon başvuruyu temsil eden varlık.

Name Tür Description
contentVersion

string

Varsa, şablondaki ContentVersion ile eşleşmelidir.

id

string

Şablon Belirtiminin kaynak kimliği. Kimlik veya uri özelliğini kullanın, ancak ikisini birden kullanmayın.

queryString

string

templateLink URI'siyle kullanılacak sorgu dizesi (örneğin, sas belirteci).

relativePath

string

relativePath özelliği, bağlı şablonu üst öğeye göre bir konuma dağıtmak için kullanılabilir. Üst şablon bir TemplateSpec ile bağlantılıysa, bu şablon TemplateSpec'teki bir yapıta başvurur. Üst öğe bir URI ile bağlantılıysa, alt dağıtım üst ve relativePath URI'lerinin bir bileşimi olacaktır

uri

string

Dağıtılacak şablonun URI'si. Uri veya id özelliğini kullanın, ancak ikisini birden kullanmayın.

ZoneMapping

Name Tür Description
location

string

Bölge eşlemesinin konumu.

zones

string[]