Migrate Storage from swagger to TypeSpec

specification/storage/Storage.Management/BlobContainer.tsp

@@ -0,0 +1,129 @@
+import "@azure-tools/typespec-azure-core";
+import "@azure-tools/typespec-azure-resource-manager";
+import "@typespec/openapi";
+import "@typespec/rest";
+import "./models.tsp";
+import "./BlobServiceProperties.tsp";
+
+using TypeSpec.Rest;
+using Azure.ResourceManager;
+using TypeSpec.Http;
+using TypeSpec.OpenAPI;
+
+namespace Microsoft.Storage;
+/**
+ * Properties of the blob container, including Id, resource name, resource type, Etag.
+ */
+@parentResource(BlobServiceProperties)
+model BlobContainer
+  is Azure.ResourceManager.ProxyResource<ContainerProperties> {
+  ...ResourceNameParameter<
+    Resource = BlobContainer,
+    KeyName = "containerName",
+    SegmentName = "containers",
+    NamePattern = ""
+  >;
+
+  /**
+   * Resource Etag.
+   */
+  #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
+  @visibility(Lifecycle.Read)
+  etag?: string;
+}
+
+@armResourceOperations
+interface BlobContainers {
+  /**
+   * Gets properties of a specified container.
+   */
+  get is ArmResourceRead<BlobContainer, Error = ErrorResponse>;
+
+  /**
+   * Creates a new container under the specified account as described by request body. The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container.
+   */
+  create is ArmResourceCreateOrReplaceSync<
+    BlobContainer,
+    Error = ErrorResponse
+  >;
+
+  /**
+   * Updates container properties as specified in request body. Properties not mentioned in the request will be unchanged. Update fails if the specified container doesn't already exist.
+   */
+  @patch(#{ implicitOptionality: false })
+  update is ArmCustomPatchSync<
+    BlobContainer,
+    PatchModel = BlobContainer,
+    Error = ErrorResponse
+  >;
+
+  /**
+   * Deletes specified container under its account.
+   */
+  delete is ArmResourceDeleteSync<BlobContainer, Error = ErrorResponse>;
+
+  /**
+   * Sets legal hold tags. Setting the same tag results in an idempotent operation. SetLegalHold follows an append pattern and does not clear out the existing tags that are not specified in the request.
+   */
+  setLegalHold is ArmResourceActionSync<
+    BlobContainer,
+    LegalHold,
+    ArmResponse<LegalHold>,
+    Error = ErrorResponse
+  >;
+
+  /**
+   * Clears legal hold tags. Clearing the same or non-existent tag results in an idempotent operation. ClearLegalHold clears out only the specified tags in the request.
+   */
+  clearLegalHold is ArmResourceActionSync<
+    BlobContainer,
+    LegalHold,
+    ArmResponse<LegalHold>,
+    Error = ErrorResponse
+  >;
+
+  /**
+   * The Lease Container operation establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.
+   */
+  lease is ArmResourceActionSync<
+    BlobContainer,
+    LeaseContainerRequest,
+    ArmResponse<LeaseContainerResponse>,
+    Error = ErrorResponse,
+    OptionalRequestBody = true
+  >;
+
+  /**
+   * This operation migrates a blob container from container level WORM to object level immutability enabled container. Prerequisites require a container level immutability policy either in locked or unlocked state, Account level versioning must be enabled and there should be no Legal hold on the container.
+   */
+  @action("migrate")
+  objectLevelWorm is ArmResourceActionAsync<
+    BlobContainer,
+    void,
+    {
+      @body body: void;
+    },
+    Error = CloudError,
+    LroHeaders = Azure.Core.Foundations.RetryAfterHeader &
+      ArmLroLocationHeader<FinalResult = void>
+  >;
+}
+
+@@maxLength(BlobContainer.name, 63);
+@@minLength(BlobContainer.name, 3);
+@@doc(BlobContainer.name,
+  "The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number."
+);
+@@doc(BlobContainer.properties, "Properties of the blob container.");
+@@doc(BlobContainers.create::parameters.resource,
+  "Properties of the blob container to create."
+);
+@@doc(BlobContainers.update::parameters.properties,
+  "Properties to update for the blob container."
+);
+@@doc(BlobContainers.setLegalHold::parameters.body,
+  "The LegalHold property that will be set to a blob container."
+);
+@@doc(BlobContainers.clearLegalHold::parameters.body,
+  "The LegalHold property that will be clear from a blob container."
+);

specification/storage/Storage.Management/BlobInventoryPolicy.tsp

@@ -0,0 +1,69 @@
+import "@azure-tools/typespec-azure-core";
+import "@azure-tools/typespec-azure-resource-manager";
+import "@typespec/openapi";
+import "@typespec/rest";
+import "./models.tsp";
+import "./StorageAccount.tsp";
+
+using TypeSpec.Rest;
+using Azure.ResourceManager;
+using TypeSpec.Http;
+using TypeSpec.OpenAPI;
+
+namespace Microsoft.Storage;
+/**
+ * The storage account blob inventory policy.
+ */
+@parentResource(StorageAccount)
+model BlobInventoryPolicy
+  is Azure.ResourceManager.ProxyResource<BlobInventoryPolicyProperties> {
+  ...ResourceNameParameter<
+    Resource = BlobInventoryPolicy,
+    KeyName = "blobInventoryPolicyName",
+    SegmentName = "inventoryPolicies",
+    NamePattern = "",
+    Type = BlobInventoryPolicyName
+  >;
+}
+
+@armResourceOperations
+interface BlobInventoryPolicies {
+  /**
+   * Gets the blob inventory policy associated with the specified storage account.
+   */
+  get is ArmResourceRead<BlobInventoryPolicy, Error = CloudError>;
+
+  /**
+   * Sets the blob inventory policy to the specified storage account.
+   */
+  #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
+  createOrUpdate is ArmResourceCreateOrReplaceSync<
+    BlobInventoryPolicy,
+    Response = ArmResourceUpdatedResponse<BlobInventoryPolicy>,
+    Error = CloudError
+  >;
+
+  /**
+   * Deletes the blob inventory policy associated with the specified storage account.
+   */
+  delete is ArmResourceDeleteSync<BlobInventoryPolicy, Error = CloudError>;
+
+  /**
+   * Gets the blob inventory policy associated with the specified storage account.
+   */
+  list is ArmResourceListByParent<
+    BlobInventoryPolicy,
+    Response = ArmResponse<ListBlobInventoryPolicy>,
+    Error = ErrorResponse
+  >;
+}
+
+@@doc(BlobInventoryPolicy.name,
+  "The name of the storage account blob inventory policy. It should always be 'default'"
+);
+@@doc(BlobInventoryPolicy.properties,
+  "Returns the storage account blob inventory policy rules."
+);
+@@doc(BlobInventoryPolicies.createOrUpdate::parameters.resource,
+  "The blob inventory policy set to a storage account."
+);

specification/storage/Storage.Management/BlobServiceProperties.tsp

@@ -0,0 +1,105 @@
+import "@azure-tools/typespec-azure-core";
+import "@azure-tools/typespec-azure-resource-manager";
+import "@typespec/openapi";
+import "@typespec/rest";
+import "./models.tsp";
+import "./StorageAccount.tsp";
+
+using TypeSpec.Rest;
+using Azure.ResourceManager;
+using TypeSpec.Http;
+using TypeSpec.OpenAPI;
+
+namespace Microsoft.Storage;
+/**
+ * The properties of a storage account’s Blob service.
+ */
+@singleton("default")
+@parentResource(StorageAccount)
+model BlobServiceProperties
+  is Azure.ResourceManager.ProxyResource<BlobServicePropertiesProperties> {
+  ...ResourceNameParameter<
+    Resource = BlobServiceProperties,
+    KeyName = "blobService",
+    SegmentName = "blobServices",
+    NamePattern = ""
+  >;
+
+  /**
+   * Sku name and tier.
+   */
+  #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
+  @visibility(Lifecycle.Read)
+  sku?: Sku;
+}
+
+#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
+@armResourceOperations
+interface BlobServices {
+  /**
+   * Gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
+   */
+  getServiceProperties is ArmResourceRead<
+    BlobServiceProperties,
+    Error = ErrorResponse
+  >;
+
+  /**
+   * Sets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
+   */
+  #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
+  setServiceProperties is ArmResourceCreateOrReplaceSync<
+    BlobServiceProperties,
+    Response = ArmResourceUpdatedResponse<BlobServiceProperties>,
+    Error = ErrorResponse
+  >;
+
+  /**
+   * List blob services of storage account. It returns a collection of one object named default.
+   */
+  list is ArmResourceListByParent<
+    BlobServiceProperties,
+    Response = ArmResponse<BlobServiceItems>,
+    Error = ErrorResponse
+  >;
+
+  /**
+   * Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.
+   */
+  @get
+  @list
+  @action("containers")
+  blobContainersList is ArmResourceActionSync<
+    BlobServiceProperties,
+    void,
+    ArmResponse<ListContainerItems>,
+    Parameters = {
+      /**
+       * Optional. Specified maximum number of containers that can be included in the list.
+       */
+      @query("$maxpagesize")
+      $maxpagesize?: string;
+
+      /**
+       * Optional. When specified, only container names starting with the filter will be listed.
+       */
+      @query("$filter")
+      $filter?: string;
+
+      /**
+       * Optional, used to include the properties for soft deleted blob containers.
+       */
+      @query("$include")
+      $include?: ListContainersInclude;
+    },
+    Error = ErrorResponse
+  >;
+}
+
+@@doc(BlobServiceProperties.name, "");
+@@doc(BlobServiceProperties.properties,
+  "The properties of a storage account’s Blob service."
+);
+@@doc(BlobServices.setServiceProperties::parameters.resource,
+  "The properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules."
+);

specification/storage/Storage.Management/DeletedAccount.tsp

@@ -0,0 +1,43 @@
+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;
+
+namespace Microsoft.Storage;
+/**
+ * Deleted storage account
+ */
+@subscriptionResource
+@parentResource(SubscriptionLocationResource)
+model DeletedAccount
+  is Azure.ResourceManager.ProxyResource<DeletedAccountProperties> {
+  ...ResourceNameParameter<
+    Resource = DeletedAccount,
+    KeyName = "deletedAccountName",
+    SegmentName = "deletedAccounts",
+    NamePattern = ""
+  >;
+}
+
+@armResourceOperations
+interface DeletedAccounts {
+  /**
+   * Get properties of specified deleted account resource.
+   */
+  get is ArmResourceRead<
+    DeletedAccount,
+    BaseParameters = Azure.ResourceManager.Foundations.SubscriptionBaseParameters,
+    Error = ErrorResponse
+  >;
+}
+
+@@maxLength(DeletedAccount.name, 24);
+@@minLength(DeletedAccount.name, 3);
+@@doc(DeletedAccount.name, "Name of the deleted storage account.");
+@@doc(DeletedAccount.properties, "Properties of the deleted account.");