MetricAlertResource.tsp

import "@azure-tools/typespec-azure-core";
import "@azure-tools/typespec-azure-resource-manager";
import "@typespec/openapi";
import "@typespec/rest";
import "./models.tsp";

using TypeSpec.Rest;
using Azure.ResourceManager;
using TypeSpec.Http;
using TypeSpec.OpenAPI;
using Microsoft.Common;

namespace MetricAlertApi;
/**
 * The metric alert resource.
 */
model MetricAlertResource
  is Azure.ResourceManager.TrackedResource<MetricAlertProperties, false> {
  ...ResourceNameParameter<
    Resource = MetricAlertResource,
    KeyName = "ruleName",
    SegmentName = "metricAlerts",
    NamePattern = ""
  >;

  /**
   * The identity of the resource.
   */
  #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
  identity?: Identity;
}

alias MetricAlertResourcesOps = Azure.ResourceManager.Legacy.RoutedOperations<
  MetricAlertResourcesParentParameters,
  MetricAlertResourcesParameters,
  ResourceRoute = #{
    route: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Insights/metricAlerts/{ruleName}/status/{statusName}",
  }
>;

alias MetricAlertResourcesParentParameters = {
  ...ApiVersionParameter;
  ...SubscriptionIdParameter;
  ...ResourceGroupParameter;

  /**
   * The name of the rule.
   */
  @path
  @segment("metricAlerts")
  ruleName: string;
};

alias MetricAlertResourcesParameters = {
  /**
   * The name of the status.
   */
  @path
  @segment("status")
  statusName: string;
};

@armResourceOperations(#{ omitTags: true, allowStaticRoutes: true })
interface MetricAlertResources {
  /**
   * Retrieve an alert rule definition.
   */
  @tag("MetricAlerts")
  get is ArmResourceRead<MetricAlertResource, Error = MetricAlertErrorResponse>;

  /**
   * Create or update a metric alert definition.
   */
  @tag("MetricAlerts")
  createOrUpdate is ArmResourceCreateOrReplaceSync<
    MetricAlertResource,
    Error = MetricAlertErrorResponse
  >;

  /**
   * Update a metric alert definition.
   */
  @patch(#{ implicitOptionality: false })
  @tag("MetricAlerts")
  update is ArmCustomPatchSync<
    MetricAlertResource,
    PatchModel = MetricAlertResourcePatch,
    Error = MetricAlertErrorResponse
  >;

  /**
   * Delete an alert rule definition.
   */
  @tag("MetricAlerts")
  delete is ArmResourceDeleteSync<
    MetricAlertResource,
    Error = MetricAlertErrorResponse
  >;

  /**
   * Retrieve alert rule definitions in a resource group.
   */
  @tag("MetricAlerts")
  listByResourceGroup is ArmResourceListByParent<
    MetricAlertResource,
    Response = ArmResponse<MetricAlertResourceCollection>,
    Error = MetricAlertErrorResponse
  >;

  /**
   * Retrieve alert rule definitions in a subscription.
   */
  @tag("MetricAlerts")
  listBySubscription is ArmListBySubscription<
    MetricAlertResource,
    Response = ArmResponse<MetricAlertResourceCollection>,
    Error = MetricAlertErrorResponse
  >;

  /**
   * Retrieve an alert rule status.
   */
  @action("status")
  @tag("MetricAlertsStatus")
  @segment("")
  list is Azure.ResourceManager.Legacy.ArmListSinglePageByParent<
    MetricAlertResource,
    Response = ArmResponse<MetricAlertStatusCollection>,
    Parameters = {
      /**
       * The name of the rule.
       */
      @path
      @segment("metricAlerts")
      ruleName: string;
    },
    Error = MetricAlertErrorResponse
  >;

  /**
   * Retrieve an alert rule status.
   */
  @tag("MetricAlertsStatus")
  @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}/status/{statusName}")
  listByName is MetricAlertResourcesOps.ListSinglePage<
    MetricAlertResource,
    Response = ArmResponse<MetricAlertStatusCollection>,
    Parameters = {
      /**
       * The name of the status.
       */
      @path
      @segment("status")
      statusName: string;
    },
    OverrideErrorType = MetricAlertErrorResponse
  >;
}

@@doc(MetricAlertResource.name, "The name of the rule.");
@@doc(
  MetricAlertResource.properties,
  "The alert rule properties of the resource."
);
@@doc(
  MetricAlertResources.createOrUpdate::parameters.resource,
  "The parameters of the rule to create or update."
);
@@doc(
  MetricAlertResources.update::parameters.properties,
  "The parameters of the rule to update."
);