[ReleasePR @azure/arm-resources] [Resources] Add support for MG and tenant level What-If

sdk/resources/arm-resources/src/models/deploymentOperationsMappers.ts

@@ -14,5 +14,6 @@ export {
   ErrorAdditionalInfo,
   ErrorResponse,
   HttpMessage,
+  StatusMessage,
   TargetResource
 } from "../models/mappers";

sdk/resources/arm-resources/src/models/deploymentsMappers.ts

@@ -21,7 +21,9 @@ export {
   DeploymentListResult,
   DeploymentProperties,
   DeploymentPropertiesExtended,
+  DeploymentsWhatIfAtManagementGroupScopeHeaders,
   DeploymentsWhatIfAtSubscriptionScopeHeaders,
+  DeploymentsWhatIfAtTenantScopeHeaders,
   DeploymentsWhatIfHeaders,
   DeploymentValidateResult,
   DeploymentWhatIf,
@@ -44,6 +46,7 @@ export {
   ResourceGroupProperties,
   ResourceReference,
   ScopedDeployment,
+  ScopedDeploymentWhatIf,
   Sku,
   SubResource,
   TagCount,

sdk/resources/arm-resources/src/models/index.ts

@@ -58,9 +58,18 @@ export interface ResourceGroupFilter {
  */
 export interface TemplateLink {
   /**
-   * The URI of the template to deploy.
+   * The URI of the template to deploy. Use either the uri or id property, but not both.
    */
-  uri: string;
+  uri?: string;
+  /**
+   * The resource id of a Template Spec. Use either the id or uri property, but not both.
+   */
+  id?: string;
+  /**
+   * Applicable only if this template link references a Template Spec. This relativePath property
+   * can optionally be used to reference a Template Spec artifact by path.
+   */
+  relativePath?: string;
   /**
    * If included, must match the ContentVersion in the template.
    */
@@ -238,6 +247,20 @@ export interface DeploymentWhatIf {
   properties: DeploymentWhatIfProperties;
 }
 
+/**
+ * Deployment What-if operation parameters.
+ */
+export interface ScopedDeploymentWhatIf {
+  /**
+   * The location to store the deployment data.
+   */
+  location: string;
+  /**
+   * The deployment properties.
+   */
+  properties: DeploymentWhatIfProperties;
+}
+
 /**
  * The resource management error additional info.
  */
@@ -483,10 +506,12 @@ export interface ResourceReference {
  */
 export interface DeploymentPropertiesExtended {
   /**
-   * The state of the provisioning.
+   * Denotes the state of provisioning. Possible values include: 'NotSpecified', 'Accepted',
+   * 'Running', 'Ready', 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed',
+   * 'Succeeded', 'Updating'
    * **NOTE: This property will not be serialized. It can only be populated by the server.**
    */
-  readonly provisioningState?: string;
+  readonly provisioningState?: ProvisioningState;
   /**
    * The correlation ID of the deployment.
    * **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -987,6 +1012,20 @@ export interface HttpMessage {
   content?: any;
 }
 
+/**
+ * Operation status message object.
+ */
+export interface StatusMessage {
+  /**
+   * Status of the deployment operation.
+   */
+  status?: string;
+  /**
+   * The error reported by the operation.
+   */
+  error?: ErrorResponse;
+}
+
 /**
  * Deployment operation properties.
  */
@@ -1019,15 +1058,17 @@ export interface DeploymentOperationProperties {
    */
   readonly serviceRequestId?: string;
   /**
-   * Operation status code.
+   * Operation status code from the resource provider. This property may not be set if a response
+   * has not yet been received.
    * **NOTE: This property will not be serialized. It can only be populated by the server.**
    */
   readonly statusCode?: string;
   /**
-   * Operation status message.
+   * Operation status message from the resource provider. This property is optional.  It will only
+   * be provided if an error was received from the resource provider.
    * **NOTE: This property will not be serialized. It can only be populated by the server.**
    */
-  readonly statusMessage?: any;
+  readonly statusMessage?: StatusMessage;
   /**
    * The target resource.
    * **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -1552,6 +1593,34 @@ export interface ResourceManagementClientOptions extends AzureServiceClientOptio
   baseUri?: string;
 }
 
+/**
+ * Defines headers for WhatIfAtTenantScope operation.
+ */
+export interface DeploymentsWhatIfAtTenantScopeHeaders {
+  /**
+   * URL to get status of this long-running operation.
+   */
+  location: string;
+  /**
+   * Number of seconds to wait before polling for status.
+   */
+  retryAfter: string;
+}
+
+/**
+ * Defines headers for WhatIfAtManagementGroupScope operation.
+ */
+export interface DeploymentsWhatIfAtManagementGroupScopeHeaders {
+  /**
+   * URL to get status of this long-running operation.
+   */
+  location: string;
+  /**
+   * Number of seconds to wait before polling for status.
+   */
+  retryAfter: string;
+}
+
 /**
  * Defines headers for WhatIfAtSubscriptionScope operation.
  */
@@ -1711,6 +1780,15 @@ export type AliasPatternType = 'NotSpecified' | 'Extract';
  */
 export type AliasType = 'NotSpecified' | 'PlainText' | 'Mask';
 
+/**
+ * Defines values for ProvisioningState.
+ * Possible values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', 'Creating', 'Created',
+ * 'Deleting', 'Deleted', 'Canceled', 'Failed', 'Succeeded', 'Updating'
+ * @readonly
+ * @enum {string}
+ */
+export type ProvisioningState = 'NotSpecified' | 'Accepted' | 'Running' | 'Ready' | 'Creating' | 'Created' | 'Deleting' | 'Deleted' | 'Canceled' | 'Failed' | 'Succeeded' | 'Updating';
+
 /**
  * Defines values for ResourceIdentityType.
  * Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned',
@@ -2004,6 +2082,31 @@ export type DeploymentsValidateAtTenantScopeResponse = DeploymentValidateResult
     };
 };
 
+/**
+ * Contains response data for the whatIfAtTenantScope operation.
+ */
+export type DeploymentsWhatIfAtTenantScopeResponse = WhatIfOperationResult & DeploymentsWhatIfAtTenantScopeHeaders & {
+  /**
+   * The underlying HTTP response.
+   */
+  _response: msRest.HttpResponse & {
+      /**
+       * The parsed HTTP response headers.
+       */
+      parsedHeaders: DeploymentsWhatIfAtTenantScopeHeaders;
+
+      /**
+       * The response body as text (string format)
+       */
+      bodyAsText: string;
+
+      /**
+       * The response body as parsed JSON or XML
+       */
+      parsedBody: WhatIfOperationResult;
+    };
+};
+
 /**
  * Contains response data for the exportTemplateAtTenantScope operation.
  */
@@ -2129,6 +2232,31 @@ export type DeploymentsValidateAtManagementGroupScopeResponse = DeploymentValida
     };
 };
 
+/**
+ * Contains response data for the whatIfAtManagementGroupScope operation.
+ */
+export type DeploymentsWhatIfAtManagementGroupScopeResponse = WhatIfOperationResult & DeploymentsWhatIfAtManagementGroupScopeHeaders & {
+  /**
+   * The underlying HTTP response.
+   */
+  _response: msRest.HttpResponse & {
+      /**
+       * The parsed HTTP response headers.
+       */
+      parsedHeaders: DeploymentsWhatIfAtManagementGroupScopeHeaders;
+
+      /**
+       * The response body as text (string format)
+       */
+      bodyAsText: string;
+
+      /**
+       * The response body as parsed JSON or XML
+       */
+      parsedBody: WhatIfOperationResult;
+    };
+};
+
 /**
  * Contains response data for the exportTemplateAtManagementGroupScope operation.
  */

sdk/resources/arm-resources/src/models/mappers.ts

@@ -85,12 +85,23 @@ export const TemplateLink: msRest.CompositeMapper = {
     className: "TemplateLink",
     modelProperties: {
       uri: {
-        required: true,
         serializedName: "uri",
         type: {
           name: "String"
         }
       },
+      id: {
+        serializedName: "id",
+        type: {
+          name: "String"
+        }
+      },
+      relativePath: {
+        serializedName: "relativePath",
+        type: {
+          name: "String"
+        }
+      },
       contentVersion: {
         serializedName: "contentVersion",
         type: {
@@ -376,6 +387,31 @@ export const DeploymentWhatIf: msRest.CompositeMapper = {
   }
 };
 
+export const ScopedDeploymentWhatIf: msRest.CompositeMapper = {
+  serializedName: "ScopedDeploymentWhatIf",
+  type: {
+    name: "Composite",
+    className: "ScopedDeploymentWhatIf",
+    modelProperties: {
+      location: {
+        required: true,
+        serializedName: "location",
+        type: {
+          name: "String"
+        }
+      },
+      properties: {
+        required: true,
+        serializedName: "properties",
+        type: {
+          name: "Composite",
+          className: "DeploymentWhatIfProperties"
+        }
+      }
+    }
+  }
+};
+
 export const ErrorAdditionalInfo: msRest.CompositeMapper = {
   serializedName: "ErrorAdditionalInfo",
   type: {
@@ -1654,6 +1690,29 @@ export const HttpMessage: msRest.CompositeMapper = {
   }
 };
 
+export const StatusMessage: msRest.CompositeMapper = {
+  serializedName: "StatusMessage",
+  type: {
+    name: "Composite",
+    className: "StatusMessage",
+    modelProperties: {
+      status: {
+        serializedName: "status",
+        type: {
+          name: "String"
+        }
+      },
+      error: {
+        serializedName: "error",
+        type: {
+          name: "Composite",
+          className: "ErrorResponse"
+        }
+      }
+    }
+  }
+};
+
 export const DeploymentOperationProperties: msRest.CompositeMapper = {
   serializedName: "DeploymentOperationProperties",
   type: {
@@ -1718,7 +1777,8 @@ export const DeploymentOperationProperties: msRest.CompositeMapper = {
         readOnly: true,
         serializedName: "statusMessage",
         type: {
-          name: "Object"
+          name: "Composite",
+          className: "StatusMessage"
         }
       },
       targetResource: {
@@ -2166,6 +2226,50 @@ export const TagsResource: msRest.CompositeMapper = {
   }
 };
 
+export const DeploymentsWhatIfAtTenantScopeHeaders: msRest.CompositeMapper = {
+  serializedName: "deployments-whatifattenantscope-headers",
+  type: {
+    name: "Composite",
+    className: "DeploymentsWhatIfAtTenantScopeHeaders",
+    modelProperties: {
+      location: {
+        serializedName: "location",
+        type: {
+          name: "String"
+        }
+      },
+      retryAfter: {
+        serializedName: "retry-after",
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};
+
+export const DeploymentsWhatIfAtManagementGroupScopeHeaders: msRest.CompositeMapper = {
+  serializedName: "deployments-whatifatmanagementgroupscope-headers",
+  type: {
+    name: "Composite",
+    className: "DeploymentsWhatIfAtManagementGroupScopeHeaders",
+    modelProperties: {
+      location: {
+        serializedName: "location",
+        type: {
+          name: "String"
+        }
+      },
+      retryAfter: {
+        serializedName: "retry-after",
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};
+
 export const DeploymentsWhatIfAtSubscriptionScopeHeaders: msRest.CompositeMapper = {
   serializedName: "deployments-whatifatsubscriptionscope-headers",
   type: {