ArmDeploymentWhatIfProperties Class

Definition

Deployment What-if properties.

public class ArmDeploymentWhatIfProperties : Azure.ResourceManager.Resources.Models.ArmDeploymentProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Resources.Models.ArmDeploymentWhatIfProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Resources.Models.ArmDeploymentWhatIfProperties>
public class ArmDeploymentWhatIfProperties : Azure.ResourceManager.Resources.Models.ArmDeploymentProperties
type ArmDeploymentWhatIfProperties = class
    inherit ArmDeploymentProperties
    interface IJsonModel<ArmDeploymentWhatIfProperties>
    interface IPersistableModel<ArmDeploymentWhatIfProperties>
type ArmDeploymentWhatIfProperties = class
    inherit ArmDeploymentProperties
Public Class ArmDeploymentWhatIfProperties
Inherits ArmDeploymentProperties
Implements IJsonModel(Of ArmDeploymentWhatIfProperties), IPersistableModel(Of ArmDeploymentWhatIfProperties)
Public Class ArmDeploymentWhatIfProperties
Inherits ArmDeploymentProperties
Inheritance
ArmDeploymentWhatIfProperties
Implements

Constructors

ArmDeploymentWhatIfProperties(ArmDeploymentMode)

Initializes a new instance of ArmDeploymentWhatIfProperties.

Properties

DebugSettingDetailLevel

Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.

(Inherited from ArmDeploymentProperties)
ErrorDeployment

The deployment on error behavior.

(Inherited from ArmDeploymentProperties)
ExpressionEvaluationScope

The scope to be used for evaluation of parameters, variables and functions in a nested template.

(Inherited from ArmDeploymentProperties)
Mode

The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.

(Inherited from ArmDeploymentProperties)
Parameters

Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from ArmDeploymentProperties)
ParametersLink

The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.

(Inherited from ArmDeploymentProperties)
Template

The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from ArmDeploymentProperties)
TemplateLink

The URI of the template. Use either the templateLink property or the template property, but not both.

(Inherited from ArmDeploymentProperties)
WhatIfResultFormat

The format of the What-If results.

Explicit Interface Implementations

IJsonModel<ArmDeploymentProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ArmDeploymentProperties)
IJsonModel<ArmDeploymentProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ArmDeploymentProperties)
IJsonModel<ArmDeploymentWhatIfProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ArmDeploymentWhatIfProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ArmDeploymentProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ArmDeploymentProperties)
IPersistableModel<ArmDeploymentProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ArmDeploymentProperties)
IPersistableModel<ArmDeploymentProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ArmDeploymentProperties)
IPersistableModel<ArmDeploymentWhatIfProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ArmDeploymentWhatIfProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ArmDeploymentWhatIfProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to