Udostępnij przez


Wdrożenia Microsoft.Resources

Uwagi

W przypadku Bicep rozważ użycie modułów zamiast tego typu zasobu.

Definicja zasobu Bicep

Typ zasobu wdrożenia można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Resources/deployments, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Resources/deployments@2025-04-01' = {
  scope: resourceSymbolicName or scope
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    debugSetting: {
      detailLevel: 'string'
    }
    expressionEvaluationOptions: {
      scope: 'string'
    }
    extensionConfigs: {
      {customized property}: {
        {customized property}: {
          keyVaultReference: {
            keyVault: {
              id: 'string'
            }
            secretName: 'string'
            secretVersion: 'string'
          }
          value: any(...)
        }
      }
    }
    externalInputDefinitions: {
      {customized property}: {
        config: any(...)
        kind: 'string'
      }
    }
    externalInputs: {
      {customized property}: {
        value: any(...)
      }
    }
    mode: 'string'
    onErrorDeployment: {
      deploymentName: 'string'
      type: 'string'
    }
    parameters: {
      {customized property}: {
        expression: 'string'
        reference: {
          keyVault: {
            id: 'string'
          }
          secretName: 'string'
          secretVersion: 'string'
        }
        value: any(...)
      }
    }
    parametersLink: {
      contentVersion: 'string'
      uri: 'string'
    }
    template: any(...)
    templateLink: {
      contentVersion: 'string'
      id: 'string'
      queryString: 'string'
      relativePath: 'string'
      uri: 'string'
    }
    validationLevel: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

Microsoft.Resources/deployments

Nazwa Opis Wartość
tożsamość Konfiguracja tożsamości zarządzanej dla wdrożenia. Tożsamość wdrożenia
lokalizacja Lokalizacja do przechowywania danych wdrożenia. ciąg
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 64
Wzorzec = ^[-\w\._\(\)]+$ (wymagane)
właściwości Właściwości wdrożenia. DeploymentPropertiesOrDeploymentPropertiesExtended (wymagane)
zakres Użyj polecenia podczas tworzenia zasobu w zakresie innym niż zakres wdrożenia. Ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia .
Etykiety Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

DebugOwanie

Nazwa Opis Wartość
Poziom szczegółu Określa typ informacji do rejestrowania na potrzeby debugowania. Dozwolone wartości to none, requestContent, responseContent lub requestContent i responseContent oddzielone przecinkami. Wartość domyślna to brak. Podczas ustawiania tej wartości należy dokładnie rozważyć typ informacji przekazywanych podczas wdrażania. Rejestrując informacje o żądaniu lub odpowiedzi, możesz potencjalnie uwidocznić poufne dane pobierane za pośrednictwem operacji wdrażania. ciąg

DeploymentExtensionConfig

Nazwa Opis Wartość

DeploymentExtensionConfigItem

Nazwa Opis Wartość
keyVaultReference (Odniesienie do klucza) Dokumentacja usługi Azure Key Vault używana do pobierania wartości wpisu tajnego właściwości konfiguracji rozszerzenia. KeyVaultParameterReference
wartość Wartość właściwości config rozszerzenia. jakikolwiek

DeploymentExternalInput (ImplementacjaExternalInput)

Nazwa Opis Wartość
wartość Zewnętrzna wartość wejściowa. dowolna (wymagana)

DeploymentExternalInputDefinition

Nazwa Opis Wartość
konfig Konfiguracja dla wejścia zewnętrznego. jakikolwiek
rodzaj Rodzaj zewnętrznego wejścia. ciąg (wymagany)

Tożsamość wdrożenia

Nazwa Opis Wartość
typ Typ tożsamości. "Brak"
"UserAssigned" (wymagane)
tożsamości przypisane użytkownikom Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. DeploymentIdentityUserAssignedIdentities

DeploymentIdentityUserAssignedIdentities

Nazwa Opis Wartość

Parametr wdrożenia

Nazwa Opis Wartość
wyrażenie Wyrażenie wejściowe do parametru. ciąg
odwołanie Dokumentacja parametrów usługi Azure Key Vault. KeyVaultParameterReference
wartość Wprowadź wartość do parametru . jakikolwiek

