remove api version hardcode, use constants

lucashuet93 · lucashuet93 · commit 3296293ef2ef · 2019-04-30T17:49:37.000-04:00
diff --git a/src/APIM_ARMTemplate/apimtemplate/Common/Constants/GlobalConstants.cs b/src/APIM_ARMTemplate/apimtemplate/Common/Constants/GlobalConstants.cs
@@ -10,7 +10,9 @@ internal static class GlobalConstants
         public const string CreateDescription = "Create an API Management instance from files";
         public const string ExtractName = "extract";
         public const string ExtractDescription = "Extract an existing API Management instance";
+
         public const string APIVersion = "2018-06-01-preview";
+        public const string LinkedAPIVersion = "2018-01-01";
 
         public const string azAccessToken = "account get-access-token --query \"accessToken\" --output json";
         public const string azSubscriptionId = "account show --query id -o json";        
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/APITemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/APITemplateCreator.cs
@@ -95,7 +95,7 @@ public async Task<APITemplateResource> CreateAPITemplateResourceAsync(APIConfig
             {
                 name = $"[concat(parameters('ApimServiceName'), '/{api.name}')]",
                 type = ResourceTypeConstants.API,
-                apiVersion = "2018-06-01-preview",
+                apiVersion = GlobalConstants.APIVersion,
                 properties = new APITemplateProperties(),
                 // if the template is not linked the depends on for the apiVersionSet needs to be inlined here
                 dependsOn = new string[] { }
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/APIVersionSetTemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/APIVersionSetTemplateCreator.cs
@@ -32,7 +32,7 @@ public Template CreateAPIVersionSetTemplate(CreatorConfig creatorConfig)
                 {
                     name = $"[concat(parameters('ApimServiceName'), '/{versionSetId}')]",
                     type = ResourceTypeConstants.APIVersionSet,
-                    apiVersion = "2018-06-01-preview",
+                    apiVersion = GlobalConstants.APIVersion,
                     properties = new APIVersionSetProperties()
                     {
                         displayName = apiVersionSet.displayName,
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/AuthorizationServerTemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/AuthorizationServerTemplateCreator.cs
@@ -31,7 +31,7 @@ public Template CreateAuthorizationServerTemplate(CreatorConfig creatorConfig)
                 {
                     name = $"[concat(parameters('ApimServiceName'), '/{authorizationServerTemplateProperties.displayName}')]",
                     type = ResourceTypeConstants.AuthorizationServer,
-                    apiVersion = "2018-06-01-preview",
+                    apiVersion = GlobalConstants.APIVersion,
                     properties = authorizationServerTemplateProperties,
                     dependsOn = new string[] { }
                 };
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/BackendTemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/BackendTemplateCreator.cs
@@ -31,7 +31,7 @@ public Template CreateBackendTemplate(CreatorConfig creatorConfig)
                 {
                     name = $"[concat(parameters('ApimServiceName'), '/{backendTemplatePropeties.title}')]",
                     type = ResourceTypeConstants.Backend,
-                    apiVersion = "2018-06-01-preview",
+                    apiVersion = GlobalConstants.APIVersion,
                     properties = backendTemplatePropeties,
                     dependsOn = new string[] { }
                 };
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/DiagnosticTemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/DiagnosticTemplateCreator.cs
@@ -11,7 +11,7 @@ public DiagnosticTemplateResource CreateAPIDiagnosticTemplateResource(APIConfig
             {
                 name = $"[concat(parameters('ApimServiceName'), '/{api.name}/{api.diagnostic.name}')]",
                 type = ResourceTypeConstants.APIDiagnostic,
-                apiVersion = "2018-06-01-preview",
+                apiVersion = GlobalConstants.APIVersion,
                 properties = new DiagnosticTemplateProperties()
                 {
                     alwaysLog = api.diagnostic.alwaysLog,
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/LoggerTemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/LoggerTemplateCreator.cs
@@ -31,7 +31,7 @@ public Template CreateLoggerTemplate(CreatorConfig creatorConfig)
                 {
                     name = $"[concat(parameters('ApimServiceName'), '/{logger.name}')]",
                     type = ResourceTypeConstants.Logger,
-                    apiVersion = "2018-06-01-preview",
+                    apiVersion = GlobalConstants.APIVersion,
                     properties = new LoggerTemplateProperties()
                     {
                         loggerType = logger.loggerType,
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/MasterTemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/MasterTemplateCreator.cs
@@ -134,7 +134,7 @@ public MasterTemplateResource CreateLinkedMasterTemplateResource(string name, st
             {
                 name = name,
                 type = "Microsoft.Resources/deployments",
-                apiVersion = "2018-01-01",
+                apiVersion = GlobalConstants.LinkedAPIVersion,
                 properties = new MasterTemplateProperties()
                 {
                     mode = "Incremental",
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/PolicyTemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/PolicyTemplateCreator.cs
@@ -23,7 +23,7 @@ public PolicyTemplateResource CreateAPIPolicyTemplateResource(APIConfig api, str
             {
                 name = $"[concat(parameters('ApimServiceName'), '/{api.name}/policy')]",
                 type = ResourceTypeConstants.APIPolicy,
-                apiVersion = "2018-06-01-preview",
+                apiVersion = GlobalConstants.APIVersion,
                 properties = new PolicyTemplateProperties()
                 {
                     contentFormat = isUrl ? "rawxml-link" : "rawxml",
@@ -43,7 +43,7 @@ public PolicyTemplateResource CreateOperationPolicyTemplateResource(KeyValuePair
             {
                 name = $"[concat(parameters('ApimServiceName'), '/{apiName}/{policyPair.Key}/policy')]",
                 type = ResourceTypeConstants.APIOperationPolicy,
-                apiVersion = "2018-06-01-preview",
+                apiVersion = GlobalConstants.APIVersion,
                 properties = new PolicyTemplateProperties()
                 {
                     contentFormat = isUrl ? "rawxml-link" : "rawxml",
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/ProductAPITemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/ProductAPITemplateCreator.cs
@@ -12,7 +12,7 @@ public ProductAPITemplateResource CreateProductAPITemplateResource(string produc
             {
                 name = $"[concat(parameters('ApimServiceName'), '/{productID}/{apiName}')]",
                 type = ResourceTypeConstants.ProductAPI,
-                apiVersion = "2018-06-01-preview",
+                apiVersion = GlobalConstants.APIVersion,
                 properties = new ProductAPITemplateProperties(),
                 dependsOn = dependsOn
             };
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/ProductTemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/ProductTemplateCreator.cs
@@ -31,7 +31,7 @@ public Template CreateProductTemplate(CreatorConfig creatorConfig)
                 {
                     name = $"[concat(parameters('ApimServiceName'), '/{productTemplateProperties.displayName}')]",
                     type = ResourceTypeConstants.Product,
-                    apiVersion = "2018-06-01-preview",
+                    apiVersion = GlobalConstants.APIVersion,
                     properties = productTemplateProperties,
                     dependsOn = new string[] { }
                 };
diff --git a/src/APIM_ARMTemplate/apimtemplate/Extractor/EntityExtractors/APIExtractor.cs b/src/APIM_ARMTemplate/apimtemplate/Extractor/EntityExtractors/APIExtractor.cs
@@ -159,7 +159,7 @@ public async Task<Template> GenerateAPIsARMTemplate(string apimname, string reso
 
                 apiResource.type = ((JValue)oApiDetails["type"]).Value.ToString();
                 apiResource.name = $"[concat(parameters('ApimServiceName'), '/{oApiName}')]";
-                apiResource.apiVersion = "2018-06-01-preview";
+                apiResource.apiVersion = GlobalConstants.APIVersion;
                 apiResource.scale = null;
 
                 if (apiResource.properties.apiVersionSetId != null)
@@ -200,7 +200,7 @@ public async Task<Template> GenerateAPIsARMTemplate(string apimname, string reso
                     OperationTemplateResource operationResource = JsonConvert.DeserializeObject<OperationTemplateResource>(operationDetails);
                     string operationResourceName = operationResource.name;
                     operationResource.name = $"[concat(parameters('ApimServiceName'), '/{oApiName}/{operationResourceName}')]";
-                    operationResource.apiVersion = "2018-06-01-preview";
+                    operationResource.apiVersion = GlobalConstants.APIVersion;
                     operationResource.scale = null;
 
                     // depend on api and schemas if necessary
@@ -241,7 +241,7 @@ public async Task<Template> GenerateAPIsARMTemplate(string apimname, string reso
                         Console.WriteLine($" - Policy found to {operationName} operation");
                         PolicyTemplateResource operationPolicyResource = JsonConvert.DeserializeObject<PolicyTemplateResource>(operationPolicy);
                         operationPolicyResource.name = $"[concat(parameters('ApimServiceName'), '/{oApiName}/{operationResourceName}/policy')]";
-                        operationPolicyResource.apiVersion = "2018-06-01-preview";
+                        operationPolicyResource.apiVersion = GlobalConstants.APIVersion;
                         operationPolicyResource.scale = null;
                         operationPolicyResource.dependsOn = new string[] { $"[resourceId('Microsoft.ApiManagement/service/apis/operations', parameters('ApimServiceName'), '{oApiName}', '{operationResourceName}')]" };
 
@@ -262,7 +262,7 @@ public async Task<Template> GenerateAPIsARMTemplate(string apimname, string reso
                     Console.WriteLine("API Policy found!");
                     PolicyTemplateResource apiPoliciesResource = JsonConvert.DeserializeObject<PolicyTemplateResource>(apiPolicies);
 
-                    apiPoliciesResource.apiVersion = "2018-06-01-preview";
+                    apiPoliciesResource.apiVersion = GlobalConstants.APIVersion;
                     apiPoliciesResource.name = $"[concat(parameters('ApimServiceName'), '/{oApiName}/{apiPoliciesResource.name}')]";
                     apiPoliciesResource.dependsOn = new string[] { $"[resourceId('Microsoft.ApiManagement/service/apis', parameters('ApimServiceName'), '{apiName}')]" };
 
@@ -288,7 +288,7 @@ public async Task<Template> GenerateAPIsARMTemplate(string apimname, string reso
                         ProductAPITemplateResource productAPIResource = JsonConvert.DeserializeObject<ProductAPITemplateResource>(apiProducts);
                         productAPIResource.type = ResourceTypeConstants.ProductAPI;
                         productAPIResource.name = $"[concat(parameters('ApimServiceName'), '/{apiProductName}/{oApiName}')]";
-                        productAPIResource.apiVersion = "2018-06-01-preview";
+                        productAPIResource.apiVersion = GlobalConstants.APIVersion;
                         productAPIResource.scale = null;
                         productAPIResource.dependsOn = new string[] { $"[resourceId('Microsoft.ApiManagement/service/apis', parameters('ApimServiceName'), '{oApiName}')]" };
 
@@ -315,7 +315,7 @@ public async Task<Template> GenerateAPIsARMTemplate(string apimname, string reso
                     DiagnosticTemplateResource diagnosticResource = diagnostic.ToObject<DiagnosticTemplateResource>();
                     diagnosticResource.name = $"[concat(parameters('ApimServiceName'), '/{oApiName}/{diagnosticName}')]";
                     diagnosticResource.type = ResourceTypeConstants.APIDiagnostic;
-                    diagnosticResource.apiVersion = "2018-06-01-preview";
+                    diagnosticResource.apiVersion = GlobalConstants.APIVersion;
                     diagnosticResource.scale = null;
                     diagnosticResource.dependsOn = new string[] { $"[resourceId('Microsoft.ApiManagement/service/apis', parameters('ApimServiceName'), '{oApiName}')]" };
 
@@ -370,7 +370,7 @@ public async void GenerateVersionSetARMTemplate(string apimname, string resource
             string filePath = fileFolder + Path.DirectorySeparatorChar + string.Format(versionSetResource.name, "/", "-") + ".json";
 
             versionSetResource.name = $"[concat(parameters('ApimServiceName'), '/{versionSetResource.name}')]";
-            versionSetResource.apiVersion = "2018-06-01-preview";
+            versionSetResource.apiVersion = GlobalConstants.APIVersion;
 
             templateResources.Add(versionSetResource);
             armTemplate.resources = templateResources.ToArray();
@@ -400,7 +400,7 @@ public async Task<List<TemplateResource>> GenerateSchemasARMTemplate(string apim
                 SchemaTemplateResource schemaDetailsResource = JsonConvert.DeserializeObject<SchemaTemplateResource>(schemaDetails);
                 schemaDetailsResource.properties.document.value = JsonConvert.SerializeObject(restReturnedSchemaTemplate.properties.document);
                 schemaDetailsResource.name = $"[concat(parameters('ApimServiceName'), '/{apiName}/{schemaName}')]";
-                schemaDetailsResource.apiVersion = "2018-06-01-preview";
+                schemaDetailsResource.apiVersion = GlobalConstants.APIVersion;
                 schemaDetailsResource.dependsOn = new string[] { $"[resourceId('Microsoft.ApiManagement/service/apis', parameters('ApimServiceName'), '{apiName}')]" };
 
                 templateResources.Add(schemaDetailsResource);
diff --git a/src/APIM_ARMTemplate/apimtemplate/Extractor/EntityExtractors/AuthorizationServerExtractor.cs b/src/APIM_ARMTemplate/apimtemplate/Extractor/EntityExtractors/AuthorizationServerExtractor.cs
@@ -51,7 +51,7 @@ public async Task<Template> GenerateAuthorizationServersARMTemplate(string apimn
 
                 AuthorizationServerTemplateResource authorizationServerTemplateResource = JsonConvert.DeserializeObject<AuthorizationServerTemplateResource>(authorizationServer);
                 authorizationServerTemplateResource.name = $"[concat(parameters('ApimServiceName'), '/{authorizationServerName}')]";
-                authorizationServerTemplateResource.apiVersion = "2018-06-01-preview";
+                authorizationServerTemplateResource.apiVersion = GlobalConstants.APIVersion;
 
                 // only extract the authorization server if this is a full extraction, or in the case of a single api, if it is referenced by one of the api's authentication settings
                 bool isReferencedByAPI = false;
diff --git a/src/APIM_ARMTemplate/apimtemplate/Extractor/EntityExtractors/BackendExtractor.cs b/src/APIM_ARMTemplate/apimtemplate/Extractor/EntityExtractors/BackendExtractor.cs
@@ -52,7 +52,7 @@ public async Task<Template> GenerateBackendsARMTemplate(string apimname, string
 
                 BackendTemplateResource backendTemplateResource = JsonConvert.DeserializeObject<BackendTemplateResource>(backend);
                 backendTemplateResource.name = $"[concat(parameters('ApimServiceName'), '/{backendName}')]";
-                backendTemplateResource.apiVersion = "2018-06-01-preview";
+                backendTemplateResource.apiVersion = GlobalConstants.APIVersion;
 
                 //only extract the backend if this is a full extraction, or in the case of a single api, if it is referenced by one of the policies
                 if (singleApiName == null)
diff --git a/src/APIM_ARMTemplate/apimtemplate/Extractor/EntityExtractors/LoggerExtractor.cs b/src/APIM_ARMTemplate/apimtemplate/Extractor/EntityExtractors/LoggerExtractor.cs
@@ -52,7 +52,7 @@ public async Task<Template> GenerateLoggerTemplate(string apimname, string resou
                 LoggerTemplateResource loggerResource = JsonConvert.DeserializeObject<LoggerTemplateResource>(fullLoggerResource);
                 loggerResource.name = $"[concat(parameters('ApimServiceName'), '/{loggerName}')]";
                 loggerResource.type = ResourceTypeConstants.Logger;
-                loggerResource.apiVersion = "2018-06-01-preview";
+                loggerResource.apiVersion = GlobalConstants.APIVersion;
                 loggerResource.scale = null;
 
                 if (singleApiName == null)
diff --git a/src/APIM_ARMTemplate/apimtemplate/Extractor/EntityExtractors/ProductExtractor.cs b/src/APIM_ARMTemplate/apimtemplate/Extractor/EntityExtractors/ProductExtractor.cs
@@ -57,7 +57,7 @@ public async Task<Template> GenerateProductsARMTemplate(string apimname, string
 
                 ProductsTemplateResource productsTemplateResource = JsonConvert.DeserializeObject<ProductsTemplateResource>(productDetails, settings);
                 productsTemplateResource.name = $"[concat(parameters('ApimServiceName'), '/{productName}')]";
-                productsTemplateResource.apiVersion = "2018-06-01-preview";
+                productsTemplateResource.apiVersion = GlobalConstants.APIVersion;
 
                 // only extract the product if this is a full extraction, or in the case of a single api, if it is found in products associated with the api
                 if (singleApiName == null || productAPIResources.SingleOrDefault(p => p.name.Contains(productName)) != null)
diff --git a/src/APIM_ARMTemplate/apimtemplate/Extractor/EntityExtractors/PropertyExtractor.cs b/src/APIM_ARMTemplate/apimtemplate/Extractor/EntityExtractors/PropertyExtractor.cs
@@ -48,7 +48,7 @@ public async Task<Template> GenerateNamedValuesTemplate(string apimname, string
                 PropertyTemplateResource propertyTemplateResource = JsonConvert.DeserializeObject<PropertyTemplateResource>(fullLoggerResource);
                 propertyTemplateResource.name = $"[concat(parameters('ApimServiceName'), '/{propertyName}')]";
                 propertyTemplateResource.type = ResourceTypeConstants.Property;
-                propertyTemplateResource.apiVersion = "2018-06-01-preview";
+                propertyTemplateResource.apiVersion = GlobalConstants.APIVersion;
                 propertyTemplateResource.scale = null;
 
                 if (singleApiName == null)

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public async Task<APITemplateResource> CreateAPITemplateResourceAsync(APIConfig`
`95`	`95`	`{`
`96`	`96`	`name = $"[concat(parameters('ApimServiceName'), '/{api.name}')]",`
`97`	`97`	`type = ResourceTypeConstants.API,`
`98`		`- apiVersion = "2018-06-01-preview",`
	`98`	`+ apiVersion = GlobalConstants.APIVersion,`
`99`	`99`	`properties = new APITemplateProperties(),`
`100`	`100`	`// if the template is not linked the depends on for the apiVersionSet needs to be inlined here`
`101`	`101`	`dependsOn = new string[] { }`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public Template CreateAPIVersionSetTemplate(CreatorConfig creatorConfig)`
`32`	`32`	`{`
`33`	`33`	`name = $"[concat(parameters('ApimServiceName'), '/{versionSetId}')]",`
`34`	`34`	`type = ResourceTypeConstants.APIVersionSet,`
`35`		`- apiVersion = "2018-06-01-preview",`
	`35`	`+ apiVersion = GlobalConstants.APIVersion,`
`36`	`36`	`properties = new APIVersionSetProperties()`
`37`	`37`	`{`
`38`	`38`	`displayName = apiVersionSet.displayName,`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public Template CreateAuthorizationServerTemplate(CreatorConfig creatorConfig)`
`31`	`31`	`{`
`32`	`32`	`name = $"[concat(parameters('ApimServiceName'), '/{authorizationServerTemplateProperties.displayName}')]",`
`33`	`33`	`type = ResourceTypeConstants.AuthorizationServer,`
`34`		`- apiVersion = "2018-06-01-preview",`
	`34`	`+ apiVersion = GlobalConstants.APIVersion,`
`35`	`35`	`properties = authorizationServerTemplateProperties,`
`36`	`36`	`dependsOn = new string[] { }`
`37`	`37`	`};`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ public DiagnosticTemplateResource CreateAPIDiagnosticTemplateResource(APIConfig`
`11`	`11`	`{`
`12`	`12`	`name = $"[concat(parameters('ApimServiceName'), '/{api.name}/{api.diagnostic.name}')]",`
`13`	`13`	`type = ResourceTypeConstants.APIDiagnostic,`
`14`		`- apiVersion = "2018-06-01-preview",`
	`14`	`+ apiVersion = GlobalConstants.APIVersion,`
`15`	`15`	`properties = new DiagnosticTemplateProperties()`
`16`	`16`	`{`
`17`	`17`	`alwaysLog = api.diagnostic.alwaysLog,`
Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ public MasterTemplateResource CreateLinkedMasterTemplateResource(string name, st`
`134`	`134`	`{`
`135`	`135`	`name = name,`
`136`	`136`	`type = "Microsoft.Resources/deployments",`
`137`		`- apiVersion = "2018-01-01",`
	`137`	`+ apiVersion = GlobalConstants.LinkedAPIVersion,`
`138`	`138`	`properties = new MasterTemplateProperties()`
`139`	`139`	`{`
`140`	`140`	`mode = "Incremental",`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public PolicyTemplateResource CreateAPIPolicyTemplateResource(APIConfig api, str`
`23`	`23`	`{`
`24`	`24`	`name = $"[concat(parameters('ApimServiceName'), '/{api.name}/policy')]",`
`25`	`25`	`type = ResourceTypeConstants.APIPolicy,`
`26`		`- apiVersion = "2018-06-01-preview",`
	`26`	`+ apiVersion = GlobalConstants.APIVersion,`
`27`	`27`	`properties = new PolicyTemplateProperties()`
`28`	`28`	`{`
`29`	`29`	`contentFormat = isUrl ? "rawxml-link" : "rawxml",`
`@@ -43,7 +43,7 @@ public PolicyTemplateResource CreateOperationPolicyTemplateResource(KeyValuePair`
`43`	`43`	`{`
`44`	`44`	`name = $"[concat(parameters('ApimServiceName'), '/{apiName}/{policyPair.Key}/policy')]",`
`45`	`45`	`type = ResourceTypeConstants.APIOperationPolicy,`
`46`		`- apiVersion = "2018-06-01-preview",`
	`46`	`+ apiVersion = GlobalConstants.APIVersion,`
`47`	`47`	`properties = new PolicyTemplateProperties()`
`48`	`48`	`{`
`49`	`49`	`contentFormat = isUrl ? "rawxml-link" : "rawxml",`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public ProductAPITemplateResource CreateProductAPITemplateResource(string produc`
`12`	`12`	`{`
`13`	`13`	`name = $"[concat(parameters('ApimServiceName'), '/{productID}/{apiName}')]",`
`14`	`14`	`type = ResourceTypeConstants.ProductAPI,`
`15`		`- apiVersion = "2018-06-01-preview",`
	`15`	`+ apiVersion = GlobalConstants.APIVersion,`
`16`	`16`	`properties = new ProductAPITemplateProperties(),`
`17`	`17`	`dependsOn = dependsOn`
`18`	`18`	`};`