Deployments - Create Or Update At Tenant Scope

Layanan:: Resource Management

Versi API:: 2025-04-01

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=2025-04-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
deploymentName	path	True	string minLength: 1 maxLength: 64 pattern: ^[-\w\._]+$	Nama pendistribusian.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
location	True	string	Lokasi untuk menyimpan data penyebaran.
properties	True	DeploymentProperties	Properti penyebaran.
tags		object	Tag penyebaran

Respons

Nama	Jenis	Deskripsi
200 OK	DeploymentExtended	Operasi pembaruan 'DeploymentExtended' sumber daya berhasil
201 Created	DeploymentExtended	Resource 'DeploymentExtended' membuat operasi berhasil Header Location: string Retry-After: integer
Other Status Codes	CloudError	Respons kesalahan tak terduga.

Nama

Jenis

Deskripsi

200 OK

DeploymentExtended

Operasi pembaruan 'DeploymentExtended' sumber daya berhasil

201 Created

DeploymentExtended

Resource 'DeploymentExtended' membuat operasi berhasil

Header

Location: string
Retry-After: integer

Other Status Codes

CloudError

Respons kesalahan tak terduga.

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 deployment at tenant scope.

Permintaan sampel

PUT https://management.azure.com/providers/Microsoft.Resources/deployments/tenant-dep01?api-version=2025-04-01

{
  "location": "eastus",
  "properties": {
    "mode": "Incremental",
    "parameters": {},
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    }
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}


import com.azure.resourcemanager.resources.models.DeploymentMode;
import com.azure.resourcemanager.resources.models.DeploymentProperties;
import com.azure.resourcemanager.resources.models.ScopedDeployment;
import com.azure.resourcemanager.resources.models.TemplateLink;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Deployments CreateOrUpdateAtTenantScope.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/
     * PutDeploymentAtTenant.json
     */
    /**
     * Sample code: Create deployment at tenant scope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createDeploymentAtTenantScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().deploymentClient().getDeployments().createOrUpdateAtTenantScope(
            "tenant-dep01",
            new ScopedDeployment().withLocation("eastus")
                .withProperties(new DeploymentProperties()
                    .withTemplateLink(new TemplateLink().withUri("https://example.com/exampleTemplate.json"))
                    .withParameters(mapOf()).withMode(DeploymentMode.INCREMENTAL))
                .withTags(mapOf("tagKey1", "fakeTokenPlaceholder", "tagKey2", "fakeTokenPlaceholder")),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.deployments import DeploymentsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-deployments
# USAGE
    python put_deployment_at_tenant.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeploymentsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.deployments.begin_create_or_update_at_tenant_scope(
        deployment_name="tenant-dep01",
        parameters={
            "location": "eastus",
            "properties": {
                "mode": "Incremental",
                "parameters": {},
                "templateLink": {"uri": "https://example.com/exampleTemplate.json"},
            },
            "tags": {"tagKey1": "tag-value-1", "tagKey2": "tag-value-2"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-04-01/PutDeploymentAtTenant.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdeployments_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armdeployments/v2"
)

// Generated from example definition: 2025-04-01/PutDeploymentAtTenant.json
func ExampleDeploymentsClient_BeginCreateOrUpdateAtTenantScope() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdeployments.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdateAtTenantScope(ctx, "tenant-dep01", armdeployments.ScopedDeployment{
		Location: to.Ptr("eastus"),
		Properties: &armdeployments.DeploymentProperties{
			Mode:       to.Ptr(armdeployments.DeploymentModeIncremental),
			Parameters: map[string]*armdeployments.DeploymentParameter{},
			TemplateLink: &armdeployments.TemplateLink{
				URI: to.Ptr("https://example.com/exampleTemplate.json"),
			},
		},
		Tags: map[string]*string{
			"tagKey1": to.Ptr("tag-value-1"),
			"tagKey2": to.Ptr("tag-value-2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdeployments.DeploymentsClientCreateOrUpdateAtTenantScopeResponse{
	// 	DeploymentExtended: armdeployments.DeploymentExtended{
	// 		Name: to.Ptr("tenant-dep01"),
	// 		Type: to.Ptr("Microsoft.Resources/deployments"),
	// 		ID: to.Ptr("/providers/Microsoft.Resources/deployments/tenant-dep01"),
	// 		Location: to.Ptr("eastus"),
	// 		Properties: &armdeployments.DeploymentPropertiesExtended{
	// 			CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 			Dependencies: []*armdeployments.Dependency{
	// 				{
	// 					DependsOn: []*armdeployments.BasicDependency{
	// 						{
	// 							ID: to.Ptr("/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name"),
	// 							ResourceName: to.Ptr("policy-definition-name"),
	// 							ResourceType: to.Ptr("Microsoft.Authorization/policyDefinitions"),
	// 						},
	// 					},
	// 					ID: to.Ptr("/providers/Microsoft.Authorization/policyAssignments/location-lock"),
	// 					ResourceName: to.Ptr("location-lock"),
	// 					ResourceType: to.Ptr("Microsoft.Authorization/policyAssignments"),
	// 				},
	// 			},
	// 			Duration: to.Ptr("PT1.2970875S"),
	// 			Mode: to.Ptr(armdeployments.DeploymentModeIncremental),
	// 			Parameters: map[string]any{
	// 			},
	// 			Providers: []*armdeployments.Provider{
	// 				{
	// 					Namespace: to.Ptr("Microsoft.Authorization"),
	// 					ResourceTypes: []*armdeployments.ProviderResourceType{
	// 						{
	// 							Locations: []*string{
	// 							},
	// 							ResourceType: to.Ptr("policyDefinitions"),
	// 						},
	// 						{
	// 							Locations: []*string{
	// 							},
	// 							ResourceType: to.Ptr("policyAssignments"),
	// 						},
	// 					},
	// 				},
	// 				{
	// 					Namespace: to.Ptr("Microsoft.Resources"),
	// 					ResourceTypes: []*armdeployments.ProviderResourceType{
	// 						{
	// 							Locations: []*string{
	// 								to.Ptr("eastus"),
	// 							},
	// 							ResourceType: to.Ptr("deployments"),
	// 						},
	// 					},
	// 				},
	// 			},
	// 			ProvisioningState: to.Ptr(armdeployments.ProvisioningStateAccepted),
	// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-24T22:52:38.7895563Z"); return t}()),
	// 		},
	// 		Tags: map[string]*string{
	// 			"tagKey1": to.Ptr("tag-value-1"),
	// 			"tagKey2": to.Ptr("tag-value-2"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DeploymentsClient } = require("@azure/arm-resourcesdeployments");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to you can provide the template and parameters directly in the request or link to JSON files.
 *
 * @summary you can provide the template and parameters directly in the request or link to JSON files.
 * x-ms-original-file: 2025-04-01/PutDeploymentAtTenant.json
 */
