Udostępnij przez


Wdrożenia Microsoft.Resources 2016-09-01

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@2016-09-01' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    debugSetting: {
      detailLevel: 'string'
    }
    mode: 'string'
    parameters: any(...)
    parametersLink: {
      contentVersion: 'string'
      uri: 'string'
    }
    template: any(...)
    templateLink: {
      contentVersion: 'string'
      uri: 'string'
    }
  }
}

Wartości właściwości

Microsoft.Resources/deployments

Nazwa Opis Wartość
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.

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

DeploymentPropertiesOrDeploymentPropertiesExtended

Nazwa Opis Wartość
debugSetting (ustawienie debug) Ustawienie debugowania wdrożenia. DebugOwanie
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)
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. jakikolwiek
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
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
URI Identyfikator URI szablonu do wdrożenia. ciąg (wymagany)

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": "2016-09-01",
  "name": "string",
  "properties": {
    "debugSetting": {
      "detailLevel": "string"
    },
    "mode": "string",
    "parameters": {},
    "parametersLink": {
      "contentVersion": "string",
      "uri": "string"
    },
    "template": {},
    "templateLink": {
      "contentVersion": "string",
      "uri": "string"
    }
  }
}

Wartości właściwości

Microsoft.Resources/deployments

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API '2016-09-01'
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)
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

DeploymentPropertiesOrDeploymentPropertiesExtended

Nazwa Opis Wartość
debugSetting (ustawienie debug) Ustawienie debugowania wdrożenia. DebugOwanie
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)
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. jakikolwiek
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
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
URI Identyfikator URI szablonu do wdrożenia. ciąg (wymagany)

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@2016-09-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      debugSetting = {
        detailLevel = "string"
      }
      mode = "string"
      parameters = ?
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      template = ?
      templateLink = {
        contentVersion = "string"
        uri = "string"
      }
    }
  }
}

Wartości właściwości

Microsoft.Resources/deployments

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 64
Wzorzec = ^[-\w\._\(\)]+$ (wymagane)
parent_id 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)
typ Typ zasobu "Microsoft.Resources/deployments@2016-09-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

DeploymentPropertiesOrDeploymentPropertiesExtended

Nazwa Opis Wartość
debugSetting (ustawienie debug) Ustawienie debugowania wdrożenia. DebugOwanie
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)
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. jakikolwiek
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
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
URI Identyfikator URI szablonu do wdrożenia. ciąg (wymagany)

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    = ["*"]
}