Azure Quantum: Update generated client and support for Cost Estimate upon job completion (Azure#26442)

* Update autorest.md with latest published swagger version

* Automation scripts

* Updated generated client

* Fix autorest.md to a commit

* Update generated client

* Update generated client and unit test recordings

* Update API and samples

Author: vxfield

sdk/quantum/Azure.Quantum.Jobs/.gitignore

@@ -0,0 +1 @@
+temp/

sdk/quantum/Azure.Quantum.Jobs/CHANGELOG.md

@@ -1,7 +1,9 @@
 # Release History
 
-## 1.0.0-beta.3 (Unreleased)
+## 1.0.0-beta.4 (Unreleased)
 
+## 1.0.0-beta.3 (2022-01-18)
+- When submitting a job to Azure Quantum, the resulting job details may include the cost estimate of the job (if supported by the provider). The final cost on your bill might be slightly different due to added taxes and currency conversion rates.
 
 ## 1.0.0-beta.2 (2021-03-30)
 - Fixed a bug where the client was unable to authenticate using Interactive or Service Principal credentials (issue #19588) 

sdk/quantum/Azure.Quantum.Jobs/api/Azure.Quantum.Jobs.netstandard2.0.cs

@@ -40,6 +40,13 @@ public BlobDetails(string containerName) { }
         public string BlobName { get { throw null; } set { } }
         public string ContainerName { get { throw null; } }
     }
+    public partial class CostEstimate
+    {
+        internal CostEstimate() { }
+        public string CurrencyCode { get { throw null; } }
+        public float? EstimatedTotal { get { throw null; } }
+        public System.Collections.Generic.IReadOnlyList<Azure.Quantum.Jobs.Models.UsageEvent> Events { get { throw null; } }
+    }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public readonly partial struct DimensionScope : System.IEquatable<Azure.Quantum.Jobs.Models.DimensionScope>
     {
@@ -70,6 +77,7 @@ public JobDetails(string containerUri, string inputDataFormat, string providerId
         public System.DateTimeOffset? BeginExecutionTime { get { throw null; } }
         public System.DateTimeOffset? CancellationTime { get { throw null; } }
         public string ContainerUri { get { throw null; } set { } }
+        public Azure.Quantum.Jobs.Models.CostEstimate CostEstimate { get { throw null; } }
         public System.DateTimeOffset? CreationTime { get { throw null; } }
         public System.DateTimeOffset? EndExecutionTime { get { throw null; } }
         public Azure.Quantum.Jobs.Models.ErrorData ErrorData { get { throw null; } }
@@ -83,6 +91,7 @@ public JobDetails(string containerUri, string inputDataFormat, string providerId
         public string OutputDataUri { get { throw null; } set { } }
         public string ProviderId { get { throw null; } set { } }
         public Azure.Quantum.Jobs.Models.JobStatus? Status { get { throw null; } }
+        public System.Collections.Generic.IList<string> Tags { get { throw null; } set { } }
         public string Target { get { throw null; } set { } }
     }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
@@ -106,6 +115,36 @@ public JobDetails(string containerUri, string inputDataFormat, string providerId
         public static bool operator !=(Azure.Quantum.Jobs.Models.JobStatus left, Azure.Quantum.Jobs.Models.JobStatus right) { throw null; }
         public override string ToString() { throw null; }
     }
+    public partial class JsonPatchDocument
+    {
+        public JsonPatchDocument(Azure.Quantum.Jobs.Models.JsonPatchOperation op, string path) { }
+        public string From { get { throw null; } set { } }
+        public Azure.Quantum.Jobs.Models.JsonPatchOperation Op { get { throw null; } }
+        public string Path { get { throw null; } }
+        public object Value { get { throw null; } set { } }
+    }
+    [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
+    public readonly partial struct JsonPatchOperation : System.IEquatable<Azure.Quantum.Jobs.Models.JsonPatchOperation>
+    {
+        private readonly object _dummy;
+        private readonly int _dummyPrimitive;
+        public JsonPatchOperation(string value) { throw null; }
+        public static Azure.Quantum.Jobs.Models.JsonPatchOperation Add { get { throw null; } }
+        public static Azure.Quantum.Jobs.Models.JsonPatchOperation Copy { get { throw null; } }
+        public static Azure.Quantum.Jobs.Models.JsonPatchOperation Move { get { throw null; } }
+        public static Azure.Quantum.Jobs.Models.JsonPatchOperation Remove { get { throw null; } }
+        public static Azure.Quantum.Jobs.Models.JsonPatchOperation Replace { get { throw null; } }
+        public static Azure.Quantum.Jobs.Models.JsonPatchOperation Test { get { throw null; } }
+        public bool Equals(Azure.Quantum.Jobs.Models.JsonPatchOperation other) { throw null; }
+        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
+        public override bool Equals(object obj) { throw null; }
+        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
+        public override int GetHashCode() { throw null; }
+        public static bool operator ==(Azure.Quantum.Jobs.Models.JsonPatchOperation left, Azure.Quantum.Jobs.Models.JsonPatchOperation right) { throw null; }
+        public static implicit operator Azure.Quantum.Jobs.Models.JsonPatchOperation (string value) { throw null; }
+        public static bool operator !=(Azure.Quantum.Jobs.Models.JsonPatchOperation left, Azure.Quantum.Jobs.Models.JsonPatchOperation right) { throw null; }
+        public override string ToString() { throw null; }
+    }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public readonly partial struct MeterPeriod : System.IEquatable<Azure.Quantum.Jobs.Models.MeterPeriod>
     {
@@ -161,14 +200,23 @@ internal QuantumJobQuota() { }
         public Azure.Quantum.Jobs.Models.DimensionScope? Scope { get { throw null; } }
         public float? Utilization { get { throw null; } }
     }
+    public partial class QuantumJobQuotaList
+    {
+        internal QuantumJobQuotaList() { }
+        public string NextLink { get { throw null; } }
+        public System.Collections.Generic.IReadOnlyList<Azure.Quantum.Jobs.Models.QuantumJobQuota> Value { get { throw null; } }
+    }
     public static partial class QuantumModelFactory
     {
+        public static Azure.Quantum.Jobs.Models.CostEstimate CostEstimate(string currencyCode = null, System.Collections.Generic.IEnumerable<Azure.Quantum.Jobs.Models.UsageEvent> events = null, float? estimatedTotal = default(float?)) { throw null; }
         public static Azure.Quantum.Jobs.Models.ErrorData ErrorData(string code = null, string message = null) { throw null; }
-        public static Azure.Quantum.Jobs.Models.JobDetails JobDetails(string id = null, string name = null, string containerUri = null, string inputDataUri = null, string inputDataFormat = null, object inputParams = null, string providerId = null, string target = null, System.Collections.Generic.IDictionary<string, string> metadata = null, string outputDataUri = null, string outputDataFormat = null, Azure.Quantum.Jobs.Models.JobStatus? status = default(Azure.Quantum.Jobs.Models.JobStatus?), System.DateTimeOffset? creationTime = default(System.DateTimeOffset?), System.DateTimeOffset? beginExecutionTime = default(System.DateTimeOffset?), System.DateTimeOffset? endExecutionTime = default(System.DateTimeOffset?), System.DateTimeOffset? cancellationTime = default(System.DateTimeOffset?), Azure.Quantum.Jobs.Models.ErrorData errorData = null) { throw null; }
+        public static Azure.Quantum.Jobs.Models.JobDetails JobDetails(string id = null, string name = null, string containerUri = null, string inputDataUri = null, string inputDataFormat = null, object inputParams = null, string providerId = null, string target = null, System.Collections.Generic.IDictionary<string, string> metadata = null, string outputDataUri = null, string outputDataFormat = null, Azure.Quantum.Jobs.Models.JobStatus? status = default(Azure.Quantum.Jobs.Models.JobStatus?), System.DateTimeOffset? creationTime = default(System.DateTimeOffset?), System.DateTimeOffset? beginExecutionTime = default(System.DateTimeOffset?), System.DateTimeOffset? endExecutionTime = default(System.DateTimeOffset?), System.DateTimeOffset? cancellationTime = default(System.DateTimeOffset?), Azure.Quantum.Jobs.Models.CostEstimate costEstimate = null, Azure.Quantum.Jobs.Models.ErrorData errorData = null, System.Collections.Generic.IEnumerable<string> tags = null) { throw null; }
         public static Azure.Quantum.Jobs.Models.ProviderStatus ProviderStatus(string id = null, Azure.Quantum.Jobs.Models.ProviderAvailability? currentAvailability = default(Azure.Quantum.Jobs.Models.ProviderAvailability?), System.Collections.Generic.IEnumerable<Azure.Quantum.Jobs.Models.TargetStatus> targets = null) { throw null; }
         public static Azure.Quantum.Jobs.Models.QuantumJobQuota QuantumJobQuota(string dimension = null, Azure.Quantum.Jobs.Models.DimensionScope? scope = default(Azure.Quantum.Jobs.Models.DimensionScope?), string providerId = null, float? utilization = default(float?), float? holds = default(float?), float? limit = default(float?), Azure.Quantum.Jobs.Models.MeterPeriod? period = default(Azure.Quantum.Jobs.Models.MeterPeriod?)) { throw null; }
+        public static Azure.Quantum.Jobs.Models.QuantumJobQuotaList QuantumJobQuotaList(System.Collections.Generic.IEnumerable<Azure.Quantum.Jobs.Models.QuantumJobQuota> value = null, string nextLink = null) { throw null; }
         public static Azure.Quantum.Jobs.Models.SasUriResponse SasUriResponse(string sasUri = null) { throw null; }
         public static Azure.Quantum.Jobs.Models.TargetStatus TargetStatus(string id = null, Azure.Quantum.Jobs.Models.TargetAvailability? currentAvailability = default(Azure.Quantum.Jobs.Models.TargetAvailability?), long? averageQueueTime = default(long?), string statusPage = null) { throw null; }
+        public static Azure.Quantum.Jobs.Models.UsageEvent UsageEvent(string dimensionId = null, string dimensionName = null, string measureUnit = null, float? amountBilled = default(float?), float? amountConsumed = default(float?), float? unitPrice = default(float?)) { throw null; }
     }
     public partial class SasUriResponse
     {
@@ -202,4 +250,14 @@ internal TargetStatus() { }
         public string Id { get { throw null; } }
         public string StatusPage { get { throw null; } }
     }
+    public partial class UsageEvent
+    {
+        internal UsageEvent() { }
+        public float? AmountBilled { get { throw null; } }
+        public float? AmountConsumed { get { throw null; } }
+        public string DimensionId { get { throw null; } }
+        public string DimensionName { get { throw null; } }
+        public string MeasureUnit { get { throw null; } }
+        public float? UnitPrice { get { throw null; } }
+    }
 }

sdk/quantum/Azure.Quantum.Jobs/eng/Before-Commit.ps1

@@ -0,0 +1,9 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+$ExportAPIScript = Join-Path $PSScriptRoot "../../../../eng/scripts/Export-API.ps1" 
+&$ExportAPIScript -ServiceDirectory "quantum" -SDKType  "client" | Write-Verbose
+
+$UpdateSnippetsScript = Join-Path $PSScriptRoot "../../../../eng/scripts/Update-Snippets.ps1" 
+&$UpdateSnippetsScript -ServiceDirectory "quantum" | Write-Verbose
+

sdk/quantum/Azure.Quantum.Jobs/eng/Checkout-Repo.ps1

@@ -0,0 +1,144 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+<#
+.SYNOPSIS
+Checkout a git repository
+.DESCRIPTION
+This script checkouts a git repository, for a specific branch/commit into a target folder.
+It optionally checkout only specific folders (using sparse checkout) to speed-up the checkout process.
+.PARAMETER RepoUrl
+The URL of the git repo
+.PARAMETER TargetFolder
+The path of the folder to checkout the git repo
+.PARAMETER BranchName
+The name of the branch to checkout (defaults to the HEAD branch)
+.PARAMETER CommitId
+The specific CommitId to checkout (defaults to the HEAD commit id)
+.PARAMETER PathAllowList
+An array of paths to be checkout (all other paths are not checkout)
+.PARAMETER Force
+Deletes the TargetFolder before doing the checkout if it already exists
+
+.EXAMPLE
+Checkout-Repo.ps1 -RepoUrl https://github.com/microsoft/qdk-python.git -TargetFolder ./qdk-python -Force
+
+# Checks-out the entire qdk-python repo
+
+.EXAMPLE
+Checkout-Repo.ps1 -RepoUrl https://github.com/microsoft/qdk-python.git -TargetFolder ./qdk-python -CommitId 8481428bd7eed9d68f960afa6af4ab34de1c75a2 -Force
+
+# Checks-out a specific commit of the qdk-python repo
+
+.EXAMPLE
+Checkout-Repo.ps1 -RepoUrl https://github.com/microsoft/qdk-python.git -TargetFolder ./qdk-python -BranchName release/v0.15.2102 -Force
+
+# Checks-out a specific branch of the qdk-python repo
+
+.EXAMPLE
+Checkout-Repo.ps1 -RepoUrl https://github.com/microsoft/qdk-python.git -TargetFolder ./qdk-python -PathAllowList /azure-quantum/,/build/ -Force
+
+# Checks-out specific folders of the qdk-python repo
+
+#>
+
+[CmdletBinding()]
+Param (
+    [ValidateNotNullOrEmpty()]
+    [Parameter(Mandatory=$True)]
+    [string] $RepoUrl,
+    [ValidateNotNullOrEmpty()]
+    [Parameter(Mandatory=$True)]
+    [string] $TargetFolder,
+    [string] $BranchName,
+    [string] $CommitId,
+    [string[]] $PathAllowList,
+    [switch] $Force
+)
+
+$TargetFolderExisted = Test-Path $TargetFolder
+if ($TargetFolderExisted)
+{
+    if ($Force)
+    {
+        Write-Verbose "Deleting existing folder: $TargetFolder"
+        Remove-Item $TargetFolder -Recurse -Force | Write-Verbose
+    }
+    else
+    {
+        Write-Verbose "Path already exists: $TargetFolder"
+        Write-Verbose "Skipping checkout for $RepoUrl"
+        exit 0
+    }
+}
+
+Write-Verbose "Creating folder: $TargetFolder"
+New-Item -ItemType "directory" -Path $TargetFolder -Force | Write-Verbose
+
+Push-Location $TargetFolder 
+try {
+    git init | Write-Verbose
+    if ($LASTEXITCODE -ne 0) { throw "Error initializing git repo" } 
+
+    if (@($PathAllowList).Count -gt 0)
+    {
+        git config core.sparsecheckout true | Write-Verbose
+        if ($LASTEXITCODE -ne 0) { throw "Error enabling git sparse checkout" } 
+
+        git sparse-checkout init --cone | Write-Verbose
+        if ($LASTEXITCODE -ne 0) { throw "Error initializing git sparse checkout" } 
+
+        Write-Verbose "Sparse checkout enabled for the following paths:"
+        foreach ($Path in $PathAllowList)
+        {
+            Write-Verbose "  $Path"
+            git sparse-checkout add $Path | Write-Verbose
+            if ($LASTEXITCODE -ne 0) { throw "Error adding git sparse checkout path: $Path" } 
+        }
+    }
+
+    Write-Verbose "Git remote URL: $RepoUrl"
+    git remote add origin $RepoUrl | Write-Verbose
+    if ($LASTEXITCODE -ne 0) { throw "Error adding git remote" } 
+
+    if (![string]::IsNullOrEmpty($CommitId))
+    {
+        Write-Verbose "Checking out specific commit: $CommitId"
+        git fetch --depth=1 origin $CommitId | Write-Verbose
+        if ($LASTEXITCODE -ne 0) { throw "Error running git fetch for commit $CommitId" } 
+        git checkout $CommitId | Write-Verbose
+        if ($LASTEXITCODE -ne 0) { throw "Error running git checkout for commit $CommitId" } 
+    }
+    elseif (![string]::IsNullOrEmpty($BranchName))
+    {
+        Write-Verbose "Checking out specific branch: $BranchName"
+        git fetch --depth=1 origin $BranchName | Write-Verbose
+        if ($LASTEXITCODE -ne 0) { throw "Error running git fetch for branch $BranchName" } 
+        git checkout $BranchName | Write-Verbose
+        if ($LASTEXITCODE -ne 0) { throw "Error running git fetch for branch $BranchName" } 
+    }
+    else
+    {
+        Write-Verbose "Checking out default branch"
+        git fetch --depth=1 origin | Write-Verbose
+        if ($LASTEXITCODE -ne 0) { throw "Error running git fetch for default branch" } 
+        git pull origin HEAD | Write-Verbose
+        if ($LASTEXITCODE -ne 0) { throw "Error running git pull for default branch" } 
+    }
+
+    exit 0
+}
+catch {
+    # Delete the target folder if it didn't existed before
+    # to avoid a partial checkout folder
+    if (!$TargetFolderExisted)
+    {
+        Write-Verbose "Cleaning up partial checkout folder: $TargetFolder"
+        Remove-Item $TargetFolder -Recurse -Force | Write-Verbose
+    }
+    throw
+}
+finally {
+    Pop-Location
+}
+

sdk/quantum/Azure.Quantum.Jobs/eng/Generate-Client.ps1

@@ -0,0 +1,54 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+$SwaggerTagVersion = "preview/2021-11-01-preview"
+
+$SpecsRepo = "https://github.com/Azure/azure-rest-api-specs.git"
+$SpecsBranch = "main"
+$SpecsCommitId = ""
+$PathAllowList = ("specification/quantum")
+
+$TempFolder = Join-Path $PSScriptRoot "../temp/"
+$SpecsFolder = Join-Path $TempFolder  "/specs/"
+
+# Check-out specs repo to get the latest swagger API Definition file
+$CheckoutScript = Join-Path $PSScriptRoot "./Checkout-Repo.ps1" 
+&$CheckoutScript -RepoUrl $SpecsRepo -TargetFolder $SpecsFolder -PathAllowList $PathAllowList -BranchName $SpecsBranch -CommitId $SpecsCommitId -Force | Write-Verbose
+
+$AutoRestConfig = Join-Path $PSScriptRoot "../src/autorest.md"
+
+# Make sure we have the latest AutoRest
+npm install -g autorest@latest | Write-Verbose
+
+# Delete the old generated client and copy the new one there
+$AzureQuantumClient_Folder =  Join-Path $PSScriptRoot "../src/Generated/"
+if (Test-Path $AzureQuantumClient_Folder) {
+    Remove-Item $AzureQuantumClient_Folder -Recurse | Write-Verbose
+}
+
+
+$NewAutorestConfig = @"
+# Generated code configuration
+
+Run ``dotnet build /t:GenerateCode`` to generate code.
+
+`````` yaml
+input-file:
+    `$(this-folder)../temp/specs/specification/quantum/data-plane/Microsoft.Quantum/$SwaggerTagVersion/quantum.json
+``````
+"@
+
+try
+{
+    Copy-Item $AutoRestConfig -Destination "$AutoRestConfig.bkp" -Force | Write-Verbose
+
+    Set-Content -Path $AutoRestConfig -Value $NewAutorestConfig | Write-Verbose
+
+    # Generate the client
+    dotnet build /t:GenerateCode /p:AutoRestAdditionalParameters="--verbose" | Write-Verbose
+}
+finally
+{
+    Copy-Item "$AutoRestConfig.bkp" -Destination $AutoRestConfig -Force | Write-Verbose
+    Remove-Item "$AutoRestConfig.bkp" -Force | Write-Verbose
+}

sdk/quantum/Azure.Quantum.Jobs/samples/Azure.Quantum.Jobs.Samples.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <Description>Azure Quantum Jobs library samples</Description>
     <AssemblyTitle>Azure Quantum Jobs Samples</AssemblyTitle>
-    <Version>1.0.0-beta.1</Version>
+    <Version>1.0.0-beta.3</Version>
     <PackageTags>Azure;Quantum;Quantum Jobs</PackageTags>
     <TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks>
     <OutputType>Exe</OutputType>