DeploymentPropertiesExtensionConfigs

Nazwa Opis Wartość

DeploymentPropertiesExternalInputDefinitions

Nazwa Opis Wartość

DeploymentPropertiesExternalInputs

Nazwa Opis Wartość

DeploymentPropertiesOrDeploymentPropertiesExtended

Nazwa Opis Wartość
debugSetting (ustawienie debug) Ustawienie debugowania wdrożenia. DebugOwanie
expressionEvaluationOptions (opcje oceny) Określa, czy wyrażenia szablonu są obliczane w zakresie szablonu nadrzędnego, czy szablonu zagnieżdżonego. Dotyczy tylko szablonów zagnieżdżonych. Jeśli nie zostanie określona, wartość domyślna to outer. ExpressionEvaluationOptions
extensionConfigs (konfiguracje rozszerzenia) Konfiguracje, które mają być używane dla rozszerzeń wdrożenia. Klucze tego obiektu są aliasami rozszerzenia wdrożenia zdefiniowanymi w szablonie wdrożenia. DeploymentPropertiesExtensionConfigs
externalInputDefinitions (Definicje danych wejściowych) Definicje danych wejściowych zewnętrznych, używane przez narzędzia zewnętrzne do definiowania oczekiwanych zewnętrznych wartości wejściowych. DeploymentPropertiesExternalInputDefinitions
externalInputs (zewnętrzne) Zewnętrzne wartości wejściowe używane przez narzędzia zewnętrzne do oceny parametrów. DeploymentPropertiesExternalInputs
tryb Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu ukończenia, ponieważ możesz przypadkowo usunąć zasoby. "Ukończono"
"Przyrostowe" (wymagane)
onErrorDeployment (wdrożenie) Wdrożenie w przypadku zachowania błędu. OnErrorDeploymentOrOnErrorDeploymentExtended
Parametry Pary nazw i wartości definiujące parametry wdrożenia dla szablonu. Ten element jest używany, gdy chcesz podać wartości parametrów bezpośrednio w żądaniu, a nie połączyć się z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. DeploymentPropertiesParameters
parametryLink Identyfikator URI pliku parametrów. Ten element służy do łączenia z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu. ParametryLink
szablon Zawartość szablonu. Ten element jest używany, gdy chcesz przekazać składnię szablonu bezpośrednio w żądaniu, a nie połączyć się z istniejącym szablonem. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu. jakikolwiek
templateLink (link do szablonu) Identyfikator URI szablonu. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu. SzablonLink
validationLevel (poziom walidacji) Poziom weryfikacji wdrożenia "Dostawca"
"ProviderNoRbac" (DostawcaNoRbac)
"Szablon"

DeploymentPropertiesParameters

Nazwa Opis Wartość

Tagi wdrożenia

Nazwa Opis Wartość

ExpressionEvaluationOptions

Nazwa Opis Wartość
zakres Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym. "Wewnętrzny"
"NotSpecified"
"Zewnętrzny"

KeyVaultParameterReference

Nazwa Opis Wartość
keyVault Dokumentacja usługi Azure Key Vault. KeyVaultReference (wymagane)
nazwaTajna Nazwa wpisu tajnego usługi Azure Key Vault. ciąg (wymagany)
wersjaTajna Wersja tajemnicy w usłudze Azure Key Vault. ciąg

Odniesienie do klucza KeyVault

Nazwa Opis Wartość
id Identyfikator zasobu usługi Azure Key Vault. ciąg (wymagany)

OnErrorDeploymentOrOnErrorDeploymentExtended