async function createDeploymentAtTenantScope() {
  const credential = new DefaultAzureCredential();
  const client = new DeploymentsClient(credential);
  const result = await client.deployments.createOrUpdateAtTenantScope("tenant-dep01", {
    location: "eastus",
    properties: {
      mode: "Incremental",
      parameters: {},
      templateLink: { uri: "https://example.com/exampleTemplate.json" },
    },
    tags: { tagKey1: "tag-value-1", tagKey2: "tag-value-2" },
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:: 200

{
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "location": "eastus",
  "properties": {
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceName": "policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceName": "location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments"
      }
    ],
    "duration": "PT1.2970875S",
    "mode": "Incremental",
    "parameters": {},
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "locations": [
              null
            ],
            "resourceType": "policyDefinitions"
          },
          {
            "locations": [
              null
            ],
            "resourceType": "policyAssignments"
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "locations": [
              "eastus"
            ],
            "resourceType": "deployments"
          }
        ]
      }
    ],
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z"
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Kode status:: 201

{
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "location": "eastus",
  "properties": {
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceName": "policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceName": "location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments"
      }
    ],
    "duration": "PT1.2970875S",
    "mode": "Incremental",
    "parameters": {},
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "locations": [
              null
            ],
            "resourceType": "policyDefinitions"
          },
          {
            "locations": [
              null
            ],
            "resourceType": "policyAssignments"
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "locations": [
              "eastus"
            ],
            "resourceType": "deployments"
          }
        ]
      }
    ],
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z"
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Definisi

