-
Notifications
You must be signed in to change notification settings - Fork 180
/
DeploymentWhatIfProperties.yml
169 lines (169 loc) · 6.72 KB
/
DeploymentWhatIfProperties.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
### YamlMime:TSType
name: DeploymentWhatIfProperties
uid: '@azure/arm-resources.DeploymentWhatIfProperties'
package: '@azure/arm-resources'
summary: Deployment What-if properties.
fullName: DeploymentWhatIfProperties
remarks: ''
isDeprecated: false
type: interface
properties:
- name: whatIfSettings
uid: '@azure/arm-resources.DeploymentWhatIfProperties.whatIfSettings'
package: '@azure/arm-resources'
summary: Optional What-If operation settings.
fullName: whatIfSettings
remarks: ''
isDeprecated: false
syntax:
content: 'whatIfSettings?: DeploymentWhatIfSettings'
return:
description: ''
type: <xref uid="@azure/arm-resources.DeploymentWhatIfSettings" />
inheritedProperties:
- name: debugSetting
uid: '@azure/arm-resources.DeploymentWhatIfProperties.debugSetting'
package: '@azure/arm-resources'
summary: The debug setting of the deployment.
fullName: debugSetting
remarks: ''
isDeprecated: false
syntax:
content: 'debugSetting?: DebugSetting'
return:
description: ''
type: <xref uid="@azure/arm-resources.DebugSetting" />
inheritanceDescription: >-
<b>Inherited From</b>
[DeploymentProperties.debugSetting](xref:@azure/arm-resources.DeploymentProperties.debugSetting)
- name: expressionEvaluationOptions
uid: >-
@azure/arm-resources.DeploymentWhatIfProperties.expressionEvaluationOptions
package: '@azure/arm-resources'
summary: >-
Specifies whether template expressions are evaluated within the scope of
the parent template or nested template. Only applicable to nested
templates. If not specified, default value is outer.
fullName: expressionEvaluationOptions
remarks: ''
isDeprecated: false
syntax:
content: 'expressionEvaluationOptions?: ExpressionEvaluationOptions'
return:
description: ''
type: <xref uid="@azure/arm-resources.ExpressionEvaluationOptions" />
inheritanceDescription: >-
<b>Inherited From</b>
[DeploymentProperties.expressionEvaluationOptions](xref:@azure/arm-resources.DeploymentProperties.expressionEvaluationOptions)
- name: mode
uid: '@azure/arm-resources.DeploymentWhatIfProperties.mode'
package: '@azure/arm-resources'
summary: >-
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.
fullName: mode
remarks: ''
isDeprecated: false
syntax:
content: 'mode: DeploymentMode'
return:
description: ''
type: <xref uid="@azure/arm-resources.DeploymentMode" />
inheritanceDescription: >-
<b>Inherited From</b>
[DeploymentProperties.mode](xref:@azure/arm-resources.DeploymentProperties.mode)
- name: onErrorDeployment
uid: '@azure/arm-resources.DeploymentWhatIfProperties.onErrorDeployment'
package: '@azure/arm-resources'
summary: The deployment on error behavior.
fullName: onErrorDeployment
remarks: ''
isDeprecated: false
syntax:
content: 'onErrorDeployment?: OnErrorDeployment'
return:
description: ''
type: <xref uid="@azure/arm-resources.OnErrorDeployment" />
inheritanceDescription: >-
<b>Inherited From</b>
[DeploymentProperties.onErrorDeployment](xref:@azure/arm-resources.DeploymentProperties.onErrorDeployment)
- name: parameters
uid: '@azure/arm-resources.DeploymentWhatIfProperties.parameters'
package: '@azure/arm-resources'
summary: >-
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.
fullName: parameters
remarks: ''
isDeprecated: false
syntax:
content: 'parameters?: Record<string, unknown>'
return:
description: ''
type: Record<string, unknown>
inheritanceDescription: >-
<b>Inherited From</b>
[DeploymentProperties.parameters](xref:@azure/arm-resources.DeploymentProperties.parameters)
- name: parametersLink
uid: '@azure/arm-resources.DeploymentWhatIfProperties.parametersLink'
package: '@azure/arm-resources'
summary: >-
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.
fullName: parametersLink
remarks: ''
isDeprecated: false
syntax:
content: 'parametersLink?: ParametersLink'
return:
description: ''
type: <xref uid="@azure/arm-resources.ParametersLink" />
inheritanceDescription: >-
<b>Inherited From</b>
[DeploymentProperties.parametersLink](xref:@azure/arm-resources.DeploymentProperties.parametersLink)
- name: template
uid: '@azure/arm-resources.DeploymentWhatIfProperties.template'
package: '@azure/arm-resources'
summary: >-
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.
fullName: template
remarks: ''
isDeprecated: false
syntax:
content: 'template?: Record<string, unknown>'
return:
description: ''
type: Record<string, unknown>
inheritanceDescription: >-
<b>Inherited From</b>
[DeploymentProperties.template](xref:@azure/arm-resources.DeploymentProperties.template)
- name: templateLink
uid: '@azure/arm-resources.DeploymentWhatIfProperties.templateLink'
package: '@azure/arm-resources'
summary: >-
The URI of the template. Use either the templateLink property or the
template property, but not both.
fullName: templateLink
remarks: ''
isDeprecated: false
syntax:
content: 'templateLink?: TemplateLink'
return:
description: ''
type: <xref uid="@azure/arm-resources.TemplateLink" />
inheritanceDescription: >-
<b>Inherited From</b>
[DeploymentProperties.templateLink](xref:@azure/arm-resources.DeploymentProperties.templateLink)
extends: <xref uid="@azure/arm-resources.DeploymentProperties" />