Nazwa Opis Wartość
NazwaWdrożenia Wdrożenie, które ma być używane w przypadku błędu. ciąg
typ Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment. "LastSuccessful"
"SpecificDeployment"
Nazwa Opis Wartość
wersja zawartości W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. ciąg
URI Identyfikator URI pliku parametrów. ciąg (wymagany)
Nazwa Opis Wartość
wersja zawartości W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. ciąg
id Identyfikator zasobu specyfikacji szablonu. Użyj właściwości identyfikatora lub identyfikatora URI, ale nie obu tych elementów. ciąg
queryString (ciąg zapytania) Ciąg zapytania (na przykład token SAS) do użycia z identyfikatorem URI szablonuLink. ciąg
relativePath (ścieżka względna) Właściwość relativePath może służyć do wdrażania połączonego szablonu w lokalizacji względem elementu nadrzędnego. Jeśli szablon nadrzędny został połączony z szablonem TemplateSpec, będzie on odwoływać się do artefaktu w elemencie TemplateSpec. Jeśli element nadrzędny został połączony z identyfikatorem URI, wdrożenie podrzędne będzie kombinacją identyfikatorów URI nadrzędnych i względnychPath ciąg
URI Identyfikator URI szablonu do wdrożenia. Użyj właściwości URI lub id, ale nie obu. ciąg

Tożsamość przypisana przez użytkownika

Nazwa Opis Wartość

Definicja zasobu szablonu usługi ARM

Typ zasobu wdrożenia można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Resources/deployments, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Resources/deployments",
  "apiVersion": "2025-04-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "debugSetting": {
      "detailLevel": "string"
    },
    "expressionEvaluationOptions": {
      "scope": "string"
    },
    "extensionConfigs": {
      "{customized property}": {
        "{customized property}": {
          "keyVaultReference": {
            "keyVault": {
              "id": "string"
            },
            "secretName": "string",
            "secretVersion": "string"
          },
          "value": {}
        }
      }
    },
    "externalInputDefinitions": {
      "{customized property}": {
        "config": {},
        "kind": "string"
      }
    },
    "externalInputs": {
      "{customized property}": {
        "value": {}
      }
    },
    "mode": "string",
    "onErrorDeployment": {
      "deploymentName": "string",
      "type": "string"
    },
    "parameters": {
      "{customized property}": {
        "expression": "string",
        "reference": {
          "keyVault": {
            "id": "string"
          },
          "secretName": "string",
          "secretVersion": "string"
        },
        "value": {}
      }
    },
    "parametersLink": {
      "contentVersion": "string",
      "uri": "string"
    },
    "template": {},
    "templateLink": {
      "contentVersion": "string",
      "id": "string",
      "queryString": "string",
      "relativePath": "string",
      "uri": "string"
    },
    "validationLevel": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

Microsoft.Resources/deployments

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API '2025-04-01'
tożsamość Konfiguracja tożsamości zarządzanej dla wdrożenia. Tożsamość wdrożenia
lokalizacja Lokalizacja do przechowywania danych wdrożenia. ciąg
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 64
Wzorzec = ^[-\w\._\(\)]+$ (wymagane)
właściwości Właściwości wdrożenia. DeploymentPropertiesOrDeploymentPropertiesExtended (wymagane)
Etykiety Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.Resources/deployments"

DebugOwanie

Nazwa Opis Wartość
Poziom szczegółu Określa typ informacji do rejestrowania na potrzeby debugowania. Dozwolone wartości to none, requestContent, responseContent lub requestContent i responseContent oddzielone przecinkami. Wartość domyślna to brak. Podczas ustawiania tej wartości należy dokładnie rozważyć typ informacji przekazywanych podczas wdrażania. Rejestrując informacje o żądaniu lub odpowiedzi, możesz potencjalnie uwidocznić poufne dane pobierane za pośrednictwem operacji wdrażania. ciąg

DeploymentExtensionConfig

Nazwa Opis Wartość

DeploymentExtensionConfigItem

Nazwa Opis Wartość
keyVaultReference (Odniesienie do klucza) Dokumentacja usługi Azure Key Vault używana do pobierania wartości wpisu tajnego właściwości konfiguracji rozszerzenia. KeyVaultParameterReference
wartość Wartość właściwości config rozszerzenia. jakikolwiek

DeploymentExternalInput (ImplementacjaExternalInput)

Nazwa Opis Wartość
wartość Zewnętrzna wartość wejściowa. dowolna (wymagana)

