[TSP Migration]--deviceprovisioningservices

specification/deviceprovisioningservices/Deviceprovisioningservices.Management/CertificateResponse.tsp

@@ -0,0 +1,323 @@
+import "@azure-tools/typespec-azure-core";
+import "@azure-tools/typespec-azure-resource-manager";
+import "@typespec/openapi";
+import "@typespec/rest";
+import "./models.tsp";
+import "./ProvisioningServiceDescription.tsp";
+
+using TypeSpec.Rest;
+using Azure.ResourceManager;
+using TypeSpec.Http;
+using TypeSpec.OpenAPI;
+
+namespace Microsoft.Devices;
+/**
+ * The X509 Certificate.
+ */
+@parentResource(ProvisioningServiceDescription)
+model CertificateResponse
+  is Azure.ResourceManager.ProxyResource<CertificateProperties> {
+  ...ResourceNameParameter<
+    Resource = CertificateResponse,
+    KeyName = "certificateName",
+    SegmentName = "certificates",
+    NamePattern = ""
+  >;
+
+  /**
+   * The entity tag.
+   */
+  #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "For backward compatibility"
+  @visibility(Lifecycle.Read)
+  etag?: string;
+}
+
+@armResourceOperations
+interface CertificateResponses {
+  /**
+   * Get the certificate from the provisioning service.
+   */
+  #suppress "@azure-tools/typespec-azure-core/no-openapi" "non-standard operations"
+  @operationId("DpsCertificate_Get")
+  get is ArmResourceRead<
+    CertificateResponse,
+    Parameters = {
+      /**
+       * ETag of the certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @header("If-Match")
+      `If-Match`?: string;
+    },
+    Error = ErrorDetails
+  >;
+
+  /**
+   * Add new certificate or update an existing certificate.
+   */
+  #suppress "@azure-tools/typespec-azure-core/no-openapi" "non-standard operations"
+  #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "For backward compatibility"
+  @operationId("DpsCertificate_CreateOrUpdate")
+  createOrUpdate is ArmResourceCreateOrReplaceSync<
+    CertificateResponse,
+    Parameters = {
+      /**
+       * ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @header("If-Match")
+      `If-Match`?: string;
+    },
+    Response = ArmResourceUpdatedResponse<CertificateResponse>,
+    Error = ErrorDetails
+  >;
+
+  /**
+   * Deletes the specified certificate associated with the Provisioning Service
+   */
+  #suppress "@azure-tools/typespec-azure-core/no-openapi" "non-standard operations"
+  @operationId("DpsCertificate_Delete")
+  delete is ArmResourceDeleteSync<
+    CertificateResponse,
+    Parameters = {
+      /**
+       * ETag of the certificate
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @header("If-Match")
+      `If-Match`: string;
+
+      /**
+       * This is optional, and it is the Common Name of the certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.name")
+      `certificate.name`?: string;
+
+      /**
+       * Raw data within the certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.rawBytes")
+      `certificate.rawBytes`?: bytes;
+
+      /**
+       * Indicates if certificate has been verified by owner of the private key.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.isVerified")
+      `certificate.isVerified`?: boolean;
+
+      /**
+       * A description that mentions the purpose of the certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.purpose")
+      `certificate.purpose`?: CertificatePurpose;
+
+      /**
+       * Time the certificate is created.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.created")
+      `certificate.created`?: utcDateTime;
+
+      /**
+       * Time the certificate is last updated.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.lastUpdated")
+      `certificate.lastUpdated`?: utcDateTime;
+
+      /**
+       * Indicates if the certificate contains a private key.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.hasPrivateKey")
+      `certificate.hasPrivateKey`?: boolean;
+
+      /**
+       * Random number generated to indicate Proof of Possession.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.nonce")
+      `certificate.nonce`?: string;
+    },
+    Error = ErrorDetails
+  >;
+
+  /**
+   * Get all the certificates tied to the provisioning service.
+   */
+  #suppress "@azure-tools/typespec-azure-core/no-openapi" "non-standard operations"
+  @operationId("DpsCertificate_List")
+  list is ArmResourceListByParent<
+    CertificateResponse,
+    Response = ArmResponse<CertificateListDescription>,
+    Error = ErrorDetails
+  >;
+
+  /**
+   * Generate verification code for Proof of Possession.
+   */
+  #suppress "@azure-tools/typespec-azure-core/no-openapi" "non-standard operations"
+  @operationId("DpsCertificate_GenerateVerificationCode")
+  generateVerificationCode is ArmResourceActionSync<
+    CertificateResponse,
+    void,
+    ArmResponse<VerificationCodeResponse>,
+    Parameters = {
+      /**
+       * ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @header("If-Match")
+      `If-Match`: string;
+
+      /**
+       * Common Name for the certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.name")
+      `certificate.name`?: string;
+
+      /**
+       * Raw data of certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.rawBytes")
+      `certificate.rawBytes`?: bytes;
+
+      /**
+       * Indicates if the certificate has been verified by owner of the private key.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.isVerified")
+      `certificate.isVerified`?: boolean;
+
+      /**
+       * Description mentioning the purpose of the certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.purpose")
+      `certificate.purpose`?: CertificatePurpose;
+
+      /**
+       * Certificate creation time.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.created")
+      `certificate.created`?: utcDateTime;
+
+      /**
+       * Certificate last updated time.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.lastUpdated")
+      `certificate.lastUpdated`?: utcDateTime;
+
+      /**
+       * Indicates if the certificate contains private key.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.hasPrivateKey")
+      `certificate.hasPrivateKey`?: boolean;
+
+      /**
+       * Random number generated to indicate Proof of Possession.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.nonce")
+      `certificate.nonce`?: string;
+    },
+    Error = ErrorDetails
+  >;
+
+  /**
+   * Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
+   */
+  #suppress "@azure-tools/typespec-azure-core/no-openapi" "non-standard operations"
+  @action("verify")
+  @operationId("DpsCertificate_VerifyCertificate")
+  verifyCertificate is ArmResourceActionSync<
+    CertificateResponse,
+    VerificationCodeRequest,
+    ArmResponse<CertificateResponse>,
+    Parameters = {
+      /**
+       * ETag of the certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @header("If-Match")
+      `If-Match`: string;
+
+      /**
+       * Common Name for the certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.name")
+      `certificate.name`?: string;
+
+      /**
+       * Raw data of certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.rawBytes")
+      `certificate.rawBytes`?: bytes;
+
+      /**
+       * Indicates if the certificate has been verified by owner of the private key.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.isVerified")
+      `certificate.isVerified`?: boolean;
+
+      /**
+       * Describe the purpose of the certificate.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.purpose")
+      `certificate.purpose`?: CertificatePurpose;
+
+      /**
+       * Certificate creation time.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.created")
+      `certificate.created`?: utcDateTime;
+
+      /**
+       * Certificate last updated time.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.lastUpdated")
+      `certificate.lastUpdated`?: utcDateTime;
+
+      /**
+       * Indicates if the certificate contains private key.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.hasPrivateKey")
+      `certificate.hasPrivateKey`?: boolean;
+
+      /**
+       * Random number generated to indicate Proof of Possession.
+       */
+      #suppress "@azure-tools/typespec-azure-core/casing-style" ""
+      @query("certificate.nonce")
+      `certificate.nonce`?: string;
+    },
+    Error = ErrorDetails
+  >;
+}
+
+@@doc(CertificateResponse.name, "Name of the certificate to retrieve.");
+@@doc(CertificateResponse.properties, "properties of a certificate");
+@@doc(CertificateResponses.createOrUpdate::parameters.resource,
+  "The certificate body."
+);
+@@doc(CertificateResponses.verifyCertificate::parameters.body,
+  "The name of the certificate"
+);
+@@maxLength(CertificateResponse.name, 256);

specification/deviceprovisioningservices/Deviceprovisioningservices.Management/GroupIdInformation.tsp

@@ -0,0 +1,54 @@
+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.Devices;
+/**
+ * The group information for creating a private endpoint on a provisioning service
+ */
+@parentResource(ProvisioningServiceDescription)
+model GroupIdInformation
+  is Azure.ResourceManager.ProxyResource<GroupIdInformationProperties, false> {
+  ...ResourceNameParameter<
+    Resource = GroupIdInformation,
+    KeyName = "groupId",
+    SegmentName = "privateLinkResources",
+    NamePattern = ""
+  >;
+}
+
+@armResourceOperations
+interface GroupIdInformations {
+  /**
+   * Get the specified private link resource for the given provisioning service
+   */
+  #suppress "@azure-tools/typespec-azure-core/no-openapi" "non-standard operations"
+  @operationId("IotDpsResource_GetPrivateLinkResources")
+  getPrivateLinkResources is ArmResourceRead<
+    GroupIdInformation,
+    Error = ErrorDetails
+  >;
+
+  /**
+   * List private link resources for the given provisioning service
+   */
+  #suppress "@azure-tools/typespec-azure-core/no-openapi" "non-standard operations"
+  @operationId("IotDpsResource_ListPrivateLinkResources")
+  listPrivateLinkResources is ArmResourceListByParent<
+    GroupIdInformation,
+    Response = ArmResponse<PrivateLinkResources>,
+    Error = ErrorDetails
+  >;
+}
+
+@@doc(GroupIdInformation.name, "The name of the private link resource");
+@@doc(GroupIdInformation.properties,
+  "The properties for a group information object"
+);