Snapshot.tsp

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

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

namespace ComputeDisk;
/**
 * Snapshot resource.
 */
model Snapshot is Azure.ResourceManager.TrackedResource<SnapshotProperties> {
  ...ResourceNameParameter<
    Resource = Snapshot,
    KeyName = "snapshotName",
    SegmentName = "snapshots",
    NamePattern = "^[^_\\W][\\w-._]{0,79}(?<![-.])$"
  >;

  /**
   * Unused. Always Null.
   */
  #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property"
  @visibility(Lifecycle.Read)
  managedBy?: string;

  /**
   * The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
   */
  #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property"
  sku?: SnapshotSku;

  /**
   * The extended location where the snapshot will be created. Extended location cannot be changed.
   */
  #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property"
  extendedLocation?: ExtendedLocation;
}

@armResourceOperations
interface Snapshots {
  /**
   * Gets information about a snapshot.
   */
  get is ComputeResourceRead<Snapshot>;

  /**
   * Creates or updates a snapshot.
   */
  #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "For backward compatibility"
  #suppress "@azure-tools/typespec-azure-resource-manager/no-response-body" "For backward compatibility"
  createOrUpdate is ComputeResourceCreateOrReplaceAsync<
    Snapshot,
    Response =
      | ArmResourceUpdatedResponse<Snapshot>
      | (ArmAcceptedLroResponse<LroHeaders = ArmLroLocationHeader<FinalResult = Snapshot> &
          Azure.Core.Foundations.RetryAfterHeader> & {
          @bodyRoot _: Snapshot;
        })
  >;

  /**
   * Updates (patches) a snapshot.
   */
  #suppress "@azure-tools/typespec-azure-resource-manager/no-response-body" "For backward compatibility"
  @patch(#{ implicitOptionality: false })
  update is ComputeCustomPatchAsync<
    Snapshot,
    SnapshotUpdate,
    Response =
      | ArmResourceUpdatedResponse<Snapshot>
      | (ArmAcceptedLroResponse<LroHeaders = ArmLroLocationHeader<FinalResult = Snapshot> &
          Azure.Core.Foundations.RetryAfterHeader> & {
          @bodyRoot _: Snapshot;
        })
  >;

  /**
   * Deletes a snapshot.
   */
  #suppress "deprecated" "For backward compatibility"
  #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "For backward compatibility"
  #suppress "@azure-tools/typespec-azure-core/no-response-body" "For backward compatibility"
  delete is ComputeResourceDeleteAsync<Snapshot>;

  /**
   * Lists snapshots under a resource group.
   */
  listByResourceGroup is ComputeResourceListByParent<
    Snapshot,
    Response = SnapshotList
  >;

  /**
   * Lists snapshots under a subscription.
   */
  list is ComputeListBySubscription<Snapshot, Response = SnapshotList>;

  /**
   * Grants access to a snapshot.
   */
  @action("beginGetAccess")
  grantAccess is ComputeResourceActionAsync<
    Snapshot,
    GrantAccessData,
    AccessUri
  >;

  /**
   * Revokes access to a snapshot.
   */
  @action("endGetAccess")
  revokeAccess is ComputeResourceActionAsync<
    Snapshot,
    void,
    OkResponse,
    LroHeaders = ArmLroLocationHeader & Azure.Core.Foundations.RetryAfterHeader
  >;

  /**
   * Updates the immutability policy of a snapshot. Sets or extends an unlocked immutability policy with the specified duration and type. If the snapshot already has a locked policy, the request will be rejected. Use updateImmutabilityPolicyLock to lock an immutability policy.
   */
  @added(Versions.v2026_03_02)
  @action("updateImmutabilityPolicy")
  updateImmutabilityPolicy is ComputeResourceActionAsync<
    Snapshot,
    ImmutabilityPolicyData,
    Snapshot,
    LroHeaders = ArmAsyncOperationHeader<FinalResult = Snapshot> &
      ArmLroLocationHeader<FinalResult = Snapshot> &
      Azure.Core.Foundations.RetryAfterHeader
  >;

  /**
   * Locks the immutability policy of a snapshot. Once locked, the policy cannot be reduced or removed until the lock period expires.
   */
  @added(Versions.v2026_03_02)
  @action("updateImmutabilityPolicyLock")
  updateImmutabilityPolicyLock is ComputeResourceActionAsync<
    Snapshot,
    ImmutabilityPolicyLockData,
    Snapshot,
    LroHeaders = ArmAsyncOperationHeader<FinalResult = Snapshot> &
      ArmLroLocationHeader<FinalResult = Snapshot> &
      Azure.Core.Foundations.RetryAfterHeader
  >;
}

@@doc(
  Snapshot.name,
  "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, underscore (_), hyphen (-), and dot (.). The max name length is 80 characters."
);
@@doc(Snapshot.properties, "Snapshot resource properties.");
@@doc(
  Snapshots.createOrUpdate::parameters.resource,
  "Snapshot object supplied in the body of the Put disk operation."
);
@@doc(
  Snapshots.update::parameters.properties,
  "Snapshot object supplied in the body of the Patch snapshot operation."
);
@@doc(
  Snapshots.grantAccess::parameters.body,
  "Access data object supplied in the body of the get snapshot access operation."
);
@@doc(
  Snapshots.updateImmutabilityPolicy::parameters.body,
  "Immutability policy data supplied in the body of the update immutability policy operation."
);
@@doc(
  Snapshots.updateImmutabilityPolicyLock::parameters.body,
  "Immutability policy data supplied in the body of the update immutability policy lock operation."
);