Nama	Deskripsi
Alias	Jenis alias.
AliasPath	Jenis jalur untuk alias.
AliasPathAttributes	Atribut token yang dirujuk jalur alias.
AliasPathMetadata
AliasPathTokenType	Jenis token yang dirujuk oleh 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.
createdByType	Jenis identitas yang membuat sumber daya.
DebugSetting	Pengaturan debug.
Dependency	Informasi dependensi penyebaran.
DeploymentDiagnosticsDefinition
DeploymentExtended	Informasi penyebaran.
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentExternalInput	Input eksternal penyebaran untuk parameterisasi.
DeploymentExternalInputDefinition	Definisi input eksternal penyebaran untuk parameterisasi.
DeploymentMode	Mode yang digunakan untuk menyebarkan sumber daya. Nilai ini dapat bertahas atau Lengkap. Dalam mode Bertahap, 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.
DeploymentParameter	Parameter penyebaran untuk templat.
DeploymentProperties	Properti penyebaran.
DeploymentPropertiesExtended	Properti penyebaran dengan detail tambahan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorResponse	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.)
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.
ExtensionConfigPropertyType
KeyVaultParameterReference	Referensi parameter Azure Key Vault.
KeyVaultReference	Referensi Azure Key Vault.
Level	Menunjukkan tingkat respons tambahan.
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 provisi.
ResourceReference	Model Id sumber daya.
ScopedDeployment	Parameter operasi penyebaran.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
TemplateLink	Entitas yang mewakili referensi ke templat.
ValidationLevel	Tingkat validasi yang dilakukan pada penerapan.
ZoneMapping

Alias

Objek

Jenis alias.

Nama	Jenis	Deskripsi
defaultMetadata	AliasPathMetadata	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	AliasPattern	Pola default untuk alias.
name	string	Nama alias.
paths	AliasPath[]	Jalur untuk alias.
type	AliasType	Jenis alias.

AliasPath

Objek

Jenis jalur untuk alias.

Nama	Jenis	Deskripsi
apiVersions	string[]	Versi API.
metadata	AliasPathMetadata	Metadata jalur alias. Jika hilang, kembali ke metadata default alias.
path	string	Jalur alias.
pattern	AliasPattern	Pola untuk jalur alias.

AliasPathAttributes

Enumerasi

Atribut token yang dirujuk jalur alias.

Nilai	Deskripsi
None	Token yang dimaksud jalur alias tidak memiliki atribut.
Modifiable	Token yang mengacu pada jalur alias dapat dimodifikasi oleh kebijakan dengan efek 'modifikasi'.

AliasPathMetadata

Objek

Nama	Jenis	Deskripsi
attributes	AliasPathAttributes	Atribut token yang dirujuk jalur alias.
type	AliasPathTokenType	Jenis token yang dirujuk oleh jalur alias.

AliasPathTokenType

Enumerasi

Jenis token yang dirujuk oleh jalur alias.

Nilai	Deskripsi
NotSpecified	Jenis token tidak ditentukan.
Any	Jenis token bisa apa saja.
String	Jenis token adalah string.
Object	Jenis token adalah objek.
Array	Jenis token adalah array.
Integer	Jenis token adalah bilangan bulat.
Number	Jenis token adalah angka.
Boolean	Jenis token adalah boolean.

AliasPattern

Objek

Jenis pola untuk jalur alias.

Nama	Jenis	Deskripsi
phrase	string	Frasa pola alias.
type	AliasPatternType	Jenis pola alias
variable	string	Variabel pola alias.

AliasPatternType

Enumerasi

Jenis pola alias

Nilai	Deskripsi
NotSpecified	NotSpecified tidak diperbolehkan.
Extract	Ekstrak adalah satu-satunya nilai yang diizinkan.

AliasType

Enumerasi

Jenis alias.

Nilai	Deskripsi
NotSpecified	Jenis alias tidak diketahui (sama dengan tidak menyediakan jenis alias).
PlainText	Nilai alias bukan rahasia.
Mask	Nilai alias adalah rahasia.

ApiProfile

Objek

Nama	Jenis	Deskripsi
apiVersion	string	Versi API.
profileVersion	string	Versi profil.