DeploymentExternalInputDefinition

Nazwa Opis Wartość
konfig Konfiguracja dla wejścia zewnętrznego. jakikolwiek
rodzaj Rodzaj zewnętrznego wejścia. ciąg (wymagany)

Tożsamość wdrożenia

Nazwa Opis Wartość
typ Typ tożsamości. "Brak"
"UserAssigned" (wymagane)
tożsamości przypisane użytkownikom Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. DeploymentIdentityUserAssignedIdentities

DeploymentIdentityUserAssignedIdentities

Nazwa Opis Wartość

Parametr wdrożenia

Nazwa Opis Wartość
wyrażenie Wyrażenie wejściowe do parametru. ciąg
odwołanie Dokumentacja parametrów usługi Azure Key Vault. KeyVaultParameterReference
wartość Wprowadź wartość do parametru . jakikolwiek

DeploymentPropertiesExtensionConfigs

Nazwa Opis Wartość

DeploymentPropertiesExternalInputDefinitions

Nazwa Opis Wartość

DeploymentPropertiesExternalInputs

Nazwa Opis Wartość

DeploymentPropertiesOrDeploymentPropertiesExtended

Nazwa Opis Wartość
debugSetting (ustawienie debug) Ustawienie debugowania wdrożenia. DebugOwanie
expressionEvaluationOptions (opcje oceny) Określa, czy wyrażenia szablonu są obliczane w zakresie szablonu nadrzędnego, czy szablonu zagnieżdżonego. Dotyczy tylko szablonów zagnieżdżonych. Jeśli nie zostanie określona, wartość domyślna to outer. ExpressionEvaluationOptions
extensionConfigs (konfiguracje rozszerzenia) Konfiguracje, które mają być używane dla rozszerzeń wdrożenia. Klucze tego obiektu są aliasami rozszerzenia wdrożenia zdefiniowanymi w szablonie wdrożenia. DeploymentPropertiesExtensionConfigs
externalInputDefinitions (Definicje danych wejściowych) Definicje danych wejściowych zewnętrznych, używane przez narzędzia zewnętrzne do definiowania oczekiwanych zewnętrznych wartości wejściowych. DeploymentPropertiesExternalInputDefinitions
externalInputs (zewnętrzne) Zewnętrzne wartości wejściowe używane przez narzędzia zewnętrzne do oceny parametrów. DeploymentPropertiesExternalInputs
tryb Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu ukończenia, ponieważ możesz przypadkowo usunąć zasoby. "Ukończono"
"Przyrostowe" (wymagane)
onErrorDeployment (wdrożenie) Wdrożenie w przypadku zachowania błędu. OnErrorDeploymentOrOnErrorDeploymentExtended
Parametry Pary nazw i wartości definiujące parametry wdrożenia dla szablonu. Ten element jest używany, gdy chcesz podać wartości parametrów bezpośrednio w żądaniu, a nie połączyć się z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. DeploymentPropertiesParameters
parametryLink Identyfikator URI pliku parametrów. Ten element służy do łączenia z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu. ParametryLink
szablon Zawartość szablonu. Ten element jest używany, gdy chcesz przekazać składnię szablonu bezpośrednio w żądaniu, a nie połączyć się z istniejącym szablonem. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu. jakikolwiek
templateLink (link do szablonu) Identyfikator URI szablonu. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu. SzablonLink
validationLevel (poziom walidacji) Poziom weryfikacji wdrożenia "Dostawca"
"ProviderNoRbac" (DostawcaNoRbac)
"Szablon"

DeploymentPropertiesParameters

Nazwa Opis Wartość

Tagi wdrożenia

Nazwa Opis Wartość

ExpressionEvaluationOptions

Nazwa Opis Wartość
zakres Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym. "Wewnętrzny"
"NotSpecified"
"Zewnętrzny"

KeyVaultParameterReference

Nazwa Opis Wartość
keyVault Dokumentacja usługi Azure Key Vault. KeyVaultReference (wymagane)
nazwaTajna Nazwa wpisu tajnego usługi Azure Key Vault. ciąg (wymagany)
wersjaTajna Wersja tajemnicy w usłudze Azure Key Vault. ciąg

