feat: add cloud endpoint support

Azure · Nov 18, 2024 · 923eb2e · 923eb2e
1 parent bd76686
commit 923eb2e
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 24 deletions.
diff --git a/action.yml b/action.yml
@@ -3,8 +3,8 @@ description: "GitHub Action for deploying to Azure"
 author: "Microsoft"
 
 branding:
-  icon: 'upload-cloud'
-  color: 'blue'
+  icon: "upload-cloud"
+  color: "blue"
 
 inputs:
   type:
@@ -54,7 +54,6 @@ inputs:
     description: "Specifies the parameters to use."
     required: false
 
-
   what-if-exclude-change-types:
     description: "Specifies the change types to exclude from the 'What If' operation."
     required: false
@@ -93,6 +92,10 @@ inputs:
     description: "Specifies output names to mask values for."
     required: false
 
+  cloud:
+    description: "Specifies the cloud to use. Choose from 'azureChinaCloud', 'azureGermanCloud', 'azureUSGovernment'."
+    required: false
+
 runs:
   using: node20
   main: dist/index.js
diff --git a/dist/index.js b/dist/index.js
@@ -59278,6 +59278,11 @@ function parseConfig() {
     const description = (0, input_1.getOptionalStringInput)("description");
     const tags = (0, input_1.getOptionalStringDictionaryInput)("tags");
     const maskedOutputs = (0, input_1.getOptionalStringArrayInput)("masked-outputs");
+    const cloud = (0, input_1.getOptionalEnumInput)("cloud", [
+        "azureChinaCloud",
+        "azureUSGovernment",
+        "azureGermanCloud",
+    ]);
     switch (type) {
         case "deployment": {
             return {
@@ -59289,6 +59294,7 @@ function parseConfig() {
                 parameters,
                 tags,
                 maskedOutputs,
+                cloud,
                 operation: (0, input_1.getRequiredEnumInput)("operation", [
                     "create",
                     "validate",
@@ -59319,6 +59325,7 @@ function parseConfig() {
                 description,
                 tags,
                 maskedOutputs,
+                cloud,
                 operation: (0, input_1.getRequiredEnumInput)("operation", [
                     "create",
                     "validate",
@@ -59446,15 +59453,15 @@ const azure_1 = __nccwpck_require__(5886);
 const logging_1 = __nccwpck_require__(5504);
 const whatif_1 = __nccwpck_require__(5180);
 const defaultName = "azure-bicep-deploy";
-function getDeploymentClient(scope) {
+function getDeploymentClient(config, scope) {
     const { tenantId } = scope;
     const subscriptionId = "subscriptionId" in scope ? scope.subscriptionId : undefined;
-    return (0, azure_1.createDeploymentClient)(subscriptionId, tenantId);
+    return (0, azure_1.createDeploymentClient)(config, subscriptionId, tenantId);
 }
-function getStacksClient(scope) {
+function getStacksClient(config, scope) {
     const { tenantId } = scope;
     const subscriptionId = "subscriptionId" in scope ? scope.subscriptionId : undefined;
-    return (0, azure_1.createStacksClient)(subscriptionId, tenantId);
+    return (0, azure_1.createStacksClient)(config, subscriptionId, tenantId);
 }
 async function execute(config, files) {
     try {
@@ -59543,7 +59550,7 @@ function setCreateOutputs(config, outputs) {
 async function deploymentCreate(config, files) {
     const name = config.name ?? defaultName;
     const scope = config.scope;
-    const client = getDeploymentClient(scope);
+    const client = getDeploymentClient(config, scope);
     const deployment = getDeployment(config, files);
     switch (scope.type) {
         case "resourceGroup":
@@ -59568,7 +59575,7 @@ async function deploymentCreate(config, files) {
 async function deploymentValidate(config, files) {
     const name = config.name ?? defaultName;
     const scope = config.scope;
-    const client = getDeploymentClient(scope);
+    const client = getDeploymentClient(config, scope);
     const deployment = getDeployment(config, files);
     switch (scope.type) {
         case "resourceGroup":
@@ -59593,7 +59600,7 @@ async function deploymentValidate(config, files) {
 async function deploymentWhatIf(config, files) {
     const deploymentName = config.name ?? defaultName;
     const scope = config.scope;
-    const client = getDeploymentClient(scope);
+    const client = getDeploymentClient(config, scope);
     const deployment = getDeployment(config, files);
     switch (scope.type) {
         case "resourceGroup":
@@ -59638,7 +59645,7 @@ function getDeployment(config, files) {
 async function stackCreate(config, files) {
     const name = config.name ?? defaultName;
     const scope = config.scope;
-    const client = getStacksClient(scope);
+    const client = getStacksClient(config, scope);
     const stack = getStack(config, files);
     switch (scope.type) {
         case "resourceGroup":
@@ -59658,7 +59665,7 @@ async function stackCreate(config, files) {
 async function stackValidate(config, files) {
     const name = config.name ?? defaultName;
     const scope = config.scope;
-    const client = getStacksClient(scope);
+    const client = getStacksClient(config, scope);
     const stack = getStack(config, files);
     switch (scope.type) {
         case "resourceGroup":
@@ -59678,7 +59685,7 @@ async function stackValidate(config, files) {
 async function stackDelete(config) {
     const name = config.name ?? defaultName;
     const scope = config.scope;
-    const client = getStacksClient(scope);
+    const client = getStacksClient(config, scope);
     const deletionOptions = getStackDeletionOptions(config);
     switch (scope.type) {
         case "resourceGroup":
@@ -59793,7 +59800,12 @@ const identity_1 = __nccwpck_require__(3983);
 const core_1 = __nccwpck_require__(7484);
 const userAgentPrefix = "gh-azure-bicep-deploy";
 const dummySubscriptionId = "00000000-0000-0000-0000-000000000000";
-function createDeploymentClient(subscriptionId, tenantId) {
+const cloudEndpoints = {
+    azureChinaCloud: "https://management.chinacloudapi.cn",
+    azureGermanCloud: "https://management.microsoftazure.de",
+    azureUSGovernment: "https://management.usgovcloudapi.net",
+};
+function createDeploymentClient(config, subscriptionId, tenantId) {
     const credentials = new identity_1.DefaultAzureCredential({ tenantId });
     return new arm_resources_1.ResourceManagementClient(credentials, 
     // Use a dummy subscription ID for above-subscription scope operations
@@ -59804,9 +59816,10 @@ function createDeploymentClient(subscriptionId, tenantId) {
         additionalPolicies: [debugLoggingPolicy],
         // Use a recent API version to take advantage of error improvements
         apiVersion: "2024-03-01",
+        endpoint: config.cloud ? cloudEndpoints[config.cloud] : undefined,
     });
 }
-function createStacksClient(subscriptionId, tenantId) {
+function createStacksClient(config, subscriptionId, tenantId) {
     const credentials = new identity_1.DefaultAzureCredential({ tenantId });
     return new arm_resourcesdeploymentstacks_1.DeploymentStacksClient(credentials, 
     // Use a dummy subscription ID for above-subscription scope operations
@@ -59815,6 +59828,7 @@ function createStacksClient(subscriptionId, tenantId) {
             userAgentPrefix: userAgentPrefix,
         },
         additionalPolicies: [debugLoggingPolicy],
+        endpoint: config.cloud ? cloudEndpoints[config.cloud] : undefined,
     });
 }
 // Log request + response bodies to GitHub Actions debug output if enabled

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/config.ts b/src/config.ts
@@ -56,6 +56,7 @@ type CommonConfig = {
   location?: string;
   tags?: Record<string, string>;
   maskedOutputs?: string[];
+  cloud?: "azureChinaCloud" | "azureUSGovernment" | "azureGermanCloud";
 } & FileConfig;
 
 type WhatIfChangeType =
@@ -110,6 +111,11 @@ export function parseConfig(): DeploymentsConfig | DeploymentStackConfig {
   const description = getOptionalStringInput("description");
   const tags = getOptionalStringDictionaryInput("tags");
   const maskedOutputs = getOptionalStringArrayInput("masked-outputs");
+  const cloud = getOptionalEnumInput("cloud", [
+    "azureChinaCloud",
+    "azureUSGovernment",
+    "azureGermanCloud",
+  ]);
 
   switch (type) {
     case "deployment": {
@@ -122,6 +128,7 @@ export function parseConfig(): DeploymentsConfig | DeploymentStackConfig {
         parameters,
         tags,
         maskedOutputs,
+        cloud,
         operation: getRequiredEnumInput("operation", [
           "create",
           "validate",
@@ -155,6 +162,7 @@ export function parseConfig(): DeploymentsConfig | DeploymentStackConfig {
         description,
         tags,
         maskedOutputs,
+        cloud,
         operation: getRequiredEnumInput("operation", [
           "create",
           "validate",

diff --git a/src/handler.ts b/src/handler.ts
@@ -23,6 +23,7 @@ import { formatWhatIfOperationResult } from "./helpers/whatif";
 const defaultName = "azure-bicep-deploy";
 
 function getDeploymentClient(
+  config: ActionConfig,
   scope:
     | TenantScope
     | ManagementGroupScope
@@ -33,10 +34,11 @@ function getDeploymentClient(
   const subscriptionId =
     "subscriptionId" in scope ? scope.subscriptionId : undefined;
 
-  return createDeploymentClient(subscriptionId, tenantId);
+  return createDeploymentClient(config, subscriptionId, tenantId);
 }
 
 function getStacksClient(
+  config: ActionConfig,
   scope:
     | TenantScope
     | ManagementGroupScope
@@ -47,7 +49,7 @@ function getStacksClient(
   const subscriptionId =
     "subscriptionId" in scope ? scope.subscriptionId : undefined;
 
-  return createStacksClient(subscriptionId, tenantId);
+  return createStacksClient(config, subscriptionId, tenantId);
 }
 
 export async function execute(config: ActionConfig, files: ParsedFiles) {
@@ -160,7 +162,7 @@ function setCreateOutputs(
 async function deploymentCreate(config: DeploymentsConfig, files: ParsedFiles) {
   const name = config.name ?? defaultName;
   const scope = config.scope;
-  const client = getDeploymentClient(scope);
+  const client = getDeploymentClient(config, scope);
   const deployment = getDeployment(config, files);
 
   switch (scope.type) {
@@ -201,7 +203,7 @@ async function deploymentValidate(
 ) {
   const name = config.name ?? defaultName;
   const scope = config.scope;
-  const client = getDeploymentClient(scope);
+  const client = getDeploymentClient(config, scope);
   const deployment = getDeployment(config, files);
 
   switch (scope.type) {
@@ -239,7 +241,7 @@ async function deploymentValidate(
 async function deploymentWhatIf(config: DeploymentsConfig, files: ParsedFiles) {
   const deploymentName = config.name ?? defaultName;
   const scope = config.scope;
-  const client = getDeploymentClient(scope);
+  const client = getDeploymentClient(config, scope);
   const deployment = getDeployment(config, files);
 
   switch (scope.type) {
@@ -305,7 +307,7 @@ function getDeployment(
 async function stackCreate(config: DeploymentStackConfig, files: ParsedFiles) {
   const name = config.name ?? defaultName;
   const scope = config.scope;
-  const client = getStacksClient(scope);
+  const client = getStacksClient(config, scope);
   const stack = getStack(config, files);
 
   switch (scope.type) {
@@ -341,7 +343,7 @@ async function stackValidate(
 ) {
   const name = config.name ?? defaultName;
   const scope = config.scope;
-  const client = getStacksClient(scope);
+  const client = getStacksClient(config, scope);
   const stack = getStack(config, files);
 
   switch (scope.type) {
@@ -374,7 +376,7 @@ async function stackValidate(
 async function stackDelete(config: DeploymentStackConfig) {
   const name = config.name ?? defaultName;
   const scope = config.scope;
-  const client = getStacksClient(scope);
+  const client = getStacksClient(config, scope);
   const deletionOptions = getStackDeletionOptions(config);
 
   switch (scope.type) {

diff --git a/src/helpers/azure.ts b/src/helpers/azure.ts
@@ -6,10 +6,18 @@ import { DefaultAzureCredential } from "@azure/identity";
 import { AdditionalPolicyConfig } from "@azure/core-client";
 import { debug, isDebug } from "@actions/core";
 
+import { ActionConfig } from "../config";
+
 const userAgentPrefix = "gh-azure-bicep-deploy";
 const dummySubscriptionId = "00000000-0000-0000-0000-000000000000";
+const cloudEndpoints = {
+  azureChinaCloud: "https://management.chinacloudapi.cn",
+  azureGermanCloud: "https://management.microsoftazure.de",
+  azureUSGovernment: "https://management.usgovcloudapi.net",
+};
 
 export function createDeploymentClient(
+  config: ActionConfig,
   subscriptionId?: string,
   tenantId?: string,
 ): ResourceManagementClient {
@@ -26,11 +34,13 @@ export function createDeploymentClient(
       additionalPolicies: [debugLoggingPolicy],
       // Use a recent API version to take advantage of error improvements
       apiVersion: "2024-03-01",
+      endpoint: config.cloud ? cloudEndpoints[config.cloud] : undefined,
     },
   );
 }
 
 export function createStacksClient(
+  config: ActionConfig,
   subscriptionId?: string,
   tenantId?: string,
 ): DeploymentStacksClient {
@@ -45,6 +55,7 @@ export function createStacksClient(
         userAgentPrefix: userAgentPrefix,
       },
       additionalPolicies: [debugLoggingPolicy],
+      endpoint: config.cloud ? cloudEndpoints[config.cloud] : undefined,
     },
   );
 }