BasicDependency

Objek

Informasi dependensi penyebaran.

Nama	Jenis	Deskripsi
id	string	ID dependensi.
resourceName	string	Nama sumber daya dependensi.
resourceType	string	Jenis sumber daya dependensi.

CloudError

Objek

Respons kesalahan untuk permintaan manajemen sumber daya.

Nama	Jenis	Deskripsi
error	ErrorResponse	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.)

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

DebugSetting

Objek

Pengaturan debug.

Nama	Jenis	Deskripsi
detailLevel	string	Menentukan tipe informasi yang akan dicatat untuk penelusuran kesalahan. Nilai yang diizinkan tidak ada, requestContent, responseContent, atau requestContent dan responseContent yang dipisahkan oleh koma. Defaultnya adalah tidak ada. Saat mengatur nilai ini, pertimbangkan dengan cermat jenis informasi yang Anda teruskan selama penyebaran. Dengan mencatat informasi tentang permintaan atau respons, Anda berpotensi mengekspos data sensitif yang diambil melalui operasi penyebaran.

Dependency

Objek

Informasi dependensi penyebaran.

Nama	Jenis	Deskripsi
dependsOn	BasicDependency[]	Daftar dependensi.
id	string	ID dependensi.
resourceName	string	Nama sumber daya dependensi.
resourceType	string	Jenis sumber daya dependensi.

DeploymentDiagnosticsDefinition

Objek

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
level	Level	Menunjukkan tingkat respons tambahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

DeploymentExtended

Objek

Informasi penyebaran.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	lokasi penyebaran.
name	string	Nama sumber daya
properties	DeploymentPropertiesExtended	Properti penyebaran.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
tags	object	Tag penyebaran
type	string	Jenis sumber daya. Misalnya "Microsoft. Komputasi/virtualMachines" atau "Microsoft. Akun penyimpanan/penyimpanan"

DeploymentExtensionConfigItem

Objek

Nama	Jenis	Deskripsi
keyVaultReference	KeyVaultParameterReference	Referensi Azure Key Vault yang digunakan untuk mengambil nilai rahasia properti konfigurasi ekstensi.
type	ExtensionConfigPropertyType	Jenis nilai properti konfigurasi ekstensi.
value		Nilai properti konfigurasi ekstensi.

DeploymentExtensionDefinition

Objek

Nama	Jenis	Deskripsi
alias	string	Alias ekstensi seperti yang didefinisikan dalam templat penyebaran.
config	<string, DeploymentExtensionConfigItem>	Konfigurasi ekstensi.
configId	string	ID konfigurasi ekstensi. Ini secara unik mengidentifikasi sarana kontrol penyebaran dalam ekstensi.
name	string	Nama ekstensi.
version	string	Versi ekstensi.

DeploymentExternalInput

Objek

Input eksternal penyebaran untuk parameterisasi.

Nama	Jenis	Deskripsi
value		Nilai input eksternal.

DeploymentExternalInputDefinition

Objek

Definisi input eksternal penyebaran untuk parameterisasi.

Nama	Jenis	Deskripsi
config		Konfigurasi untuk input eksternal.
kind	string	Jenis input eksternal.

DeploymentMode

Enumerasi

Mode yang digunakan untuk menyebarkan sumber daya. Nilai ini dapat bertahas atau Lengkap. Dalam mode Bertahap, 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.

Nilai	Deskripsi
Incremental	bertambah bertahap
Complete	Selesai

DeploymentParameter

Objek

Parameter penyebaran untuk templat.

Nama	Jenis	Deskripsi
expression	string	Masukkan ekspresi ke parameter.
reference	KeyVaultParameterReference	Referensi parameter Azure Key Vault.
value		Nilai input ke parameter .

DeploymentProperties

Objek

Properti penyebaran.