Odniesienie do klucza KeyVault

Nazwa Opis Wartość
id Identyfikator zasobu usługi Azure Key Vault. ciąg (wymagany)

OnErrorDeploymentOrOnErrorDeploymentExtended

Nazwa Opis Wartość
NazwaWdrożenia Wdrożenie, które ma być używane w przypadku błędu. ciąg
typ Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment. "LastSuccessful"
"SpecificDeployment"
Nazwa Opis Wartość
wersja zawartości W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. ciąg
URI Identyfikator URI pliku parametrów. ciąg (wymagany)
Nazwa Opis Wartość
wersja zawartości W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. ciąg
id Identyfikator zasobu specyfikacji szablonu. Użyj właściwości identyfikatora lub identyfikatora URI, ale nie obu tych elementów. ciąg
queryString (ciąg zapytania) Ciąg zapytania (na przykład token SAS) do użycia z identyfikatorem URI szablonuLink. ciąg
relativePath (ścieżka względna) Właściwość relativePath może służyć do wdrażania połączonego szablonu w lokalizacji względem elementu nadrzędnego. Jeśli szablon nadrzędny został połączony z szablonem TemplateSpec, będzie on odwoływać się do artefaktu w elemencie TemplateSpec. Jeśli element nadrzędny został połączony z identyfikatorem URI, wdrożenie podrzędne będzie kombinacją identyfikatorów URI nadrzędnych i względnychPath ciąg
URI Identyfikator URI szablonu do wdrożenia. Użyj właściwości URI lub id, ale nie obu. ciąg

Tożsamość przypisana przez użytkownika

Nazwa Opis Wartość

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu wdrożenia można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Resources/deployments, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/deployments@2025-04-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      debugSetting = {
        detailLevel = "string"
      }
      expressionEvaluationOptions = {
        scope = "string"
      }
      extensionConfigs = {
        {customized property} = {
          {customized property} = {
            keyVaultReference = {
              keyVault = {
                id = "string"
              }
              secretName = "string"
              secretVersion = "string"
            }
            value = ?
          }
        }
      }
      externalInputDefinitions = {
        {customized property} = {
          config = ?
          kind = "string"
        }
      }
      externalInputs = {
        {customized property} = {
          value = ?
        }
      }
      mode = "string"
      onErrorDeployment = {
        deploymentName = "string"
        type = "string"
      }
      parameters = {
        {customized property} = {
          expression = "string"
          reference = {
            keyVault = {
              id = "string"
            }
            secretName = "string"
            secretVersion = "string"
          }
          value = ?
        }
      }
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      template = ?
      templateLink = {
        contentVersion = "string"
        id = "string"
        queryString = "string"
        relativePath = "string"
        uri = "string"
      }
      validationLevel = "string"
    }
  }
}

Wartości właściwości

Microsoft.Resources/deployments

Nazwa Opis Wartość
tożsamość Konfiguracja tożsamości zarządzanej dla wdrożenia. Tożsamość wdrożenia
lokalizacja Lokalizacja do przechowywania danych wdrożenia. ciąg
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 64
Wzorzec = ^[-\w\._\(\)]+$ (wymagane)
parent_id (identyfikator rodzica) Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. ciąg (wymagany)
właściwości Właściwości wdrożenia. DeploymentPropertiesOrDeploymentPropertiesExtended (wymagane)
Etykiety Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.Resources/deployments@2025-04-01"

DebugOwanie

Nazwa Opis Wartość
Poziom szczegółu Określa typ informacji do rejestrowania na potrzeby debugowania. Dozwolone wartości to none, requestContent, responseContent lub requestContent i responseContent oddzielone przecinkami. Wartość domyślna to brak. Podczas ustawiania tej wartości należy dokładnie rozważyć typ informacji przekazywanych podczas wdrażania. Rejestrując informacje o żądaniu lub odpowiedzi, możesz potencjalnie uwidocznić poufne dane pobierane za pośrednictwem operacji wdrażania. ciąg

