security-center/snippets/management_api/getEffectiveSecurityHealthAnalyticsCustomModule.js

// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
'use strict';

/**
 *  Retrieve an existing effective security health analytics custom module
 */
function main(organizationId, customModuleId, locationId = 'global') {
  // [START securitycenter_get_effective_security_health_analytics_custom_module]
  // npm install '@google-cloud/securitycentermanagement'
  const {
    SecurityCenterManagementClient,
  } = require('@google-cloud/securitycentermanagement');

  const client = new SecurityCenterManagementClient();

  /*
   * Required. Resource name of security health analytics module.
   *     Its format is
   *    `organizations/[organization_id]/locations/[location_id]/effectiveSecurityHealthAnalyticsCustomModules/[custom_module]`
   *    `folders/[folder_id]/locations/[location_id]/effectiveSecurityHealthAnalyticsCustomModules/[custom_module]`
   *    `projects/[project_id]/locations/[location_id]/effectiveSecurityHealthAnalyticsCustomModules/[custom_module]`
   */
  const name = `organizations/${organizationId}/locations/${locationId}/effectiveSecurityHealthAnalyticsCustomModules/${customModuleId}`;

  async function getEffectiveSecurityHealthAnalyticsCustomModule() {
    const [response] =
      await client.getEffectiveSecurityHealthAnalyticsCustomModule({
        name: name,
      });
    console.log(
      'Security Health Analytics Custom Module get effective succeeded: ',
      response
    );
  }

  getEffectiveSecurityHealthAnalyticsCustomModule();
  // [END securitycenter_get_effective_security_health_analytics_custom_module]
}

main(...process.argv.slice(2));