Watchlist.tsp

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

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

namespace Microsoft.SecurityInsights;
/**
 * Represents a Watchlist in Azure Security Insights.
 */
model Watchlist is Azure.ResourceManager.ProxyResource<WatchlistProperties> {
  ...ResourceNameParameter<
    Resource = Watchlist,
    KeyName = "watchlistAlias",
    SegmentName = "watchlists",
    NamePattern = ""
  >;

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

@armResourceOperations
interface Watchlists {
  /**
   * Get a watchlist, without its watchlist items.
   */
  get is Extension.Read<OperationalInsights, Watchlist, Error = CloudError>;

  /**
   * Create or update a Watchlist and its Watchlist Items (bulk creation, e.g. through text/csv content type). To create a Watchlist and its Items, we should call this endpoint with rawContent and contentType properties.
   */
  createOrUpdate is Extension.CreateOrReplaceAsync<
    OperationalInsights,
    Watchlist,
    LroHeaders = ArmAsyncOperationHeader<FinalResult = Watchlist>,
    Error = ErrorResponse
  >;

  /**
   * Delete a watchlist.
   */
  #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
  @Azure.Core.useFinalStateVia("azure-async-operation")
  delete is Extension.DeleteWithoutOkAsync<
    OperationalInsights,
    Watchlist,
    LroHeaders = ArmCombinedLroHeaders<FinalResult = Watchlist>,
    Error = ErrorResponse
  >;

  /**
   * Get all watchlists, without watchlist items.
   */
  list is Extension.ListByTarget<
    OperationalInsights,
    Watchlist,
    Parameters = {
      /**
       * Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional.
       */
      @query("$skipToken")
      $skipToken?: string;
    },
    Response = ArmResponse<WatchlistList>,
    Error = CloudError
  >;
}

@@doc(Watchlist.name, "The watchlist alias");
@@doc(Watchlist.properties, "Watchlist properties");
@@doc(Watchlists.createOrUpdate::parameters.resource, "The watchlist");