DeploymentExtensionConfig

Nazwa Opis Wartość

DeploymentExtensionConfigItem

Nazwa Opis Wartość
keyVaultReference (Odniesienie do klucza) Dokumentacja usługi Azure Key Vault używana do pobierania wartości wpisu tajnego właściwości konfiguracji rozszerzenia. KeyVaultParameterReference
wartość Wartość właściwości config rozszerzenia. jakikolwiek

DeploymentExternalInput (ImplementacjaExternalInput)

Nazwa Opis Wartość
wartość Zewnętrzna wartość wejściowa. dowolna (wymagana)

DeploymentExternalInputDefinition

Nazwa Opis Wartość
konfig Konfiguracja dla wejścia zewnętrznego. jakikolwiek
rodzaj Rodzaj zewnętrznego wejścia. ciąg (wymagany)

Tożsamość wdrożenia

Nazwa Opis Wartość
typ Typ tożsamości. "Brak"
"UserAssigned" (wymagane)
tożsamości przypisane użytkownikom Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. DeploymentIdentityUserAssignedIdentities

DeploymentIdentityUserAssignedIdentities

Nazwa Opis Wartość

Parametr wdrożenia

Nazwa Opis Wartość
wyrażenie Wyrażenie wejściowe do parametru. ciąg
odwołanie Dokumentacja parametrów usługi Azure Key Vault. KeyVaultParameterReference
wartość Wprowadź wartość do parametru . jakikolwiek

DeploymentPropertiesExtensionConfigs

Nazwa Opis Wartość

DeploymentPropertiesExternalInputDefinitions

Nazwa Opis Wartość

DeploymentPropertiesExternalInputs

Nazwa Opis Wartość

DeploymentPropertiesOrDeploymentPropertiesExtended

Nazwa Opis Wartość
debugSetting (ustawienie debug) Ustawienie debugowania wdrożenia. DebugOwanie
expressionEvaluationOptions (opcje oceny) Określa, czy wyrażenia szablonu są obliczane w zakresie szablonu nadrzędnego, czy szablonu zagnieżdżonego. Dotyczy tylko szablonów zagnieżdżonych. Jeśli nie zostanie określona, wartość domyślna to outer. ExpressionEvaluationOptions
extensionConfigs (konfiguracje rozszerzenia) Konfiguracje, które mają być używane dla rozszerzeń wdrożenia. Klucze tego obiektu są aliasami rozszerzenia wdrożenia zdefiniowanymi w szablonie wdrożenia. DeploymentPropertiesExtensionConfigs
externalInputDefinitions (Definicje danych wejściowych) Definicje danych wejściowych zewnętrznych, używane przez narzędzia zewnętrzne do definiowania oczekiwanych zewnętrznych wartości wejściowych. DeploymentPropertiesExternalInputDefinitions
externalInputs (zewnętrzne) Zewnętrzne wartości wejściowe używane przez narzędzia zewnętrzne do oceny parametrów. DeploymentPropertiesExternalInputs
tryb Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu ukończenia, ponieważ możesz przypadkowo usunąć zasoby. "Ukończono"
"Przyrostowe" (wymagane)
onErrorDeployment (wdrożenie) Wdrożenie w przypadku zachowania błędu. OnErrorDeploymentOrOnErrorDeploymentExtended
Parametry Pary nazw i wartości definiujące parametry wdrożenia dla szablonu. Ten element jest używany, gdy chcesz podać wartości parametrów bezpośrednio w żądaniu, a nie połączyć się z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. DeploymentPropertiesParameters
parametryLink Identyfikator URI pliku parametrów. Ten element służy do łączenia z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu. ParametryLink
szablon Zawartość szablonu. Ten element jest używany, gdy chcesz przekazać składnię szablonu bezpośrednio w żądaniu, a nie połączyć się z istniejącym szablonem. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu. jakikolwiek
templateLink (link do szablonu) Identyfikator URI szablonu. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu. SzablonLink
validationLevel (poziom walidacji) Poziom weryfikacji wdrożenia "Dostawca"
"ProviderNoRbac" (DostawcaNoRbac)
"Szablon"