Nama	Jenis	Deskripsi
debugSetting	DebugSetting	Pengaturan debug penyebaran.
expressionEvaluationOptions	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.
extensionConfigs	object	Konfigurasi yang digunakan untuk ekstensi penyebaran. Kunci objek ini adalah alias ekstensi penyebaran seperti yang didefinisikan dalam templat penyebaran.
externalInputDefinitions	<string, DeploymentExternalInputDefinition>	Definisi input eksternal, digunakan oleh perkakas eksternal untuk menentukan nilai input eksternal yang diharapkan.
externalInputs	<string, DeploymentExternalInput>	Nilai input eksternal, digunakan oleh perkakas eksternal untuk evaluasi parameter.
mode	DeploymentMode	Mode yang digunakan untuk menyebarkan sumber daya. Nilai ini dapat bertahas atau Lengkap. Dalam mode Bertahap, 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	OnErrorDeployment	Penyebaran pada perilaku kesalahan.
parameters	<string, DeploymentParameter>	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	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		Konten templat. Anda menggunakan elemen ini ketika 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	TemplateLink	URI templat. Gunakan properti templateLink atau properti templat, tetapi tidak keduanya.
validationLevel	ValidationLevel	Tingkat validasi penyebaran

DeploymentPropertiesExtended

Objek

Properti penyebaran dengan detail tambahan.

Nama	Jenis	Deskripsi
correlationId	string	ID korelasi penyebaran.
debugSetting	DebugSetting	Pengaturan debug penyebaran.
dependencies	Dependency[]	Daftar dependensi penyebaran.
diagnostics	DeploymentDiagnosticsDefinition[]	Berisi informasi diagnostik yang dikumpulkan selama proses validasi.
duration	string	Durasi penyebaran templat.
error	ErrorResponse	Kesalahan penyebaran.
extensions	DeploymentExtensionDefinition[]	Ekstensi yang digunakan dalam penyebaran ini.
mode	DeploymentMode	Mode penyebaran. Nilai yang mungkin bertahap dan Lengkap.
onErrorDeployment	OnErrorDeploymentExtended	Penyebaran pada perilaku kesalahan.
outputResources	ResourceReference[]	Array sumber daya yang disediakan.
outputs		Pasangan kunci/nilai yang mewakili output penyebaran.
parameters		Parameter penyebaran.
parametersLink	ParametersLink	URI yang mereferensikan parameter.
providers	Provider[]	Daftar penyedia sumber daya yang diperlukan untuk penyebaran.
provisioningState	ProvisioningState	Menunjukkan status provisi.
templateHash	string	Hash yang diproduksi untuk templat.
templateLink	TemplateLink	URI yang mereferensikan templat.
timestamp	string (date-time)	Tanda waktu penyebaran templat.
validatedResources	ResourceReference[]	Array sumber daya yang divalidasi.
validationLevel	ValidationLevel	Tingkat validasi penyebaran

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorResponse

