Udostępnij za pośrednictwem

Wdrożenia Microsoft.Resources 2021-01-01

  • Artykuł

Uwagi

W przypadku Bicep rozważ używanie 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@2021-01-01' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    debugSetting: {
      detailLevel: 'string'
    }
    expressionEvaluationOptions: {
      scope: 'string'
    }
    mode: 'string'
    onErrorDeployment: {
      deploymentName: 'string'
      type: 'string'
    }
    parameters: any(Azure.Bicep.Types.Concrete.AnyType)
    parametersLink: {
      contentVersion: 'string'
      uri: 'string'
    }
    template: any(Azure.Bicep.Types.Concrete.AnyType)
    templateLink: {
      contentVersion: 'string'
      id: 'string'
      queryString: 'string'
      relativePath: 'string'
      uri: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

DebugOwanie

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

DeploymentPropertiesOrDeploymentPropertiesExtended

Nazwa Opis Wartość
debugSetting Ustawienie debugowania wdrożenia. DebugSetting
expressionEvaluationOptions Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego. Dotyczy tylko szablonów zagnieżdżonych. Jeśli nie zostanie określony, wartość domyślna jest zewnętrzna. ExpressionEvaluationOptions
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 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. jakikolwiek
parametersLink 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. ParametersLink
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 Identyfikator URI szablonu. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu. TemplateLink

Tagi wdrożenia

Nazwa Opis Wartość

ExpressionEvaluationOptions

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

Microsoft.Resources/deployments

Nazwa Opis Wartość
lokalizacja Lokalizacja do przechowywania danych wdrożenia. struna
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
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 .
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

OnErrorDeploymentOrOnErrorDeploymentExtended

Nazwa Opis Wartość
deploymentName Wdrożenie, które ma być używane w przypadku błędu. struna
typ Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment. "LastSuccessful"
"SpecificDeployment"
Nazwa Opis Wartość
contentVersion W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. struna
Uri Identyfikator URI pliku parametrów. ciąg (wymagany)
Nazwa Opis Wartość
contentVersion W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. struna
id Identyfikator zasobu specyfikacji szablonu. Użyj właściwości identyfikatora lub identyfikatora URI, ale nie obu tych elementów. struna
queryString Ciąg zapytania (na przykład token SAS) do użycia z identyfikatorem URI szablonuLink. struna
relativePath 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 struna
Uri Identyfikator URI szablonu do wdrożenia. Użyj właściwości URI lub id, ale nie obu. struna

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": "2021-01-01",
  "name": "string",
  "location": "string",
  "properties": {
    "debugSetting": {
      "detailLevel": "string"
    },
    "expressionEvaluationOptions": {
      "scope": "string"
    },
    "mode": "string",
    "onErrorDeployment": {
      "deploymentName": "string",
      "type": "string"
    },
    "parameters": {},
    "parametersLink": {
      "contentVersion": "string",
      "uri": "string"
    },
    "template": {},
    "templateLink": {
      "contentVersion": "string",
      "id": "string",
      "queryString": "string",
      "relativePath": "string",
      "uri": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

DebugOwanie

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

DeploymentPropertiesOrDeploymentPropertiesExtended

Nazwa Opis Wartość
debugSetting Ustawienie debugowania wdrożenia. DebugSetting
expressionEvaluationOptions Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego. Dotyczy tylko szablonów zagnieżdżonych. Jeśli nie zostanie określony, wartość domyślna jest zewnętrzna. ExpressionEvaluationOptions
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 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. jakikolwiek
parametersLink 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. ParametersLink
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 Identyfikator URI szablonu. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu. TemplateLink

Tagi wdrożenia

Nazwa Opis Wartość

ExpressionEvaluationOptions

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

Microsoft.Resources/deployments

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2021-01-01'
lokalizacja Lokalizacja do przechowywania danych wdrożenia. struna
nazwa Nazwa zasobu struna

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

OnErrorDeploymentOrOnErrorDeploymentExtended

Nazwa Opis Wartość
deploymentName Wdrożenie, które ma być używane w przypadku błędu. struna
typ Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment. "LastSuccessful"
"SpecificDeployment"
Nazwa Opis Wartość
contentVersion W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. struna
Uri Identyfikator URI pliku parametrów. ciąg (wymagany)
Nazwa Opis Wartość
contentVersion W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. struna
id Identyfikator zasobu specyfikacji szablonu. Użyj właściwości identyfikatora lub identyfikatora URI, ale nie obu tych elementów. struna
queryString Ciąg zapytania (na przykład token SAS) do użycia z identyfikatorem URI szablonuLink. struna
relativePath 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 struna
Uri Identyfikator URI szablonu do wdrożenia. Użyj właściwości URI lub id, ale nie obu. struna

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@2021-01-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      debugSetting = {
        detailLevel = "string"
      }
      expressionEvaluationOptions = {
        scope = "string"
      }
      mode = "string"
      onErrorDeployment = {
        deploymentName = "string"
        type = "string"
      }
      parameters = ?
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      template = ?
      templateLink = {
        contentVersion = "string"
        id = "string"
        queryString = "string"
        relativePath = "string"
        uri = "string"
      }
    }
  })
}

Wartości właściwości

DebugOwanie

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

DeploymentPropertiesOrDeploymentPropertiesExtended

Nazwa Opis Wartość
debugSetting Ustawienie debugowania wdrożenia. DebugSetting
expressionEvaluationOptions Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego. Dotyczy tylko szablonów zagnieżdżonych. Jeśli nie zostanie określony, wartość domyślna jest zewnętrzna. ExpressionEvaluationOptions
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 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. jakikolwiek
parametersLink 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. ParametersLink
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 Identyfikator URI szablonu. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu. TemplateLink

Tagi wdrożenia

Nazwa Opis Wartość

ExpressionEvaluationOptions

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

Microsoft.Resources/deployments

Nazwa Opis Wartość
lokalizacja Lokalizacja do przechowywania danych wdrożenia. struna
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
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)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.Resources/deployments@2021-01-01"

OnErrorDeploymentOrOnErrorDeploymentExtended

Nazwa Opis Wartość
deploymentName Wdrożenie, które ma być używane w przypadku błędu. struna
typ Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment. "LastSuccessful"
"SpecificDeployment"
Nazwa Opis Wartość
contentVersion W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. struna
Uri Identyfikator URI pliku parametrów. ciąg (wymagany)
Nazwa Opis Wartość
contentVersion W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. struna
id Identyfikator zasobu specyfikacji szablonu. Użyj właściwości identyfikatora lub identyfikatora URI, ale nie obu tych elementów. struna
queryString Ciąg zapytania (na przykład token SAS) do użycia z identyfikatorem URI szablonuLink. struna
relativePath 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 struna
Uri Identyfikator URI szablonu do wdrożenia. Użyj właściwości URI lub id, ale nie obu. struna