DeploymentPropertiesParameters

Nazwa Opis Wartość

Tagi wdrożenia

Nazwa Opis Wartość

ExpressionEvaluationOptions

Nazwa Opis Wartość
zakres Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym. "Wewnętrzny"
"NotSpecified"
"Zewnętrzny"

KeyVaultParameterReference

Nazwa Opis Wartość
keyVault Dokumentacja usługi Azure Key Vault. KeyVaultReference (wymagane)
nazwaTajna Nazwa wpisu tajnego usługi Azure Key Vault. ciąg (wymagany)
wersjaTajna Wersja tajemnicy w usłudze Azure Key Vault. ciąg

Odniesienie do klucza KeyVault

Nazwa Opis Wartość
id Identyfikator zasobu usługi Azure Key Vault. ciąg (wymagany)

OnErrorDeploymentOrOnErrorDeploymentExtended

Nazwa Opis Wartość
NazwaWdrożenia Wdrożenie, które ma być używane w przypadku błędu. ciąg
typ Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment. "LastSuccessful"
"SpecificDeployment"
Nazwa Opis Wartość
wersja zawartości W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. ciąg
URI Identyfikator URI pliku parametrów. ciąg (wymagany)
Nazwa Opis Wartość
wersja zawartości W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. ciąg
id Identyfikator zasobu specyfikacji szablonu. Użyj właściwości identyfikatora lub identyfikatora URI, ale nie obu tych elementów. ciąg
queryString (ciąg zapytania) Ciąg zapytania (na przykład token SAS) do użycia z identyfikatorem URI szablonuLink. ciąg
relativePath (ścieżka względna) Właściwość relativePath może służyć do wdrażania połączonego szablonu w lokalizacji względem elementu nadrzędnego. Jeśli szablon nadrzędny został połączony z szablonem TemplateSpec, będzie on odwoływać się do artefaktu w elemencie TemplateSpec. Jeśli element nadrzędny został połączony z identyfikatorem URI, wdrożenie podrzędne będzie kombinacją identyfikatorów URI nadrzędnych i względnychPath ciąg
URI Identyfikator URI szablonu do wdrożenia. Użyj właściwości URI lub id, ale nie obu. ciąg

Tożsamość przypisana przez użytkownika

Nazwa Opis Wartość

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrażania szablonu.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "deployment" {
  type      = "Microsoft.Resources/deployments@2020-06-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  body = {
    properties = {
      mode = "Complete"
      template = {
        "$schema"      = "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#"
        contentVersion = "1.0.0.0"
        parameters = {
          storageAccountType = {
            allowedValues = [
              "Standard_LRS",
              "Standard_GRS",
              "Standard_ZRS",
            ]
            defaultValue = "Standard_LRS"
            metadata = {
              description = "Storage Account type"
            }
            type = "string"
          }
        }
        resources = [
          {
            apiVersion = "[variables('apiVersion')]"
            location   = "[variables('location')]"
            name       = "[variables('storageAccountName')]"
            properties = {
              accountType = "[parameters('storageAccountType')]"
            }
            type = "Microsoft.Storage/storageAccounts"
          },
          {
            apiVersion = "[variables('apiVersion')]"
            location   = "[variables('location')]"
            name       = "[variables('publicIPAddressName')]"
            properties = {
              dnsSettings = {
                domainNameLabel = "[variables('dnsLabelPrefix')]"
              }
              publicIPAllocationMethod = "[variables('publicIPAddressType')]"
            }
            type = "Microsoft.Network/publicIPAddresses"
          },
        ]
        variables = {
          apiVersion          = "2015-06-15"
          dnsLabelPrefix      = "[concat('terraform-tdacctest', uniquestring(resourceGroup().id))]"
          location            = "[resourceGroup().location]"
          publicIPAddressName = "[concat('myPublicIp', uniquestring(resourceGroup().id))]"
          publicIPAddressType = "Dynamic"
          storageAccountName  = "[concat(uniquestring(resourceGroup().id), 'storage')]"
        }
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}