Objek

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

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorResponse[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ExpressionEvaluationOptions

Objek

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

Nama	Jenis	Deskripsi
scope	ExpressionEvaluationOptionsScopeType	Cakupan yang akan digunakan untuk evaluasi parameter, variabel, dan fungsi dalam templat berlapis.

ExpressionEvaluationOptionsScopeType

Enumerasi

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

Nilai	Deskripsi
NotSpecified	Tidak Ditentukan
Outer	Luar
Inner	Dalam

ExtensionConfigPropertyType

Enumerasi

Nilai	Deskripsi
String	Jenis properti yang mewakili nilai string.
Int	Jenis properti yang mewakili nilai bilangan bulat.
Bool	Jenis properti yang mewakili nilai boolean.
Array	Jenis properti yang mewakili nilai array.
Object	Jenis properti yang mewakili nilai objek.
SecureString	Jenis properti yang mewakili nilai string aman.
SecureObject	Jenis properti yang mewakili nilai objek aman.

KeyVaultParameterReference

Objek

Referensi parameter Azure Key Vault.

Nama	Jenis	Deskripsi
keyVault	KeyVaultReference	Referensi Azure Key Vault.
secretName	string	Nama rahasia Azure Key Vault.
secretVersion	string	Versi rahasia Azure Key Vault.

KeyVaultReference

Objek

Referensi Azure Key Vault.

Nama	Jenis	Deskripsi
id	string	ID sumber daya Azure Key Vault.

Level

Enumerasi

Menunjukkan tingkat respons tambahan.

Nilai	Deskripsi
Warning	Peringatan
Info	Informasi
Error	Kesalahan

OnErrorDeployment

Objek

Penyebaran pada perilaku kesalahan.

Nama	Jenis	Deskripsi
deploymentName	string	Penyebaran yang akan digunakan pada kasus kesalahan.
type	OnErrorDeploymentType	Penyebaran pada jenis perilaku kesalahan. Nilai yang mungkin adalah LastSuccessful dan SpecificDeployment.

OnErrorDeploymentExtended

Objek

Penyebaran pada perilaku kesalahan dengan detail tambahan.

Nama	Jenis	Deskripsi
deploymentName	string	Penyebaran yang akan digunakan pada kasus kesalahan.
provisioningState	string	Status provisi untuk penyebaran kesalahan.
type	OnErrorDeploymentType	Penyebaran pada jenis perilaku kesalahan. Nilai yang mungkin adalah LastSuccessful dan SpecificDeployment.

OnErrorDeploymentType

Enumerasi

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

Nilai	Deskripsi
LastSuccessful	Terakhir Berhasil
SpecificDeployment	Penyebaran Spesifik

ParametersLink

Objek

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

Objek

Informasi penyedia sumber daya.

Nama	Jenis	Deskripsi
id	string	ID penyedia.
namespace	string	Namespace penyedia sumber daya.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	Status persetujuan otorisasi penyedia.
registrationPolicy	string	Kebijakan pendaftaran penyedia sumber daya.
registrationState	string	Status pendaftaran penyedia sumber daya.
resourceTypes	ProviderResourceType[]	Kumpulan jenis sumber daya penyedia.

ProviderAuthorizationConsentState

Enumerasi

Status persetujuan otorisasi penyedia.

Nilai	Deskripsi
NotSpecified	Tidak Ditentukan
Required	Required
NotRequired	Tidak Wajib
Consented	Disetujui

ProviderExtendedLocation

Objek

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

Objek

Jenis sumber daya yang dikelola oleh penyedia sumber daya.

Nama	Jenis	Deskripsi
aliases	Alias[]	Alias yang didukung oleh jenis sumber daya ini.
apiProfiles	ApiProfile[]	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	ProviderExtendedLocation[]	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	ZoneMapping[]

ProvisioningState

Enumerasi

Menunjukkan status provisi.

Nilai	Deskripsi
NotSpecified	Tidak Ditentukan
Accepted	Diterima
Running	Running
Ready	Siap
Creating	Membuat
Created	Telah dibuat
Deleting	Menghapus
Deleted	Dihapus
Canceled	Dibatalkan
Failed	Kegagalan
Succeeded	Berhasil
Updating	Memperbarui

ResourceReference

Objek

Model Id sumber daya.

Nama	Jenis	Deskripsi
apiVersion	string	Versi API yang digunakan sumber daya untuk disebarkan.
extension	DeploymentExtensionDefinition	Ekstensi yang digunakan sumber daya untuk disebarkan.
id	string	ID sumber daya Azure yang memenuhi syarat sepenuhnya.
identifiers		Pengidentifikasi sumber daya yang dapat diperluas.
resourceType	string	Jenis sumber daya

ScopedDeployment

Objek

Parameter operasi penyebaran.

Nama	Jenis	Deskripsi
location	string	Lokasi untuk menyimpan data penyebaran.
properties	DeploymentProperties	Properti penyebaran.
tags	object	Tag penyebaran

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Stempel waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

TemplateLink

Objek

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 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.

ValidationLevel

Enumerasi

Tingkat validasi yang dilakukan pada penerapan.

Nilai	Deskripsi
Template	Analisis statis templat dilakukan.
Provider	Analisis statis templat dilakukan dan deklarasi sumber daya dikirim ke penyedia sumber daya untuk validasi semantik. Memvalidasi bahwa pemanggil memiliki izin tulis RBAC pada setiap sumber daya.
ProviderNoRbac	Analisis statis templat dilakukan dan deklarasi sumber daya dikirim ke penyedia sumber daya untuk validasi semantik. Melewati validasi bahwa pemanggil memiliki izin tulis RBAC pada setiap sumber daya.

ZoneMapping

Objek

Nama	Jenis	Deskripsi
location	string	Lokasi pemetaan zona.
zones	string[]