diff --git a/.github/actions/setup-node-npm-ci/action.yaml b/.github/actions/setup-node-npm-ci/action.yaml index f8e212657351..19aa6afca347 100644 --- a/.github/actions/setup-node-npm-ci/action.yaml +++ b/.github/actions/setup-node-npm-ci/action.yaml @@ -1,4 +1,4 @@ -name: Setup Node 20 and run `npm ci` +name: Setup Node and run `npm ci` description: Uses specified Node version and runs npm commands to set up the environment for REST API CI inputs: diff --git a/.github/workflows/_reusable-eng-tools-test.yaml b/.github/workflows/_reusable-eng-tools-test.yaml index d568b029d71f..71125c4724bb 100644 --- a/.github/workflows/_reusable-eng-tools-test.yaml +++ b/.github/workflows/_reusable-eng-tools-test.yaml @@ -42,21 +42,15 @@ jobs: - uses: actions/checkout@v4 with: sparse-checkout: | + .github eng ${{ inputs.sparse-checkout-paths }} - - name: Use Node ${{ matrix.node-version }}.x - uses: actions/setup-node@v4 + - name: Setup Node ${{ matrix.node-version }} and run `npm ci` + uses: ./.github/actions/setup-node-npm-ci with: node-version: ${{ matrix.node-version }}.x - - run: npm ci - shell: pwsh - - - run: npm ls -a - shell: pwsh - continue-on-error: true - - run: npm run build shell: pwsh working-directory: ./eng/tools/${{ inputs.package }} diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index 1499df886693..f7a96354f732 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -4,7 +4,7 @@ on: pull_request env: # Users allowed to edit protected files without failing check - user-allowed: ${{ github.event.pull_request.user.login == 'azure-sdk' || github.event.pull_request.user.login == 'dependabot[bot]' }} + user-allowed: ${{ github.event.pull_request.user.login == 'azure-sdk' }} jobs: protected-files: diff --git a/.github/workflows/suppressions-test.yaml b/.github/workflows/suppressions-test.yaml index 4ed27ae6e713..eaff138a71d0 100644 --- a/.github/workflows/suppressions-test.yaml +++ b/.github/workflows/suppressions-test.yaml @@ -15,6 +15,7 @@ on: - eng/tools/package.json - eng/tools/tsconfig.json - eng/tools/suppressions/** + workflow_dispatch: jobs: suppressions: diff --git a/.github/workflows/tsp-client-test.yaml b/.github/workflows/tsp-client-test.yaml index a94a15d05598..15bf1c137367 100644 --- a/.github/workflows/tsp-client-test.yaml +++ b/.github/workflows/tsp-client-test.yaml @@ -19,6 +19,7 @@ on: - specification/common-types - specification/keyvault - specification/sphere + workflow_dispatch: jobs: tsp-client: diff --git a/.github/workflows/typespec-requirement-test.yaml b/.github/workflows/typespec-requirement-test.yaml index e90bc29c34b2..d65a92f13808 100644 --- a/.github/workflows/typespec-requirement-test.yaml +++ b/.github/workflows/typespec-requirement-test.yaml @@ -15,6 +15,7 @@ on: - eng/tools/package.json - eng/tools/tsconfig.json - eng/tools/typespec-requirement/** + workflow_dispatch: jobs: typespec-requirement: diff --git a/.github/workflows/typespec-requirement.yaml b/.github/workflows/typespec-requirement.yaml index 974f25354533..3f3b4c9831b6 100644 --- a/.github/workflows/typespec-requirement.yaml +++ b/.github/workflows/typespec-requirement.yaml @@ -18,15 +18,8 @@ jobs: # Required since "HEAD^" is passed to TypeSpec-Requirement.ps1 fetch-depth: 2 - - name: Use Node 20.0 - uses: actions/setup-node@v4 - with: - node-version: 20.0 - - - run: npm ci - - - run: npm ls -a - continue-on-error: true + - name: Setup Node and run `npm ci` + uses: ./.github/actions/setup-node-npm-ci - run: | eng/scripts/TypeSpec-Requirement.ps1 ` diff --git a/.github/workflows/typespec-validation-all.yaml b/.github/workflows/typespec-validation-all.yaml index 10047a488c9f..c342e1bbd004 100644 --- a/.github/workflows/typespec-validation-all.yaml +++ b/.github/workflows/typespec-validation-all.yaml @@ -34,21 +34,26 @@ on: jobs: typespec-validation-all: - name: TypeSpec Validation All + # Use short name to maximize space for parameters in UI + name: TSV + strategy: + # Validate all specs, even if one job fails early fail-fast: false + # Sort matrix elements from "most important" to "least important" for the best grouping and UI + # Keep matrix values short, to maximize number of parameters shown in UI matrix: - os: [ubuntu-latest, windows-latest] + # When triggered by schedule, validate both the default branch and typespec-next + # Use the placeholder string "default" instead of passing "" directly, since the latter gets ignored by + # the GitHub Jobs UI. + ref: ${{ fromJSON(github.event_name == 'schedule' && '["default", "next"]' || '["default"]') }} + os: [ubuntu, windows] # shards must start at 0 and increment by 1 shard: [0, 1, 2] # total-shards must be an accurate count of the number of shards total-shards: [3] - # When triggered by schedule, validate both the default branch and typespec-next - # Use the placeholder string "default" instead of passing "" directly, since the latter gets ignored by - # the GitHub Jobs UI. - ref: ${{ fromJSON(github.event_name == 'schedule' && '["default", "typespec-next"]' || '["default"]') }} - runs-on: ${{ matrix.os }} + runs-on: ${{ matrix.os }}-latest steps: - name: Enable git long paths @@ -58,9 +63,9 @@ jobs: - uses: actions/checkout@v4 with: # Convert placeholder string 'default' to '', which tells the action to checkout the default ref. - ref: ${{ matrix.ref != 'default' && matrix.ref || '' }} + ref: ${{ matrix.ref == 'next' && 'typespec-next' || '' }} - - name: Setup Node 20 and run `npm ci` + - name: Setup Node and run `npm ci` uses: ./.github/actions/setup-node-npm-ci - name: Validate All Specs diff --git a/.github/workflows/typespec-validation-test.yaml b/.github/workflows/typespec-validation-test.yaml index 11475e120da5..5387ed97b074 100644 --- a/.github/workflows/typespec-validation-test.yaml +++ b/.github/workflows/typespec-validation-test.yaml @@ -16,6 +16,7 @@ on: - eng/tools/tsconfig.json - eng/tools/suppressions/** - eng/tools/typespec-validation/** + workflow_dispatch: jobs: typespec-validation: diff --git a/.github/workflows/typespec-validation.yaml b/.github/workflows/typespec-validation.yaml index cf3a646264ec..1029b85ae247 100644 --- a/.github/workflows/typespec-validation.yaml +++ b/.github/workflows/typespec-validation.yaml @@ -12,7 +12,7 @@ jobs: with: fetch-depth: 2 - - name: Setup Node 20 and run `npm ci` + - name: Setup Node and run `npm ci` uses: ./.github/actions/setup-node-npm-ci - name: Validate Impacted Specs diff --git a/cSpell.json b/cSpell.json index 16d595e98b6c..db2ccb50850f 100644 --- a/cSpell.json +++ b/cSpell.json @@ -223,7 +223,8 @@ "PDBs", "undrainable", "Undrainable", - "acnstls" + "acnstls", + "kubeletIdentity" ] }, { @@ -1690,6 +1691,12 @@ "words": [ "SEVSNP" ] + }, + { + "filename": "**/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/**/*.json", + "words": [ + "Eflow" + ] } ], "enableFiletypes": [ diff --git a/documentation/samplefiles/readme.java.md b/documentation/samplefiles/readme.java.md index 01cdabebe9ad..1abdd25dc681 100644 --- a/documentation/samplefiles/readme.java.md +++ b/documentation/samplefiles/readme.java.md @@ -4,4 +4,5 @@ These settings apply only when `--java` is specified on the command line. ``` yaml $(java) client-flattened-annotation-target: disabled +uuid-as-string: true ``` diff --git a/eng/common/pipelines/templates/jobs/generate-job-matrix.yml b/eng/common/pipelines/templates/jobs/generate-job-matrix.yml index a7459e6b5db5..ab67e915de85 100644 --- a/eng/common/pipelines/templates/jobs/generate-job-matrix.yml +++ b/eng/common/pipelines/templates/jobs/generate-job-matrix.yml @@ -42,6 +42,12 @@ parameters: - name: PreGenerationSteps type: stepList default: [] +- name: EnablePRGeneration + type: boolean + default: false +- name: PRMatrixSetting + type: string + default: 'ArtifactPackageNames' # Mappings to OS name required at template compile time by 1es pipeline templates - name: Pools type: object @@ -84,57 +90,87 @@ jobs: - ${{ parameters.PreGenerationSteps }} - - ${{ each config in parameters.MatrixConfigs }}: + - ${{ if eq(parameters.EnablePRGeneration, false) }}: + - ${{ each config in parameters.MatrixConfigs }}: + - ${{ each pool in parameters.Pools }}: + - ${{ if eq(config.GenerateVMJobs, 'true') }}: + - task: Powershell@2 + inputs: + pwsh: true + filePath: eng/common/scripts/job-matrix/Create-JobMatrix.ps1 + arguments: > + -ConfigPath ${{ config.Path }} + -Selection ${{ config.Selection }} + -DisplayNameFilter '$(displayNameFilter)' + -Filters '${{ join(''',''', parameters.MatrixFilters) }}', 'container=^$', 'SupportedClouds=^$|${{ parameters.CloudConfig.Cloud }}', 'Pool=${{ pool.filter }}' + -Replace '${{ join(''',''', parameters.MatrixReplace) }}' + -NonSparseParameters '${{ join(''',''', config.NonSparseParameters) }}' + displayName: Create ${{ pool.name }} Matrix ${{ config.Name }} + name: vm_job_matrix_${{ config.Name }}_${{ pool.name }} + - ${{ if eq(config.GenerateContainerJobs, 'true') }}: + - task: Powershell@2 + inputs: + pwsh: true + filePath: eng/common/scripts/job-matrix/Create-JobMatrix.ps1 + arguments: > + -ConfigPath ${{ config.Path }} + -Selection ${{ config.Selection }} + -DisplayNameFilter '$(displayNameFilter)' + -Filters '${{ join(''',''', parameters.MatrixFilters) }}', 'container=^$', 'SupportedClouds=^$|${{ parameters.CloudConfig.Cloud }}', 'Pool=${{ pool.filter }}' + -NonSparseParameters '${{ join(''',''', config.NonSparseParameters) }}' + displayName: Create ${{ pool.name }} Container Matrix ${{ config.Name }} + name: container_job_matrix_${{ config.Name }}_${{ pool.name }} + + # This else being set also currently assumes that the $(Build.ArtifactStagingDirectory)/PackageInfo folder is populated by PreGenerationSteps. + # Not currently not hardcoded, so not doing the needful and populating this folder before we hit this step will result in generation errors. + - ${{ else }}: - ${{ each pool in parameters.Pools }}: - - ${{ if eq(config.GenerateVMJobs, 'true') }}: - - task: Powershell@2 - inputs: - pwsh: true - filePath: eng/common/scripts/job-matrix/Create-JobMatrix.ps1 - arguments: > - -ConfigPath ${{ config.Path }} - -Selection ${{ config.Selection }} - -DisplayNameFilter '$(displayNameFilter)' - -Filters '${{ join(''',''', parameters.MatrixFilters) }}', 'container=^$', 'SupportedClouds=^$|${{ parameters.CloudConfig.Cloud }}', 'Pool=${{ pool.filter }}' - -Replace '${{ join(''',''', parameters.MatrixReplace) }}' - -NonSparseParameters '${{ join(''',''', config.NonSparseParameters) }}' - displayName: Create ${{ pool.name }} Matrix ${{ config.Name }} - name: vm_job_matrix_${{ config.Name }}_${{ pool.name }} + - pwsh: | + # dump the conglomerated CI matrix + '${{ convertToJson(parameters.MatrixConfigs) }}' | Set-Content matrix.json - - ${{ if eq(config.GenerateContainerJobs, 'true') }}: - - task: Powershell@2 - inputs: - pwsh: true - filePath: eng/common/scripts/job-matrix/Create-JobMatrix.ps1 - arguments: > - -ConfigPath ${{ config.Path }} - -Selection ${{ config.Selection }} - -DisplayNameFilter '$(displayNameFilter)' - -Filters '${{ join(''',''', parameters.MatrixFilters) }}', 'container=^$', 'SupportedClouds=^$|${{ parameters.CloudConfig.Cloud }}', 'Pool=${{ pool.filter }}' - -NonSparseParameters '${{ join(''',''', config.NonSparseParameters) }}' - displayName: Create ${{ pool.name }} Container Matrix ${{ config.Name }} - name: container_job_matrix_${{ config.Name }}_${{ pool.name }} + ./eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1 ` + -PackagePropertiesFolder $(Build.ArtifactStagingDirectory)/PackageInfo ` + -PRMatrixFile matrix.json ` + -PRMatrixSetting ${{ parameters.PRMatrixSetting }} ` + -DisplayNameFilter '$(displayNameFilter)' ` + -Filters '${{ join(''',''', parameters.MatrixFilters) }}', 'container=^$', 'SupportedClouds=^$|${{ parameters.CloudConfig.Cloud }}', 'Pool=${{ pool.filter }}' ` + -Replace '${{ join(''',''', parameters.MatrixReplace) }}' + displayName: Create ${{ pool.name }} PR Matrix + name: vm_job_matrix_pr_${{ pool.name }} -- ${{ each config in parameters.MatrixConfigs }}: - - ${{ each pool in parameters.Pools }}: - - ${{ if eq(config.GenerateVMJobs, 'true') }}: - - template: ${{ parameters.JobTemplatePath }} - parameters: - UsePlatformContainer: false - OSName: ${{ pool.os }} - Matrix: dependencies.${{ parameters.GenerateJobName }}.outputs['vm_job_matrix_${{ config.Name }}_${{ pool.name }}.matrix'] - DependsOn: ${{ parameters.GenerateJobName }} - CloudConfig: ${{ parameters.CloudConfig }} - ${{ each param in parameters.AdditionalParameters }}: - ${{ param.key }}: ${{ param.value }} +- ${{ if eq(parameters.EnablePRGeneration, false) }}: + - ${{ each config in parameters.MatrixConfigs }}: + - ${{ each pool in parameters.Pools }}: + - ${{ if eq(config.GenerateVMJobs, 'true') }}: + - template: ${{ parameters.JobTemplatePath }} + parameters: + UsePlatformContainer: false + OSName: ${{ pool.os }} + Matrix: dependencies.${{ parameters.GenerateJobName }}.outputs['vm_job_matrix_${{ config.Name }}_${{ pool.name }}.matrix'] + DependsOn: ${{ parameters.GenerateJobName }} + CloudConfig: ${{ parameters.CloudConfig }} + ${{ each param in parameters.AdditionalParameters }}: + ${{ param.key }}: ${{ param.value }} - - ${{ if eq(config.GenerateContainerJobs, 'true') }}: - - template: ${{ parameters.JobTemplatePath }} - parameters: - UsePlatformContainer: true - OSName: ${{ pool.os }} - Matrix: dependencies.${{ parameters.GenerateJobName }}.outputs['vm_job_matrix_${{ config.Name }}_${{ pool.name }}.matrix'] - DependsOn: ${{ parameters.GenerateJobName }} - CloudConfig: ${{ parameters.CloudConfig }} - ${{ each param in parameters.AdditionalParameters }}: - ${{ param.key }}: ${{ param.value }} + - ${{ if eq(config.GenerateContainerJobs, 'true') }}: + - template: ${{ parameters.JobTemplatePath }} + parameters: + UsePlatformContainer: true + OSName: ${{ pool.os }} + Matrix: dependencies.${{ parameters.GenerateJobName }}.outputs['vm_job_matrix_${{ config.Name }}_${{ pool.name }}.matrix'] + DependsOn: ${{ parameters.GenerateJobName }} + CloudConfig: ${{ parameters.CloudConfig }} + ${{ each param in parameters.AdditionalParameters }}: + ${{ param.key }}: ${{ param.value }} +- ${{ else }}: + - ${{ each pool in parameters.Pools }}: + - template: ${{ parameters.JobTemplatePath }} + parameters: + UsePlatformContainer: false + OSName: ${{ pool.os }} + Matrix: dependencies.${{ parameters.GenerateJobName }}.outputs['vm_job_matrix_pr_${{ pool.name }}.matrix'] + DependsOn: ${{ parameters.GenerateJobName }} + CloudConfig: ${{ parameters.CloudConfig }} + ${{ each param in parameters.AdditionalParameters }}: + ${{ param.key }}: ${{ param.value }} diff --git a/eng/common/scripts/Helpers/Package-Helpers.ps1 b/eng/common/scripts/Helpers/Package-Helpers.ps1 index 3c882b31111b..e83be6643cbf 100644 --- a/eng/common/scripts/Helpers/Package-Helpers.ps1 +++ b/eng/common/scripts/Helpers/Package-Helpers.ps1 @@ -170,10 +170,86 @@ function GetValueSafelyFrom-Yaml { $current = $current[$key] } else { - Write-Host "The '$key' part of the path $($Keys -join "/") doesn't exist or is null." return $null } } return [object]$current -} \ No newline at end of file +} + +function Get-ObjectKey { + param ( + [Parameter(Mandatory = $true)] + [object]$Object + ) + + if (-not $Object) { + return "unset" + } + + if ($Object -is [hashtable] -or $Object -is [System.Collections.Specialized.OrderedDictionary]) { + $sortedEntries = $Object.GetEnumerator() | Sort-Object Name + $hashString = ($sortedEntries | ForEach-Object { "$($_.Key)=$($_.Value)" }) -join ";" + return $hashString.GetHashCode() + } + + elseif ($Object -is [PSCustomObject]) { + $sortedProperties = $Object.PSObject.Properties | Sort-Object Name + $propertyString = ($sortedProperties | ForEach-Object { "$($_.Name)=$($_.Value)" }) -join ";" + return $propertyString.GetHashCode() + } + + elseif ($Object -is [array]) { + $arrayString = ($Object | ForEach-Object { Get-ObjectKey $_ }) -join ";" + return $arrayString.GetHashCode() + } + + else { + return $Object.GetHashCode() + } +} + +function Group-ByObjectKey { + param ( + [Parameter(Mandatory)] + [array]$Items, + + [Parameter(Mandatory)] + [string]$GroupByProperty + ) + + $groupedDictionary = @{} + + foreach ($item in $Items) { + $key = Get-ObjectKey $item."$GroupByProperty" + + if (-not $groupedDictionary.ContainsKey($key)) { + $groupedDictionary[$key] = @() + } + + # Add the current item to the array for this key + $groupedDictionary[$key] += $item + } + + return $groupedDictionary +} + +function Split-ArrayIntoBatches { + param ( + [Parameter(Mandatory = $true)] + [Object[]]$InputArray, + + [Parameter(Mandatory = $true)] + [int]$BatchSize + ) + + $batches = @() + + for ($i = 0; $i -lt $InputArray.Count; $i += $BatchSize) { + $batch = $InputArray[$i..[math]::Min($i + $BatchSize - 1, $InputArray.Count - 1)] + + $batches += , $batch + } + + return , $batches +} diff --git a/eng/common/scripts/Helpers/Resource-Helpers.ps1 b/eng/common/scripts/Helpers/Resource-Helpers.ps1 index a5806ea1ea0a..ce8e40d15f48 100644 --- a/eng/common/scripts/Helpers/Resource-Helpers.ps1 +++ b/eng/common/scripts/Helpers/Resource-Helpers.ps1 @@ -232,104 +232,10 @@ function Remove-WormStorageAccounts() { foreach ($group in $groups) { Write-Host "=========================================" $accounts = Get-AzStorageAccount -ResourceGroupName $group.ResourceGroupName - if ($accounts) { - foreach ($account in $accounts) { - if ($WhatIfPreference) { - Write-Host "What if: Removing $($account.StorageAccountName) in $($account.ResourceGroupName)" - } - else { - Write-Host "Removing $($account.StorageAccountName) in $($account.ResourceGroupName)" - } - - $hasContainers = ($account.Kind -ne "FileStorage") - - # If it doesn't have containers then we can skip the explicit clean-up of this storage account - if (!$hasContainers) { continue } - - $ctx = New-AzStorageContext -StorageAccountName $account.StorageAccountName - $containers = $ctx | Get-AzStorageContainer - $blobs = $containers | Get-AzStorageBlob - - $immutableBlobs = $containers ` - | Where-Object { $_.BlobContainerProperties.HasImmutableStorageWithVersioning } ` - | Get-AzStorageBlob - try { - foreach ($blob in $immutableBlobs) { - # We can't edit blobs with customer encryption without using that key - # so just try to delete them fully instead. It is unlikely they - # will also have a legal hold enabled. - if (($blob | Get-Member 'ListBlobProperties') ` - -and $blob.ListBlobProperties.Properties.CustomerProvidedKeySha256) { - Write-Host "Removing customer encrypted blob: $($blob.Name), account: $($account.StorageAccountName), group: $($group.ResourceGroupName)" - $blob | Remove-AzStorageBlob -Force - continue - } - - if (!($blob | Get-Member 'BlobProperties')) { - continue - } - - if ($blob.BlobProperties.LeaseState -eq 'Leased') { - Write-Host "Breaking blob lease: $($blob.Name), account: $($account.StorageAccountName), group: $($group.ResourceGroupName)" - $blob.ICloudBlob.BreakLease() - } + if (!$accounts) { break } - if ($blob.BlobProperties.HasLegalHold) { - Write-Host "Removing legal hold - blob: $($blob.Name), account: $($account.StorageAccountName), group: $($group.ResourceGroupName)" - $blob | Set-AzStorageBlobLegalHold -DisableLegalHold | Out-Null - } - } - } catch { - Write-Warning "Ensure user has 'Storage Blob Data Owner' RBAC permission on subscription or resource group" - Write-Error $_ - throw - } - # Sometimes we get a 404 blob not found but can still delete containers, - # and sometimes we must delete the blob if there's a legal hold. - # Try to remove the blob, but keep running regardless. - $succeeded = $false - for ($attempt = 0; $attempt -lt 2; $attempt++) { - if ($succeeded) { - break - } - - try { - foreach ($blob in $blobs) { - if ($blob.BlobProperties.ImmutabilityPolicy.PolicyMode) { - Write-Host "Removing immutability policy - blob: $($blob.Name), account: $($ctx.StorageAccountName), group: $($group.ResourceGroupName)" - $null = $blob | Remove-AzStorageBlobImmutabilityPolicy - } - } - } - catch {} - - try { - foreach ($blob in $blobs) { - $blob | Remove-AzStorageBlob -Force - } - $succeeded = $true - } - catch { - Write-Warning "Failed to remove blobs - account: $($ctx.StorageAccountName), group: $($group.ResourceGroupName)" - Write-Warning $_ - } - } - - try { - # Use AzRm cmdlet as deletion will only work through ARM with the immutability policies defined on the blobs - $containers | ForEach-Object { Remove-AzRmStorageContainer -Name $_.Name -StorageAccountName $ctx.StorageAccountName -ResourceGroupName $group.ResourceGroupName -Force } - } catch { - Write-Warning "Container removal failed. Ignoring the error and trying to delete the storage account." - Write-Warning $_ - } - Remove-AzStorageAccount -StorageAccountName $account.StorageAccountName -ResourceGroupName $account.ResourceGroupName -Force - } - } - if ($WhatIfPreference) { - Write-Host "What if: Removing resource group $($group.ResourceGroupName)" - } - else { - Remove-AzResourceGroup -ResourceGroupName $group.ResourceGroupName -Force -AsJob + foreach ($account in $accounts) { + RemoveStorageAccount -Account $account } } } @@ -401,6 +307,96 @@ function SetStorageNetworkAccessRules([string]$ResourceGroupName, [array]$AllowI } } +function RemoveStorageAccount($Account) { + Write-Host ($WhatIfPreference ? 'What if: ' : '') + "Readying $($Account.StorageAccountName) in $($Account.ResourceGroupName) for deletion" + # If it doesn't have containers then we can skip the explicit clean-up of this storage account + if ($Account.Kind -eq "FileStorage") { return } + + $containers = New-AzStorageContext -StorageAccountName $Account.StorageAccountName | Get-AzStorageContainer + $blobs = $containers | Get-AzStorageBlob + $deleteNow = @() + + try { + foreach ($blob in $blobs) { + $shouldDelete = EnableBlobDeletion -Blob $blob -StorageAccountName $Account.StorageAccountName -ResourceGroupName $Account.ResourceGroupName + if ($shouldDelete) { + $deleteNow += $blob + } + } + } catch { + Write-Warning "Ensure user has 'Storage Blob Data Owner' RBAC permission on subscription or resource group" + Write-Error $_ + throw + } + + # Blobs with legal holds or immutability policies must be deleted individually + # before the container/account can be deleted + foreach ($blobToDelete in $deleteNow) { + try { + $blobToDelete | Remove-AzStorageBlob -Force + } catch { + Write-Host "Blob removal failed: $($Blob.Name), account: $($Account.storageAccountName), group: $($Account.ResourceGroupName)" + Write-Warning "Ignoring the error and trying to delete the storage account" + Write-Warning $_ + } + } + + foreach ($container in $containers) { + if ($container.BlobContainerProperties.HasImmutableStorageWithVersioning) { + try { + # Use AzRm cmdlet as deletion will only work through ARM with the immutability policies defined on the blobs + Remove-AzRmStorageContainer -Name $container.Name -StorageAccountName $Account.StorageAccountName -ResourceGroupName $Account.ResourceGroupName -Force + #$container | Remove-AzStorageContainer + } catch { + Write-Host "Container removal failed: $($container.Name), account: $($Account.storageAccountName), group: $($Account.ResourceGroupName)" + Write-Warning "Ignoring the error and trying to delete the storage account" + Write-Warning $_ + } + } + } + + if ($containers) { + Remove-AzStorageAccount -StorageAccountName $Account.StorageAccountName -ResourceGroupName $Account.ResourceGroupName -Force + } +} + +function EnableBlobDeletion($Blob, $StorageAccountName, $ResourceGroupName) { + # Some properties like immutability policies require the blob to be + # deleted before the container can be deleted + $forceBlobDeletion = $false + + # We can't edit blobs with customer encryption without using that key + # so just try to delete them fully instead. It is unlikely they + # will also have a legal hold enabled. + if (($Blob | Get-Member 'ListBlobProperties') ` + -and $Blob.ListBlobProperties.Properties.CustomerProvidedKeySha256) { + return $true + } + + if (!($Blob | Get-Member 'BlobProperties')) { + return $false + } + + if ($Blob.BlobProperties.ImmutabilityPolicy.PolicyMode) { + Write-Host "Removing immutability policy - blob: $($Blob.Name), account: $StorageAccountName, group: $ResourceGroupName" + $null = $Blob | Remove-AzStorageBlobImmutabilityPolicy + $forceBlobDeletion = $true + } + + if ($Blob.BlobProperties.HasLegalHold) { + Write-Host "Removing legal hold - blob: $($Blob.Name), account: $StorageAccountName, group: $ResourceGroupName" + $Blob | Set-AzStorageBlobLegalHold -DisableLegalHold | Out-Null + $forceBlobDeletion = $true + } + + if ($Blob.BlobProperties.LeaseState -eq 'Leased') { + Write-Host "Breaking blob lease: $($Blob.Name), account: $StorageAccountName, group: $ResourceGroupName" + $Blob.ICloudBlob.BreakLease() + } + + return $forceBlobDeletion +} + function DoesSubnetOverlap([string]$ipOrCidr, [string]$overlapIp) { [System.Net.IPAddress]$overlapIpAddress = $overlapIp $parsed = $ipOrCidr -split '/' diff --git a/eng/common/scripts/Package-Properties.ps1 b/eng/common/scripts/Package-Properties.ps1 index 61054f10f22a..cf9c1b391eb1 100644 --- a/eng/common/scripts/Package-Properties.ps1 +++ b/eng/common/scripts/Package-Properties.ps1 @@ -1,8 +1,7 @@ # Helper functions for retrieving useful information from azure-sdk-for-* repo . "${PSScriptRoot}\logging.ps1" . "${PSScriptRoot}\Helpers\Package-Helpers.ps1" -class PackageProps -{ +class PackageProps { [string]$Name [string]$Version [string]$DevVersion @@ -21,14 +20,13 @@ class PackageProps # additional packages required for validation of this one [string[]]$AdditionalValidationPackages [HashTable]$ArtifactDetails + [HashTable[]]$CIMatrixConfigs - PackageProps([string]$name, [string]$version, [string]$directoryPath, [string]$serviceDirectory) - { + PackageProps([string]$name, [string]$version, [string]$directoryPath, [string]$serviceDirectory) { $this.Initialize($name, $version, $directoryPath, $serviceDirectory) } - PackageProps([string]$name, [string]$version, [string]$directoryPath, [string]$serviceDirectory, [string]$group = "") - { + PackageProps([string]$name, [string]$version, [string]$directoryPath, [string]$serviceDirectory, [string]$group = "") { $this.Initialize($name, $version, $directoryPath, $serviceDirectory, $group) } @@ -37,35 +35,29 @@ class PackageProps [string]$version, [string]$directoryPath, [string]$serviceDirectory - ) - { + ) { $this.Name = $name $this.Version = $version $this.DirectoryPath = $directoryPath $this.ServiceDirectory = $serviceDirectory $this.IncludedForValidation = $false - if (Test-Path (Join-Path $directoryPath "README.md")) - { + if (Test-Path (Join-Path $directoryPath "README.md")) { $this.ReadMePath = Join-Path $directoryPath "README.md" } - else - { + else { $this.ReadMePath = $null } - if (Test-Path (Join-Path $directoryPath "CHANGELOG.md")) - { + if (Test-Path (Join-Path $directoryPath "CHANGELOG.md")) { $this.ChangeLogPath = Join-Path $directoryPath "CHANGELOG.md" # Get release date for current version and set in package property $changeLogEntry = Get-ChangeLogEntry -ChangeLogLocation $this.ChangeLogPath -VersionString $this.Version - if ($changeLogEntry -and $changeLogEntry.ReleaseStatus) - { - $this.ReleaseStatus = $changeLogEntry.ReleaseStatus.Trim().Trim("()") + if ($changeLogEntry -and $changeLogEntry.ReleaseStatus) { + $this.ReleaseStatus = $changeLogEntry.ReleaseStatus.Trim().Trim("()") } } - else - { + else { $this.ChangeLogPath = $null } @@ -78,14 +70,12 @@ class PackageProps [string]$directoryPath, [string]$serviceDirectory, [string]$group - ) - { + ) { $this.Initialize($name, $version, $directoryPath, $serviceDirectory) $this.Group = $group } - hidden [HashTable]ParseYmlForArtifact([string]$ymlPath) { - + hidden [PSCustomObject]ParseYmlForArtifact([string]$ymlPath) { $content = LoadFrom-Yaml $ymlPath if ($content) { $artifacts = GetValueSafelyFrom-Yaml $content @("extends", "parameters", "Artifacts") @@ -95,24 +85,40 @@ class PackageProps $artifactForCurrentPackage = $artifacts | Where-Object { $_["name"] -eq $this.ArtifactName -or $_["name"] -eq $this.Name } } + # if we found an artifact for the current package, we should count this ci file as the source of the matrix for this package if ($artifactForCurrentPackage) { - return [HashTable]$artifactForCurrentPackage + $result = [PSCustomObject]@{ + ArtifactConfig = [HashTable]$artifactForCurrentPackage + MatrixConfigs = @() + } + + # if we know this is the matrix for our file, we should now see if there is a custom matrix config for the package + $matrixConfigList = GetValueSafelyFrom-Yaml $content @("extends", "parameters", "MatrixConfigs") + + if ($matrixConfigList) { + $result.MatrixConfigs = $matrixConfigList + } + + return $result } } return $null } - [void]InitializeCIArtifacts(){ + [void]InitializeCIArtifacts() { $RepoRoot = Resolve-Path (Join-Path $PSScriptRoot ".." ".." "..") $ciFolderPath = Join-Path -Path $RepoRoot -ChildPath (Join-Path "sdk" $this.ServiceDirectory) $ciFiles = Get-ChildItem -Path $ciFolderPath -Filter "ci*.yml" -File if (-not $this.ArtifactDetails) { - foreach($ciFile in $ciFiles) { + foreach ($ciFile in $ciFiles) { $ciArtifactResult = $this.ParseYmlForArtifact($ciFile.FullName) if ($ciArtifactResult) { - $this.ArtifactDetails = [Hashtable]$ciArtifactResult + $this.ArtifactDetails = [Hashtable]$ciArtifactResult.ArtifactConfig + $this.CIMatrixConfigs = $ciArtifactResult.MatrixConfigs + # if this package appeared in this ci file, then we should + # treat this CI file as the source of the Matrix for this package break } } @@ -124,8 +130,7 @@ class PackageProps # Returns important properties of the package relative to the language repo # Returns a PS Object with properties @ { pkgName, pkgVersion, pkgDirectoryPath, pkgReadMePath, pkgChangeLogPath } # Note: python is required for parsing python package properties. -function Get-PkgProperties -{ +function Get-PkgProperties { Param ( [Parameter(Mandatory = $true)] @@ -136,10 +141,8 @@ function Get-PkgProperties $allPkgProps = Get-AllPkgProperties -ServiceDirectory $ServiceDirectory $pkgProps = $allPkgProps.Where({ $_.Name -eq $PackageName -or $_.ArtifactName -eq $PackageName }); - if ($pkgProps.Count -ge 1) - { - if ($pkgProps.Count -gt 1) - { + if ($pkgProps.Count -ge 1) { + if ($pkgProps.Count -gt 1) { Write-Host "Found more than one project with the name [$PackageName], choosing the first one under $($pkgProps[0].DirectoryPath)" } return $pkgProps[0] @@ -159,15 +162,13 @@ function Get-PrPkgProperties([string]$InputDiffJson) { $additionalValidationPackages = @() $lookup = @{} - foreach ($pkg in $allPackageProperties) - { + foreach ($pkg in $allPackageProperties) { $pkgDirectory = Resolve-Path "$($pkg.DirectoryPath)" $lookupKey = ($pkg.DirectoryPath).Replace($RepoRoot, "").TrimStart('\/') $lookup[$lookupKey] = $pkg - foreach ($file in $targetedFiles) - { - $filePath = Resolve-Path (Join-Path $RepoRoot $file) + foreach ($file in $targetedFiles) { + $filePath = (Join-Path $RepoRoot $file) $shouldInclude = $filePath -like "$pkgDirectory*" if ($shouldInclude) { $packagesWithChanges += $pkg @@ -191,8 +192,7 @@ function Get-PrPkgProperties([string]$InputDiffJson) { } } - if ($AdditionalValidationPackagesFromPackageSetFn -and (Test-Path "Function:$AdditionalValidationPackagesFromPackageSetFn")) - { + if ($AdditionalValidationPackagesFromPackageSetFn -and (Test-Path "Function:$AdditionalValidationPackagesFromPackageSetFn")) { $packagesWithChanges += &$AdditionalValidationPackagesFromPackageSetFn $packagesWithChanges $diff $allPackageProperties } @@ -202,25 +202,19 @@ function Get-PrPkgProperties([string]$InputDiffJson) { # Takes ServiceName and Repo Root Directory # Returns important properties for each package in the specified service, or entire repo if the serviceName is not specified # Returns a Table of service key to array values of PS Object with properties @ { pkgName, pkgVersion, pkgDirectoryPath, pkgReadMePath, pkgChangeLogPath } -function Get-AllPkgProperties ([string]$ServiceDirectory = $null) -{ +function Get-AllPkgProperties ([string]$ServiceDirectory = $null) { $pkgPropsResult = @() - if (Test-Path "Function:Get-AllPackageInfoFromRepo") - { + if (Test-Path "Function:Get-AllPackageInfoFromRepo") { $pkgPropsResult = Get-AllPackageInfoFromRepo -ServiceDirectory $serviceDirectory } - else - { - if ([string]::IsNullOrEmpty($ServiceDirectory)) - { - foreach ($dir in (Get-ChildItem (Join-Path $RepoRoot "sdk") -Directory)) - { + else { + if ([string]::IsNullOrEmpty($ServiceDirectory)) { + foreach ($dir in (Get-ChildItem (Join-Path $RepoRoot "sdk") -Directory)) { $pkgPropsResult += Get-PkgPropsForEntireService -serviceDirectoryPath $dir.FullName } } - else - { + else { $pkgPropsResult = Get-PkgPropsForEntireService -serviceDirectoryPath (Join-Path $RepoRoot "sdk" $ServiceDirectory) } } @@ -230,29 +224,24 @@ function Get-AllPkgProperties ([string]$ServiceDirectory = $null) # Given the metadata url under https://github.com/Azure/azure-sdk/tree/main/_data/releases/latest, # the function will return the csv metadata back as part of the response. -function Get-CSVMetadata ([string]$MetadataUri=$MetadataUri) -{ +function Get-CSVMetadata ([string]$MetadataUri = $MetadataUri) { $metadataResponse = Invoke-RestMethod -Uri $MetadataUri -method "GET" -MaximumRetryCount 3 -RetryIntervalSec 10 | ConvertFrom-Csv return $metadataResponse } -function Get-PkgPropsForEntireService ($serviceDirectoryPath) -{ +function Get-PkgPropsForEntireService ($serviceDirectoryPath) { $projectProps = @() # Properties from every project in the service $serviceDirectory = $serviceDirectoryPath -replace '^.*[\\/]+sdk[\\/]+([^\\/]+).*$', '$1' - if (!$GetPackageInfoFromRepoFn -or !(Test-Path "Function:$GetPackageInfoFromRepoFn")) - { + if (!$GetPackageInfoFromRepoFn -or !(Test-Path "Function:$GetPackageInfoFromRepoFn")) { LogError "The function for '$GetPackageInfoFromRepoFn' was not found.` Make sure it is present in eng/scripts/Language-Settings.ps1 and referenced in eng/common/scripts/common.ps1.` See https://github.com/Azure/azure-sdk-tools/blob/main/doc/common/common_engsys.md#code-structure" } - foreach ($directory in (Get-ChildItem $serviceDirectoryPath -Directory)) - { + foreach ($directory in (Get-ChildItem $serviceDirectoryPath -Directory)) { $pkgProps = &$GetPackageInfoFromRepoFn $directory.FullName $serviceDirectory - if ($null -ne $pkgProps) - { + if ($null -ne $pkgProps) { $projectProps += $pkgProps } } diff --git a/eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1 b/eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1 new file mode 100644 index 000000000000..03fc6422e3aa --- /dev/null +++ b/eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1 @@ -0,0 +1,130 @@ +<# +.SYNOPSIS +Generates a combined PR job matrix from a package properties folder. It is effectively a combination of +Create-JobMatrix and distribute-packages-to-matrix. + +.DESCRIPTION +Create-JobMatrix has a limitation in that it accepts one or multiple matrix files, but it doesn't allow runtime +selection of the matrix file based on what is being built. Due to this, this script exists to provide exactly +that mapping. + +It should be called from a PR build only. + +It generates the matrix by the following algorithm: + - load all package properties files + - group the package properties by their targeted CI Matrix Configs + - for each package group, generate the matrix for each matrix config in the group (remember MatrixConfigs is a list not a single object) + - for each matrix config, generate the matrix + - calculate if batching is necessary for this matrix config + - for each batch + - create combined property name for the batch + - walk each matrix item + - add suffixes for batch and matrix config if nececessary to the job name + - add the combined property name to the parameters of the matrix item + - add the matrix item to the overall result + +.EXAMPLE +./eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1 ` + -PackagePropertiesFolder "path/to/populated/PackageInfo" ` + -PrMatrixSetting "" +#> + +[CmdletBinding()] +param ( + [Parameter(Mandatory = $true)][string] $PackagePropertiesFolder, + [Parameter(Mandatory = $true)][string] $PRMatrixFile, + [Parameter(Mandatory = $true)][string] $PRMatrixSetting, + [Parameter(Mandatory = $False)][string] $DisplayNameFilter, + [Parameter(Mandatory = $False)][array] $Filters, + [Parameter(Mandatory = $False)][array] $Replace, + [Parameter()][switch] $CI = ($null -ne $env:SYSTEM_TEAMPROJECTID) +) + +. $PSScriptRoot/job-matrix-functions.ps1 +. $PSScriptRoot/../Helpers/Package-Helpers.ps1 +$BATCHSIZE = 10 + +if (!(Test-Path $PackagePropertiesFolder)) { + Write-Error "Package Properties folder doesn't exist" + exit 1 +} + +if (!(Test-Path $PRMatrixFile)) { + Write-Error "PR Matrix file doesn't exist" + exit 1 +} + +Write-Host "Generating PR job matrix for $PackagePropertiesFolder" + +$configs = Get-Content -Raw $PRMatrixFile | ConvertFrom-Json + +# calculate general targeting information and create our batches prior to generating any matrix +$packageProperties = Get-ChildItem -Recurse "$PackagePropertiesFolder" *.json ` +| ForEach-Object { Get-Content -Path $_.FullName | ConvertFrom-Json } + +# set default matrix config for each package if there isn't an override +$packageProperties | ForEach-Object { + if (-not $_.CIMatrixConfigs) { + $_.CIMatrixConfigs = $configs + } +} + +# The key here is that after we group the packages by the matrix config objects, we can use the first item's MatrixConfig +# to generate the matrix for the group, no reason to have to parse the key value backwards to get the matrix config. +$matrixBatchesByConfig = Group-ByObjectKey $packageProperties "CIMatrixConfigs" + +$OverallResult = @() +foreach ($matrixBatchKey in $matrixBatchesByConfig.Keys) { + $matrixBatch = $matrixBatchesByConfig[$matrixBatchKey] + $matrixConfigs = $matrixBatch | Select-Object -First 1 -ExpandProperty CIMatrixConfigs + + $matrixResults = @() + foreach ($matrixConfig in $matrixConfigs) { + Write-Host "Generating config for $($matrixConfig.Path)" + $matrixResults = GenerateMatrixForConfig ` + -ConfigPath $matrixConfig.Path ` + -Selection $matrixConfig.Selection ` + -DisplayNameFilter $DisplayNameFilter ` + -Filters $Filters ` + -Replace $Replace + + $packageBatches = Split-ArrayIntoBatches -InputArray $matrixBatch -BatchSize $BATCHSIZE + + # we only need to modify the generated job name if there is more than one matrix config or batch in the matrix + $matrixSuffixNecessary = $matrixConfigs.Count -gt 1 + $batchSuffixNecessary = $packageBatches.Length -gt 1 + $batchCounter = 1 + + foreach ($batch in $packageBatches) { + # to understand this iteration, one must understand that the matrix is a list of hashtables, each with a couple keys: + # [ + # { "name": "jobname", "parameters": { matrixSetting1: matrixValue1, ...} }, + # ] + foreach ($matrixOutputItem in $matrixResults) { + $namesForBatch = ($batch | ForEach-Object { $_.ArtifactName }) -join "," + # we just need to iterate across them, grab the parameters hashtable, and add the new key + # if there is more than one batch, we will need to add a suffix including the batch name to the job name + $matrixOutputItem["parameters"]["$PRMatrixSetting"] = $namesForBatch + + if ($matrixSuffixNecessary) { + $matrixOutputItem["name"] = $matrixOutputItem["name"] + $matrixConfig.Name + } + + if ($batchSuffixNecessary) { + $matrixOutputItem["name"] = $matrixOutputItem["name"] + "b$batchCounter" + } + + $OverallResult += $matrixOutputItem + } + $batchCounter += 1 + } + } +} + +$serialized = SerializePipelineMatrix $OverallResult + +Write-Output $serialized.pretty + +if ($CI) { + Write-Output "##vso[task.setVariable variable=matrix;isOutput=true]$($serialized.compressed)" +} diff --git a/eng/common/scripts/job-matrix/job-matrix-functions.ps1 b/eng/common/scripts/job-matrix/job-matrix-functions.ps1 index f20dbe5281b0..0693f7983f18 100644 --- a/eng/common/scripts/job-matrix/job-matrix-functions.ps1 +++ b/eng/common/scripts/job-matrix/job-matrix-functions.ps1 @@ -740,3 +740,28 @@ function Get4dMatrixIndex([int]$index, [Array]$dimensions) { return @($page3, $page2, $page1, $remainder) } +function GenerateMatrixForConfig { + param ( + [Parameter(Mandatory = $true)][string] $ConfigPath, + [Parameter(Mandatory = $True)][string] $Selection, + [Parameter(Mandatory = $false)][string] $DisplayNameFilter, + [Parameter(Mandatory = $false)][array] $Filters, + [Parameter(Mandatory = $false)][array] $Replace + ) + $matrixFile = Join-Path $PSScriptRoot ".." ".." ".." ".." $ConfigPath + + $resolvedMatrixFile = Resolve-Path $matrixFile + + $config = GetMatrixConfigFromFile (Get-Content $resolvedMatrixFile -Raw) + # Strip empty string filters in order to be able to use azure pipelines yaml join() + $Filters = $Filters | Where-Object { $_ } + + [array]$matrix = GenerateMatrix ` + -config $config ` + -selectFromMatrixType $Selection ` + -displayNameFilter $DisplayNameFilter ` + -filters $Filters ` + -replace $Replace + + return , $matrix +} diff --git a/eng/common/scripts/logging.ps1 b/eng/common/scripts/logging.ps1 index 84adec47fea9..91640cd7eb5d 100644 --- a/eng/common/scripts/logging.ps1 +++ b/eng/common/scripts/logging.ps1 @@ -1,40 +1,93 @@ -function Test-SupportsDevOpsLogging() -{ - return ($null -ne $env:SYSTEM_TEAMPROJECTID) +function Test-SupportsDevOpsLogging() { + return ($null -ne $env:SYSTEM_TEAMPROJECTID) } -function LogWarning -{ - if (Test-SupportsDevOpsLogging) - { - Write-Host "##vso[task.LogIssue type=warning;]$args" - } - else - { - Write-Warning "$args" - } +function Test-SupportsGitHubLogging() { + return ($null -ne $env:GITHUB_ACTIONS) } -function LogError -{ - if (Test-SupportsDevOpsLogging) - { - Write-Host "##vso[task.LogIssue type=error;]$args" - } - else - { - Write-Error "$args" - } +function LogInfo { + Write-Host "$args" +} + +function LogWarning { + if (Test-SupportsDevOpsLogging) { + Write-Host ("##vso[task.LogIssue type=warning;]$args" -replace "`n", "%0D%0A") + } + elseif (Test-SupportsGitHubLogging) { + Write-Warning ("::warning::$args" -replace "`n", "%0D%0A") + } + else { + Write-Warning "$args" + } } -function LogDebug +function LogSuccess { + $esc = [char]27 + $green = "${esc}[32m" + $reset = "${esc}[0m" + + Write-Host "${green}$args${reset}" +} + +function LogErrorForFile($file, $errorString) { - if (Test-SupportsDevOpsLogging) - { - Write-Host "[debug]$args" - } - else - { - Write-Debug "$args" - } + if (Test-SupportsDevOpsLogging) { + Write-Host ("##vso[task.logissue type=error;sourcepath=$file;linenumber=1;columnnumber=1;]$errorString" -replace "`n", "%0D%0A") + } + elseif (Test-SupportsGitHubLogging) { + Write-Error ("::error file=$file,line=1,col=1::$errorString" -replace "`n", "%0D%0A") + } + else { + Write-Error "[Error in file $file]$errorString" + } +} + +function LogError { + if (Test-SupportsDevOpsLogging) { + Write-Host ("##vso[task.LogIssue type=error;]$args" -replace "`n", "%0D%0A") + } + elseif (Test-SupportsGitHubLogging) { + Write-Error ("::error::$args" -replace "`n", "%0D%0A") + } + else { + Write-Error "$args" + } +} + +function LogDebug { + if (Test-SupportsDevOpsLogging) { + Write-Host "[debug]$args" + } + elseif (Test-SupportsGitHubLogging) { + Write-Debug "::debug::$args" + } + else { + Write-Debug "$args" + } +} + +function LogGroupStart() { + if (Test-SupportsDevOpsLogging) { + Write-Host "##[group]$args" + } + elseif (Test-SupportsGitHubLogging) { + Write-Host "::group::$args" + } +} + +function LogGroupEnd() { + if (Test-SupportsDevOpsLogging) { + Write-Host "##[endgroup]" + } + elseif (Test-SupportsGitHubLogging) { + Write-Host "::endgroup::" + } +} + +function LogJobFailure() { + if (Test-SupportsDevOpsLogging) { + Write-Host "##vso[task.complete result=Failed;]" + } + # No equivalent for GitHub Actions. Failure is only determined by nonzero exit code. } diff --git a/eng/common/scripts/stress-testing/stress-test-deployment-lib.ps1 b/eng/common/scripts/stress-testing/stress-test-deployment-lib.ps1 index da8c12318a17..7cf55c758487 100644 --- a/eng/common/scripts/stress-testing/stress-test-deployment-lib.ps1 +++ b/eng/common/scripts/stress-testing/stress-test-deployment-lib.ps1 @@ -121,7 +121,7 @@ function DeployStressTests( Write-Warning "Overriding cluster group and subscription with defaults for 'prod' environment." } $clusterGroup = 'rg-stress-cluster-prod' - $subscription = 'Azure SDK Test Resources' + $subscription = 'Azure SDK Test Resources - TME' } elseif ($environment -eq 'storage') { if ($clusterGroup -or $subscription) { Write-Warning "Overriding cluster group and subscription with defaults for 'storage' environment." diff --git a/eng/common/testproxy/target_version.txt b/eng/common/testproxy/target_version.txt index 61a8b83485f7..1f111a027853 100644 --- a/eng/common/testproxy/target_version.txt +++ b/eng/common/testproxy/target_version.txt @@ -1 +1 @@ -1.0.0-dev.20240919.1 +1.0.0-dev.20241101.1 diff --git a/eng/tools/typespec-validation/src/rules/compile.ts b/eng/tools/typespec-validation/src/rules/compile.ts index a9180f266e88..3e472075778e 100644 --- a/eng/tools/typespec-validation/src/rules/compile.ts +++ b/eng/tools/typespec-validation/src/rules/compile.ts @@ -14,8 +14,7 @@ export class CompileRule implements Rule { if (await host.checkFileExists(path.join(folder, "main.tsp"))) { let [err, stdout, stderr] = await host.runCmd( - `npm exec --no -- tsp compile . --warn-as-error`, - folder, + `npm exec --no -- tsp compile --warn-as-error ${folder}`, ); if ( stdout.toLowerCase().includes("no emitter was configured") || @@ -31,10 +30,11 @@ export class CompileRule implements Rule { stdOutput += stdout; errorOutput += stderr; } - if (await host.checkFileExists(path.join(folder, "client.tsp"))) { + + const clientTsp = path.join(folder, "client.tsp"); + if (await host.checkFileExists(clientTsp)) { let [err, stdout, stderr] = await host.runCmd( - `npm exec --no -- tsp compile client.tsp --no-emit --warn-as-error`, - folder, + `npm exec --no -- tsp compile --no-emit --warn-as-error ${clientTsp}`, ); if (err) { success = false; diff --git a/eng/tools/typespec-validation/src/tsv-host.ts b/eng/tools/typespec-validation/src/tsv-host.ts index adbe5ecfc916..0965a498eaab 100644 --- a/eng/tools/typespec-validation/src/tsv-host.ts +++ b/eng/tools/typespec-validation/src/tsv-host.ts @@ -5,7 +5,7 @@ export interface TsvHost { isDirectory(path: string): Promise; gitOperation(folder: string): IGitOperation; readTspConfig(folder: string): Promise; - runCmd(cmd: string, cwd: string): Promise<[Error | null, string, string]>; + runCmd(cmd: string, cwd?: string): Promise<[Error | null, string, string]>; normalizePath(folder: string): string; gitDiffTopSpecFolder(host: TsvHost, folder: string): Promise; globby(patterns: string[]): Promise; diff --git a/eng/tools/typespec-validation/src/utils.ts b/eng/tools/typespec-validation/src/utils.ts index dbbc6bf1d207..7d28ddb94b90 100644 --- a/eng/tools/typespec-validation/src/utils.ts +++ b/eng/tools/typespec-validation/src/utils.ts @@ -3,7 +3,7 @@ import { exec } from "child_process"; import defaultPath, { PlatformPath } from "path"; import { TsvHost } from "./tsv-host.js"; -export async function runCmd(cmd: string, cwd: string) { +export async function runCmd(cmd: string, cwd?: string) { console.log(`run command:${cmd}`); const { err, stdout, stderr } = (await new Promise((res) => exec( diff --git a/eng/tools/typespec-validation/test/compile.test.ts b/eng/tools/typespec-validation/test/compile.test.ts index f3398f22f4b4..6fdd5178996d 100644 --- a/eng/tools/typespec-validation/test/compile.test.ts +++ b/eng/tools/typespec-validation/test/compile.test.ts @@ -14,7 +14,7 @@ describe("compile", function () { it("should fail if no emitter was configured", async function () { let host = new TsvTestHost(); host.runCmd = async (cmd: string, _cwd: string): Promise<[Error | null, string, string]> => { - if (cmd.includes("tsp compile .")) { + if (cmd.includes("tsp compile")) { return [null, "no emitter was configured", ""]; } else { return [null, "", ""]; @@ -29,7 +29,7 @@ describe("compile", function () { it("should fail if no output was generated", async function () { let host = new TsvTestHost(); host.runCmd = async (cmd: string, _cwd: string): Promise<[Error | null, string, string]> => { - if (cmd.includes("tsp compile .")) { + if (cmd.includes("tsp compile")) { return [null, "no output was generated", ""]; } else { return [null, "", ""]; diff --git a/package-lock.json b/package-lock.json index 067d3e01c18b..015caf094eb2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,8 +12,8 @@ "@azure-tools/typespec-azure-portal-core": "0.47.0", "@azure-tools/typespec-azure-resource-manager": "0.47.1", "@azure-tools/typespec-azure-rulesets": "0.47.0", - "@azure-tools/typespec-client-generator-cli": "0.13.2", - "@azure-tools/typespec-client-generator-core": "0.47.3", + "@azure-tools/typespec-client-generator-cli": "0.13.3", + "@azure-tools/typespec-client-generator-core": "0.47.4", "@azure-tools/typespec-liftr-base": "0.4.0", "@azure/avocado": "^0.9.1", "@typespec/compiler": "0.61.2", @@ -35,6 +35,7 @@ "eng/tools": { "name": "azure-rest-api-specs-eng-tools", "dev": true, + "hasInstallScript": true, "devDependencies": { "@azure-tools/specs-model": "file:specs-model", "@azure-tools/suppressions": "file:suppressions", @@ -275,7 +276,6 @@ "eng/tools/specs-model": { "name": "@azure-tools/specs-model", "dev": true, - "hasInstallScript": true, "bin": { "get-specs-model": "cmd/get-specs-model.js" }, @@ -298,7 +298,6 @@ "eng/tools/suppressions": { "name": "@azure-tools/suppressions", "dev": true, - "hasInstallScript": true, "dependencies": { "minimatch": "^9.0.4", "yaml": "^2.4.2", @@ -321,7 +320,6 @@ "eng/tools/tsp-client-tests": { "name": "@azure-tools/tsp-client-tests", "dev": true, - "hasInstallScript": true, "devDependencies": { "@types/node": "^18.19.31", "execa": "^9.3.0", @@ -335,7 +333,6 @@ "eng/tools/typespec-requirement": { "name": "@azure-tools/typespec-requirement", "dev": true, - "hasInstallScript": true, "devDependencies": { "@types/node": "^18.19.31", "execa": "^9.3.0", @@ -349,7 +346,6 @@ "eng/tools/typespec-validation": { "name": "@azure-tools/typespec-validation", "dev": true, - "hasInstallScript": true, "dependencies": { "globby": "^14.0.1", "simple-git": "^3.24.0", @@ -472,9 +468,9 @@ } }, "node_modules/@autorest/openapi-to-typespec": { - "version": "0.10.2", - "resolved": "https://registry.npmjs.org/@autorest/openapi-to-typespec/-/openapi-to-typespec-0.10.2.tgz", - "integrity": "sha512-N6O/7vND6i4HhU72N7lPuO4CbClhRfYVV5z+MD4M4aaRY/bPekoUV8nei7nR0sa1+cvcCCKvfkJleCSEBMmNyA==", + "version": "0.10.3", + "resolved": "https://registry.npmjs.org/@autorest/openapi-to-typespec/-/openapi-to-typespec-0.10.3.tgz", + "integrity": "sha512-+NY2BpYZC5ZRZyZaOqzTCAfiLPlv0pPQSO7s7vHAcXKGs9mI09djaLvKYLqiULetLsq7HC8xUi4nIEKFQ7r4lw==", "dev": true, "dependencies": { "@autorest/codemodel": "~4.20.0", @@ -756,13 +752,13 @@ } }, "node_modules/@azure-tools/typespec-client-generator-cli": { - "version": "0.13.2", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-cli/-/typespec-client-generator-cli-0.13.2.tgz", - "integrity": "sha512-FHu/HJMkcB9INWeRxMD5vbHGi/wCxtxkGrW1GdxgKgD7bAde/4Ujd7v+EeLqnjslHQ35+QUbDOmKaT+tl3Uf8g==", + "version": "0.13.3", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-cli/-/typespec-client-generator-cli-0.13.3.tgz", + "integrity": "sha512-YY5KBhBZrw1Pb8YlnHYmGCKelAxURg74lGjVnYiVFbzZPP9ntJS/7LWYjHyI1HeKCfqCibiGXkOfJTpmHp2xIg==", "dev": true, "dependencies": { "@autorest/core": "^3.10.2", - "@autorest/openapi-to-typespec": "0.10.2", + "@autorest/openapi-to-typespec": "0.10.3", "@azure-tools/rest-api-diff": ">=0.1.0 <1.0.0", "@azure-tools/typespec-autorest": ">=0.44.0 <1.0.0", "@azure/core-rest-pipeline": "^1.12.0", @@ -786,9 +782,9 @@ } }, "node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.47.3", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.47.3.tgz", - "integrity": "sha512-13knZRDFBlVTw61vbhAnvQzttnqPRwHK0+YI/3QbYRN77j/Kv3zXFPeCcromz31exg3Y/Q8qD24mJ1Oikab2mA==", + "version": "0.47.4", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.47.4.tgz", + "integrity": "sha512-oXA8rHzBsoofzSXvGLGohj6VDYegtgAfGMWo2o4ubew1bS4cvl3CYl9DJ54blqafxtJXnNh4SdjadeHTsCz2mw==", "dev": true, "dependencies": { "change-case": "~5.4.4", diff --git a/package.json b/package.json index ee8cecb5e36a..83b45993eba8 100644 --- a/package.json +++ b/package.json @@ -7,8 +7,8 @@ "@azure-tools/typespec-azure-portal-core": "0.47.0", "@azure-tools/typespec-azure-resource-manager": "0.47.1", "@azure-tools/typespec-azure-rulesets": "0.47.0", - "@azure-tools/typespec-client-generator-cli": "0.13.2", - "@azure-tools/typespec-client-generator-core": "0.47.3", + "@azure-tools/typespec-client-generator-cli": "0.13.3", + "@azure-tools/typespec-client-generator-core": "0.47.4", "@azure-tools/typespec-liftr-base": "0.4.0", "@azure/avocado": "^0.9.1", "@typespec/compiler": "0.61.2", diff --git a/specification/ai/Face/examples/v1.1-preview.1/FaceRecognitionOperations_FindSimilar.json b/specification/ai/Face/examples/v1.1-preview.1/FaceRecognitionOperations_FindSimilar.json index 3a78056208ca..3c2e1888aae2 100644 --- a/specification/ai/Face/examples/v1.1-preview.1/FaceRecognitionOperations_FindSimilar.json +++ b/specification/ai/Face/examples/v1.1-preview.1/FaceRecognitionOperations_FindSimilar.json @@ -18,7 +18,7 @@ "body": [ { "confidence": 0.9, - "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" + "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" } ] } diff --git a/specification/ai/Face/examples/v1.1-preview.1/FaceRecognitionOperations_FindSimilarFromFaceList.json b/specification/ai/Face/examples/v1.1-preview.1/FaceRecognitionOperations_FindSimilarFromFaceList.json index 7c761424783e..14d0102042cb 100644 --- a/specification/ai/Face/examples/v1.1-preview.1/FaceRecognitionOperations_FindSimilarFromFaceList.json +++ b/specification/ai/Face/examples/v1.1-preview.1/FaceRecognitionOperations_FindSimilarFromFaceList.json @@ -15,7 +15,7 @@ "body": [ { "confidence": 0.8, - "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" + "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" } ] } diff --git a/specification/ai/Face/examples/v1.1-preview.1/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json b/specification/ai/Face/examples/v1.1-preview.1/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json index f83d2ed8e685..620468719ce8 100644 --- a/specification/ai/Face/examples/v1.1-preview.1/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json +++ b/specification/ai/Face/examples/v1.1-preview.1/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json @@ -15,7 +15,7 @@ "body": [ { "confidence": 0.8, - "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" + "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" } ] } diff --git a/specification/ai/Face/examples/v1.2-preview.1/FaceRecognitionOperations_FindSimilar.json b/specification/ai/Face/examples/v1.2-preview.1/FaceRecognitionOperations_FindSimilar.json index 4f8b4c6643a9..1b9a4ac529a0 100644 --- a/specification/ai/Face/examples/v1.2-preview.1/FaceRecognitionOperations_FindSimilar.json +++ b/specification/ai/Face/examples/v1.2-preview.1/FaceRecognitionOperations_FindSimilar.json @@ -18,7 +18,7 @@ "body": [ { "confidence": 0.9, - "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" + "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" } ] } diff --git a/specification/ai/Face/examples/v1.2-preview.1/FaceRecognitionOperations_FindSimilarFromFaceList.json b/specification/ai/Face/examples/v1.2-preview.1/FaceRecognitionOperations_FindSimilarFromFaceList.json index 51ce1f313f3f..449c55df841c 100644 --- a/specification/ai/Face/examples/v1.2-preview.1/FaceRecognitionOperations_FindSimilarFromFaceList.json +++ b/specification/ai/Face/examples/v1.2-preview.1/FaceRecognitionOperations_FindSimilarFromFaceList.json @@ -15,7 +15,7 @@ "body": [ { "confidence": 0.8, - "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" + "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" } ] } diff --git a/specification/ai/Face/examples/v1.2-preview.1/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json b/specification/ai/Face/examples/v1.2-preview.1/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json index bb96c52279da..d674cae778c4 100644 --- a/specification/ai/Face/examples/v1.2-preview.1/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json +++ b/specification/ai/Face/examples/v1.2-preview.1/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json @@ -15,7 +15,7 @@ "body": [ { "confidence": 0.8, - "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" + "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" } ] } diff --git a/specification/ai/data-plane/Face/preview/v1.1-preview.1/examples/FaceRecognitionOperations_FindSimilar.json b/specification/ai/data-plane/Face/preview/v1.1-preview.1/examples/FaceRecognitionOperations_FindSimilar.json index 3a78056208ca..3c2e1888aae2 100644 --- a/specification/ai/data-plane/Face/preview/v1.1-preview.1/examples/FaceRecognitionOperations_FindSimilar.json +++ b/specification/ai/data-plane/Face/preview/v1.1-preview.1/examples/FaceRecognitionOperations_FindSimilar.json @@ -18,7 +18,7 @@ "body": [ { "confidence": 0.9, - "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" + "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" } ] } diff --git a/specification/ai/data-plane/Face/preview/v1.1-preview.1/examples/FaceRecognitionOperations_FindSimilarFromFaceList.json b/specification/ai/data-plane/Face/preview/v1.1-preview.1/examples/FaceRecognitionOperations_FindSimilarFromFaceList.json index 7c761424783e..14d0102042cb 100644 --- a/specification/ai/data-plane/Face/preview/v1.1-preview.1/examples/FaceRecognitionOperations_FindSimilarFromFaceList.json +++ b/specification/ai/data-plane/Face/preview/v1.1-preview.1/examples/FaceRecognitionOperations_FindSimilarFromFaceList.json @@ -15,7 +15,7 @@ "body": [ { "confidence": 0.8, - "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" + "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" } ] } diff --git a/specification/ai/data-plane/Face/preview/v1.1-preview.1/examples/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json b/specification/ai/data-plane/Face/preview/v1.1-preview.1/examples/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json index f83d2ed8e685..620468719ce8 100644 --- a/specification/ai/data-plane/Face/preview/v1.1-preview.1/examples/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json +++ b/specification/ai/data-plane/Face/preview/v1.1-preview.1/examples/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json @@ -15,7 +15,7 @@ "body": [ { "confidence": 0.8, - "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" + "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" } ] } diff --git a/specification/ai/data-plane/Face/preview/v1.2-preview.1/examples/FaceRecognitionOperations_FindSimilar.json b/specification/ai/data-plane/Face/preview/v1.2-preview.1/examples/FaceRecognitionOperations_FindSimilar.json index 4f8b4c6643a9..1b9a4ac529a0 100644 --- a/specification/ai/data-plane/Face/preview/v1.2-preview.1/examples/FaceRecognitionOperations_FindSimilar.json +++ b/specification/ai/data-plane/Face/preview/v1.2-preview.1/examples/FaceRecognitionOperations_FindSimilar.json @@ -18,7 +18,7 @@ "body": [ { "confidence": 0.9, - "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" + "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" } ] } diff --git a/specification/ai/data-plane/Face/preview/v1.2-preview.1/examples/FaceRecognitionOperations_FindSimilarFromFaceList.json b/specification/ai/data-plane/Face/preview/v1.2-preview.1/examples/FaceRecognitionOperations_FindSimilarFromFaceList.json index 51ce1f313f3f..449c55df841c 100644 --- a/specification/ai/data-plane/Face/preview/v1.2-preview.1/examples/FaceRecognitionOperations_FindSimilarFromFaceList.json +++ b/specification/ai/data-plane/Face/preview/v1.2-preview.1/examples/FaceRecognitionOperations_FindSimilarFromFaceList.json @@ -15,7 +15,7 @@ "body": [ { "confidence": 0.8, - "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" + "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" } ] } diff --git a/specification/ai/data-plane/Face/preview/v1.2-preview.1/examples/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json b/specification/ai/data-plane/Face/preview/v1.2-preview.1/examples/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json index bb96c52279da..d674cae778c4 100644 --- a/specification/ai/data-plane/Face/preview/v1.2-preview.1/examples/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json +++ b/specification/ai/data-plane/Face/preview/v1.2-preview.1/examples/FaceRecognitionOperations_FindSimilarFromLargeFaceList.json @@ -15,7 +15,7 @@ "body": [ { "confidence": 0.8, - "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" + "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9" } ] } diff --git a/specification/app/Microsoft.App.DynamicSessions/client.tsp b/specification/app/Microsoft.App.DynamicSessions/client.tsp new file mode 100644 index 000000000000..164fc28c837f --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/client.tsp @@ -0,0 +1,5 @@ +/** + * PLACEHOLDER + * Add readme and sample + */ +import "./main.tsp"; diff --git a/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Execute_Async_Completed.json b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Execute_Async_Completed.json new file mode 100644 index 000000000000..cbbe2ea65c15 --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Execute_Async_Completed.json @@ -0,0 +1,37 @@ +{ + "title": "CodeExecution_Execute_Async_Completed", + "operationId": "CodeExecution_Execute", + "headers": { + "operation-id": "testExecutionId" + }, + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "codeExecutionRequest": { + "codeInputType": "Inline", + "executionType": "Asynchronous", + "code": "print(7*9)", + "timeoutInSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "operation-id": "testExecutionId", + "Operation-Location": "operation-location-uri" + }, + "body": { + "id": "testExecutionId", + "identifier": "testSessionIdentifier", + "executionType": "Asynchronous", + "status": "Succeeded", + "result": { + "stdout": "63/n", + "stderr": "", + "executionResult": "", + "executionTimeInMilliseconds": 4 + } + } + } + } +} diff --git a/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Execute_Async_Running.json b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Execute_Async_Running.json new file mode 100644 index 000000000000..3c3ac68b7d66 --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Execute_Async_Running.json @@ -0,0 +1,31 @@ +{ + "title": "CodeExecution_Execute_Async_Running", + "operationId": "CodeExecution_Execute", + "headers": { + "operation-id": "testExecutionId" + }, + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "codeExecutionRequest": { + "codeInputType": "Inline", + "executionType": "Asynchronous", + "code": "print(7*9)", + "timeoutInSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "operation-id": "testExecutionId", + "Operation-Location": "operation-location-uri" + }, + "body": { + "id": "testExecutionId", + "identifier": "testSessionIdentifier", + "executionType": "Asynchronous", + "status": "Running" + } + } + } +} diff --git a/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Execute_Sync.json b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Execute_Sync.json new file mode 100644 index 000000000000..8eef84622944 --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Execute_Sync.json @@ -0,0 +1,34 @@ +{ + "title": "CodeExecution_Execute_Sync", + "operationId": "CodeExecution_Execute", + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "codeExecutionRequest": { + "codeInputType": "Inline", + "executionType": "Synchronous", + "code": "print(7*9)", + "timeoutInSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "operation-id": "testExecutionId", + "Operation-Location": "operation-location-uri" + }, + "body": { + "id": "testExecutionId", + "identifier": "testSessionIdentifier", + "executionType": "Asynchronous", + "status": "Succeeded", + "result": { + "stdout": "63/n", + "stderr": "", + "executionResult": "", + "executionTimeInMilliseconds": 4 + } + } + } + } +} diff --git a/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Get_Completed.json b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Get_Completed.json new file mode 100644 index 000000000000..15f98d68ae12 --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Get_Completed.json @@ -0,0 +1,25 @@ +{ + "title": "CodeExecution_Get_Completed", + "operationId": "CodeExecution_Get", + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "executionId": "testExecutionId" + }, + "responses": { + "200": { + "body": { + "id": "testExecutionId", + "identifier": "testSessionIdentifier", + "executionType": "Asynchronous", + "status": "Succeeded", + "result": { + "stdout": "63/n", + "stderr": "", + "executionResult": "", + "executionTimeInMilliseconds": 4 + } + } + } + } +} diff --git a/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Get_Running.json b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Get_Running.json new file mode 100644 index 000000000000..8629dafc57c3 --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/CodeExecution_Get_Running.json @@ -0,0 +1,19 @@ +{ + "title": "CodeExecution_Get_Running", + "operationId": "CodeExecution_Get", + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "executionId": "testExecutionId" + }, + "responses": { + "200": { + "body": { + "id": "testExecutionId", + "identifier": "testSessionIdentifier", + "executionType": "Asynchronous", + "status": "Running" + } + } + } +} diff --git a/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_Delete.json b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_Delete.json new file mode 100644 index 000000000000..12ca116d5c8e --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_Delete.json @@ -0,0 +1,13 @@ +{ + "title": "SessionResourceFiles_Delete", + "operationId": "SessionResourceFiles_Delete", + "parameters": { + "api-version": "2024-10-02-preview", + "name": "testfile", + "identifier": "testSessionIdentifier", + "path": "/" + }, + "responses": { + "204": {} + } +} diff --git a/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_Get.json b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_Get.json new file mode 100644 index 000000000000..01bd73147c15 --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_Get.json @@ -0,0 +1,21 @@ +{ + "title": "SessionResourceFiles_Get", + "operationId": "SessionResourceFiles_Get", + "parameters": { + "api-version": "2024-10-02-preview", + "name": "testfile", + "identifier": "testSessionIdentifier", + "path": "/" + }, + "responses": { + "200": { + "body": { + "name": "testfile.yaml", + "type": "File", + "contentType": "application/yaml", + "sizeInBytes": 4, + "lastModifiedAt": "2024-05-29T02:17:25.902Z" + } + } + } +} diff --git a/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_GetContent.json b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_GetContent.json new file mode 100644 index 000000000000..b283d41ac31f --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_GetContent.json @@ -0,0 +1,15 @@ +{ + "title": "SessionResourceFiles_GetContent", + "operationId": "SessionResourceFiles_GetContent", + "parameters": { + "api-version": "2024-10-02-preview", + "name": "testfile", + "identifier": "testSessionIdentifier", + "path": "/" + }, + "responses": { + "200": { + "body": "testfilecontent" + } + } +} diff --git a/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_List.json b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_List.json new file mode 100644 index 000000000000..5202d0d708c7 --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_List.json @@ -0,0 +1,30 @@ +{ + "title": "SessionResourceFiles_List", + "operationId": "SessionResourceFiles_List", + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "path": "/" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testfile.yaml", + "type": "File", + "contentType": "application/yaml", + "sizeInBytes": 4, + "lastModifiedAt": "2024-05-29T00:00:00.000Z" + }, + { + "name": "test-directory", + "type": "Directory", + "lastModifiedAt": "2024-04-29T00:00:00.000Z" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_Upload.json b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_Upload.json new file mode 100644 index 000000000000..22ba4e27d37f --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/examples/2024-10-02-preview/SessionResourceFiles_Upload.json @@ -0,0 +1,21 @@ +{ + "title": "SessionResourceFiles_Upload", + "operationId": "SessionResourceFiles_Upload", + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "path": "/", + "file": "101010101" + }, + "responses": { + "200": { + "body": { + "name": "testfile.yaml", + "type": "File", + "contentType": "application/yaml", + "sizeInBytes": 4, + "lastModifiedAt": "2024-05-29T02:17:25.902Z" + } + } + } +} diff --git a/specification/app/Microsoft.App.DynamicSessions/main.tsp b/specification/app/Microsoft.App.DynamicSessions/main.tsp new file mode 100644 index 000000000000..305be3bf5140 --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/main.tsp @@ -0,0 +1,31 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "./routes.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; + +@useAuth(AadOauth2Auth<["https://dynamicsessions.io/.default"]>) +@service({ + title: "Microsoft.App Dynamic Sessions service", +}) +@server( + "{endpoint}", + "Session pool management endpoint.", + { + @doc("The management endpoint of the session pool.") + endpoint: string, + } +) +@versioned(Microsoft.App.DynamicSessions.Versions) +namespace Microsoft.App.DynamicSessions; + +@doc("The Microsoft.App Dynamic Sessions service versions.") +enum Versions { + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @doc("The 2024-10-02-preview version of the Microsoft.App Dynamic Sessions service.") + `2024-10-02-preview`, +} diff --git a/specification/app/Microsoft.App.DynamicSessions/models/code-execution-file.tsp b/specification/app/Microsoft.App.DynamicSessions/models/code-execution-file.tsp new file mode 100644 index 000000000000..d17d1b5ad31c --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/models/code-execution-file.tsp @@ -0,0 +1,33 @@ +import "./common.tsp"; +using TypeSpec.Http; +using TypeSpec.Rest; + +namespace Microsoft.App.DynamicSessions; + +@doc("Code execution file resource collection.") +model SessionResourceFileCollection { + @doc("The files uploaded.") + value: SessionResourceFile[]; +} + +@doc("Code execution file resource.") +@resource("files") +model SessionResourceFile { + @key("name") + @segment("files") + @doc("The name of the file.") + @visibility("read", "query", "create", "update", "delete") + name: string; + + @doc("The type of the session resource file.") + type: string; + + @doc("The type of the content of this file.") + contentType?: string; + + @doc("The size of the file.") + sizeInBytes?: int64; + + @doc("The date time in RFC3339 format when the file was last modified.") + lastModifiedAt: utcDateTime; +} diff --git a/specification/app/Microsoft.App.DynamicSessions/models/code-execution.tsp b/specification/app/Microsoft.App.DynamicSessions/models/code-execution.tsp new file mode 100644 index 000000000000..e8ba600901b2 --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/models/code-execution.tsp @@ -0,0 +1,86 @@ +import "./common.tsp"; +using Azure.Core; +using TypeSpec.Http; +using TypeSpec.Rest; + +namespace Microsoft.App.DynamicSessions; + +@doc("The request to execute code.") +model SessionCodeExecutionRequest { + @doc("The code input type of the code execution request.") + codeInputType: CodeInputType; + + @doc("The execution type of the code execution request.") + executionType: ExecutionType; + + @doc("The string of the code to execute, based on CodeInputType.") + code: string; + + @doc("Code execution timeout in seconds.") + timeoutInSeconds: int64; +} + +@doc("The result of the code execution.") +model SessionCodeExecutionResult { + @doc("The standard output of the code execution.") + stdout?: string; + + @doc("The standard error of the code execution.") + stderr?: string; + + #suppress "@azure-tools/typespec-azure-core/no-unknown" "The type of this field depends on the code execution result." + @doc("The result of the code execution. The type of this field is same as the type of actual result of the code execution after being Json serialized.") + executionResult?: unknown; + + @doc("The execution time of the code in milliseconds.") + executionTimeInMilliseconds?: int64; +} + +@doc("The session code execution resource.") +@resource("executions") +model SessionCodeExecutionResource { + @visibility("read") + @doc("Session code execution id.") + @key("executionId") + id: string; + + @doc("The identifier of the session.") + identifier: string; + + @doc("The execution type of the code execution request.") + executionType: ExecutionType; + + @doc("The status of the code execution operation, indicates whether succeeded or not.") + status: Foundations.OperationState; + + @doc("The error of this code execution if failed.") + error?: Foundations.ErrorResponse; + + @doc("The result of this code execution operation.") + result?: SessionCodeExecutionResult; +} + +@doc("Code input type.") +union CodeInputType { + string, + + @doc("Inline.") + inline: "Inline", + + @doc("InlineBase64.") + inlineBase64: "InlineBase64", + + @doc("InlineText.") + inlineText: "InlineText", +} + +@doc("Execution Type") +union ExecutionType { + string, + + @doc("Synchronous") + synchronous: "Synchronous", + + @doc("Asynchronous") + asynchronous: "Asynchronous", +} diff --git a/specification/app/Microsoft.App.DynamicSessions/models/common.tsp b/specification/app/Microsoft.App.DynamicSessions/models/common.tsp new file mode 100644 index 000000000000..4ac4342e7f6f --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/models/common.tsp @@ -0,0 +1,46 @@ +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.Core; +using TypeSpec.Http; +using TypeSpec.Rest; + +namespace Microsoft.App.DynamicSessions; +using OpenAPI; + +@doc("The optional execution id header.") +model ExecutionOperationIdHeader { + @header + @doc("The id of this execution operation.") + operationId?: string; +} + +@doc("Session identifier query parameter.") +model SessionIdentifier { + @doc("The user-assigned identifier of the session.") + @query + @minLength(1) + @maxLength(256) + @pattern("^[A-Za-z0-9-_]{1,256}$") + identifier: string; +} + +@doc("Session code execution identifier path parameter.") +model CodeExecutionIdentifier { + @doc("The identifier of code execution.") + @path + executionId: string; +} + +@doc("The session resource file path parameter.") +model SessionResourceFilePathQueryParameter { + @doc("The path of the file after uploaded.") + @query + path?: string; +} + +@doc("The session resource file name parameter.") +model SessionResourceFileNamePathParameter { + @doc("The name of the file.") + @path + name: string; +} diff --git a/specification/app/Microsoft.App.DynamicSessions/routes.tsp b/specification/app/Microsoft.App.DynamicSessions/routes.tsp new file mode 100644 index 000000000000..47b22ad5193f --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/routes.tsp @@ -0,0 +1,94 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "./main.tsp"; +import "./models/code-execution.tsp"; +import "./models/code-execution-file.tsp"; +import "./models/common.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; + +namespace Microsoft.App.DynamicSessions; + +alias BaseOperationTraits = NoRepeatableRequests & + NoConditionalRequests & + NoClientRequestId; + +alias CodeExecutionTraits = BaseOperationTraits & + QueryParametersTrait; +alias CodeExecutionOperations = Azure.Core.ResourceOperations; + +interface CodeExecution { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "No suitable standard operation found." + @doc("Execute code in a session.") + @route("/executions") + @pollingOperation(CodeExecution.get) + execute is Foundations.Operation< + { + ...SessionIdentifier; + ...ExecutionOperationIdHeader; + + @doc("The request to execute code.") + @body + codeExecutionRequest: SessionCodeExecutionRequest; + }, + AcceptedResponse & + SessionCodeExecutionResource & + ExecutionOperationIdHeader & + Foundations.LongRunningStatusLocation + >; + + @doc("Get the code execution result.") + get is CodeExecutionOperations.ResourceRead; +} + +alias SessionResourceFilesTraits = BaseOperationTraits & + QueryParametersTrait<{ + ...SessionIdentifier; + ...SessionResourceFilePathQueryParameter; + }>; +alias SessionResourceFilesOperations = Azure.Core.ResourceOperations; + +interface SessionResourceFiles { + @doc("List the file resources.") + list is SessionResourceFilesOperations.ResourceList; + + @doc("Get the file resource.") + get is SessionResourceFilesOperations.ResourceRead; + + @doc("Delete the file.") + delete is SessionResourceFilesOperations.ResourceDelete; + + #suppress "@azure-tools/typespec-azure-core/byos" "Storage service is not used" + @doc("Upload a file to a session.") + @route("/files") + upload is RpcOperation< + { + @doc("The content type for the operation. Always multipart/form-data for this operation.") + @header("content-type") + contentType: "multipart/form-data"; + + @doc("The file to upload.") + file: bytes; + }, + SessionResourceFile, + SessionResourceFilesTraits + >; + + #suppress "@azure-tools/typespec-azure-core/verb-conflict" "GET allowed on Action" + @doc("Get the content of the file.") + @get + @action("content") + @actionSeparator("/") + getContent is SessionResourceFilesOperations.ResourceAction< + SessionResourceFile, + {}, + { + @body _: bytes; + } + >; +} diff --git a/specification/app/Microsoft.App.DynamicSessions/tspconfig.yaml b/specification/app/Microsoft.App.DynamicSessions/tspconfig.yaml new file mode 100644 index 000000000000..88dadf1b5214 --- /dev/null +++ b/specification/app/Microsoft.App.DynamicSessions/tspconfig.yaml @@ -0,0 +1,39 @@ +parameters: + "service-dir": + default: "sdk/microsoft.app" + "dependencies": + "additionalDirectories": [] + default: "" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" + emitter-output-dir: "{project-root}/.." + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/DynamicSessions.json" + "@azure-tools/typespec-python": + package-dir: "microsoft-app-dynamicsessions" + package-name: "{package-dir}" + package-mode: dataplane + flavor: azure + "@azure-tools/typespec-csharp": + package-dir: "Microsoft.App.DynamicSessions" + namespace: "{package-dir}" + clear-output-folder: true + model-namespace: false + flavor: azure + "@azure-tools/typespec-ts": + package-dir: "microsoft-app-dynamicsessions-rest" + generateMetadata: true + generateTest: true + packageDetails: + name: "@azure-rest/microsoft-app-dynamicsessions-rest" + description: "Microsoft.App Dynamic Sessions Service" + flavor: azure + "@azure-tools/typespec-java": + package-dir: "microsoft-app-dynamicsessions" + namespace: com.microsoft.app.dynamicsessions + flavor: azure +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/data-plane" diff --git a/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/DynamicSessions.json b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/DynamicSessions.json new file mode 100644 index 000000000000..79e7bbe29d82 --- /dev/null +++ b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/DynamicSessions.json @@ -0,0 +1,815 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.App Dynamic Sessions service", + "version": "2024-10-02-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "The management endpoint of the session pool.", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "AadOauth2Auth": [ + "https://dynamicsessions.io/.default" + ] + } + ], + "securityDefinitions": { + "AadOauth2Auth": { + "type": "oauth2", + "description": "The Azure Active Directory OAuth2 Flow", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://dynamicsessions.io/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [], + "paths": { + "/executions": { + "post": { + "operationId": "CodeExecution_Execute", + "description": "Execute code in a session.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/SessionIdentifier" + }, + { + "$ref": "#/parameters/ExecutionOperationIdHeader" + }, + { + "name": "codeExecutionRequest", + "in": "body", + "description": "The request to execute code.", + "required": true, + "schema": { + "$ref": "#/definitions/SessionCodeExecutionRequest" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/SessionCodeExecutionResource" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "operation-id": { + "type": "string", + "description": "The id of this execution operation." + }, + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "CodeExecution_Execute_Async_Completed": { + "$ref": "./examples/CodeExecution_Execute_Async_Completed.json" + }, + "CodeExecution_Execute_Async_Running": { + "$ref": "./examples/CodeExecution_Execute_Async_Running.json" + }, + "CodeExecution_Execute_Sync": { + "$ref": "./examples/CodeExecution_Execute_Sync.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location" + }, + "x-ms-long-running-operation": true + } + }, + "/executions/{executionId}": { + "get": { + "operationId": "CodeExecution_Get", + "description": "Get the code execution result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "executionId", + "in": "path", + "description": "Session code execution id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SessionIdentifier" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionCodeExecutionResource" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "CodeExecution_Get_Completed": { + "$ref": "./examples/CodeExecution_Get_Completed.json" + }, + "CodeExecution_Get_Running": { + "$ref": "./examples/CodeExecution_Get_Running.json" + } + } + } + }, + "/files": { + "get": { + "operationId": "SessionResourceFiles_List", + "description": "List the file resources.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/SessionIdentifier" + }, + { + "$ref": "#/parameters/SessionResourceFilePathQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedSessionResourceFile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SessionResourceFiles_List": { + "$ref": "./examples/SessionResourceFiles_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + }, + "post": { + "operationId": "SessionResourceFiles_Upload", + "description": "Upload a file to a session.", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/SessionIdentifier" + }, + { + "$ref": "#/parameters/SessionResourceFilePathQueryParameter" + }, + { + "name": "file", + "in": "formData", + "description": "The file to upload.", + "required": true, + "type": "file" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionResourceFile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SessionResourceFiles_Upload": { + "$ref": "./examples/SessionResourceFiles_Upload.json" + } + } + } + }, + "/files/{name}": { + "get": { + "operationId": "SessionResourceFiles_Get", + "description": "Get the file resource.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SessionIdentifier" + }, + { + "$ref": "#/parameters/SessionResourceFilePathQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionResourceFile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SessionResourceFiles_Get": { + "$ref": "./examples/SessionResourceFiles_Get.json" + } + } + }, + "delete": { + "operationId": "SessionResourceFiles_Delete", + "description": "Delete the file.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SessionIdentifier" + }, + { + "$ref": "#/parameters/SessionResourceFilePathQueryParameter" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SessionResourceFiles_Delete": { + "$ref": "./examples/SessionResourceFiles_Delete.json" + } + } + } + }, + "/files/{name}/content": { + "get": { + "operationId": "SessionResourceFiles_GetContent", + "description": "Get the content of the file.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SessionIdentifier" + }, + { + "$ref": "#/parameters/SessionResourceFilePathQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string", + "format": "byte" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SessionResourceFiles_GetContent": { + "$ref": "./examples/SessionResourceFiles_GetContent.json" + } + } + } + } + }, + "definitions": { + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "Azure.Core.Foundations.OperationState": { + "type": "string", + "description": "Enum describing allowed operation states.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The operation has not started." + }, + { + "name": "Running", + "value": "Running", + "description": "The operation is in progress." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The operation has completed successfully." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The operation has failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The operation has been canceled by the user." + } + ] + } + }, + "CodeExecutionIdentifier": { + "type": "object", + "description": "Session code execution identifier path parameter.", + "properties": { + "executionId": { + "type": "string", + "description": "The identifier of code execution." + } + }, + "required": [ + "executionId" + ] + }, + "CodeInputType": { + "type": "string", + "description": "Code input type.", + "enum": [ + "Inline", + "InlineBase64", + "InlineText" + ], + "x-ms-enum": { + "name": "CodeInputType", + "modelAsString": true, + "values": [ + { + "name": "inline", + "value": "Inline", + "description": "Inline." + }, + { + "name": "inlineBase64", + "value": "InlineBase64", + "description": "InlineBase64." + }, + { + "name": "inlineText", + "value": "InlineText", + "description": "InlineText." + } + ] + } + }, + "ExecutionType": { + "type": "string", + "description": "Execution Type", + "enum": [ + "Synchronous", + "Asynchronous" + ], + "x-ms-enum": { + "name": "ExecutionType", + "modelAsString": true, + "values": [ + { + "name": "synchronous", + "value": "Synchronous", + "description": "Synchronous" + }, + { + "name": "asynchronous", + "value": "Asynchronous", + "description": "Asynchronous" + } + ] + } + }, + "PagedSessionResourceFile": { + "type": "object", + "description": "Paged collection of SessionResourceFile items", + "properties": { + "value": { + "type": "array", + "description": "The SessionResourceFile items on this page", + "items": { + "$ref": "#/definitions/SessionResourceFile" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SessionCodeExecutionRequest": { + "type": "object", + "description": "The request to execute code.", + "properties": { + "codeInputType": { + "$ref": "#/definitions/CodeInputType", + "description": "The code input type of the code execution request." + }, + "executionType": { + "$ref": "#/definitions/ExecutionType", + "description": "The execution type of the code execution request." + }, + "code": { + "type": "string", + "description": "The string of the code to execute, based on CodeInputType." + }, + "timeoutInSeconds": { + "type": "integer", + "format": "int64", + "description": "Code execution timeout in seconds." + } + }, + "required": [ + "codeInputType", + "executionType", + "code", + "timeoutInSeconds" + ] + }, + "SessionCodeExecutionResource": { + "type": "object", + "description": "The session code execution resource.", + "properties": { + "id": { + "type": "string", + "description": "Session code execution id.", + "readOnly": true + }, + "identifier": { + "type": "string", + "description": "The identifier of the session." + }, + "executionType": { + "$ref": "#/definitions/ExecutionType", + "description": "The execution type of the code execution request." + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "The status of the code execution operation, indicates whether succeeded or not." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse", + "description": "The error of this code execution if failed." + }, + "result": { + "$ref": "#/definitions/SessionCodeExecutionResult", + "description": "The result of this code execution operation." + } + }, + "required": [ + "id", + "identifier", + "executionType", + "status" + ] + }, + "SessionCodeExecutionResult": { + "type": "object", + "description": "The result of the code execution.", + "properties": { + "stdout": { + "type": "string", + "description": "The standard output of the code execution." + }, + "stderr": { + "type": "string", + "description": "The standard error of the code execution." + }, + "executionResult": { + "description": "The result of the code execution. The type of this field is same as the type of actual result of the code execution after being Json serialized." + }, + "executionTimeInMilliseconds": { + "type": "integer", + "format": "int64", + "description": "The execution time of the code in milliseconds." + } + } + }, + "SessionResourceFile": { + "type": "object", + "description": "Code execution file resource.", + "properties": { + "name": { + "type": "string", + "description": "The name of the file.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "type": { + "type": "string", + "description": "The type of the session resource file." + }, + "contentType": { + "type": "string", + "description": "The type of the content of this file." + }, + "sizeInBytes": { + "type": "integer", + "format": "int64", + "description": "The size of the file." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The date time in RFC3339 format when the file was last modified." + } + }, + "required": [ + "name", + "type", + "lastModifiedAt" + ] + }, + "SessionResourceFileCollection": { + "type": "object", + "description": "Code execution file resource collection.", + "properties": { + "value": { + "type": "array", + "description": "The files uploaded.", + "items": { + "$ref": "#/definitions/SessionResourceFile" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ] + }, + "SessionResourceFileNamePathParameter": { + "type": "object", + "description": "The session resource file name parameter.", + "properties": { + "name": { + "type": "string", + "description": "The name of the file." + } + }, + "required": [ + "name" + ] + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "ExecutionOperationIdHeader": { + "name": "operation-id", + "in": "header", + "description": "The id of this execution operation.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-client-name": "operationId" + }, + "SessionIdentifier": { + "name": "identifier", + "in": "query", + "description": "The user-assigned identifier of the session.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-_]{1,256}$", + "x-ms-parameter-location": "method" + }, + "SessionResourceFilePathQueryParameter": { + "name": "path", + "in": "query", + "description": "The path of the file after uploaded.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Execute_Async_Completed.json b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Execute_Async_Completed.json new file mode 100644 index 000000000000..cbbe2ea65c15 --- /dev/null +++ b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Execute_Async_Completed.json @@ -0,0 +1,37 @@ +{ + "title": "CodeExecution_Execute_Async_Completed", + "operationId": "CodeExecution_Execute", + "headers": { + "operation-id": "testExecutionId" + }, + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "codeExecutionRequest": { + "codeInputType": "Inline", + "executionType": "Asynchronous", + "code": "print(7*9)", + "timeoutInSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "operation-id": "testExecutionId", + "Operation-Location": "operation-location-uri" + }, + "body": { + "id": "testExecutionId", + "identifier": "testSessionIdentifier", + "executionType": "Asynchronous", + "status": "Succeeded", + "result": { + "stdout": "63/n", + "stderr": "", + "executionResult": "", + "executionTimeInMilliseconds": 4 + } + } + } + } +} diff --git a/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Execute_Async_Running.json b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Execute_Async_Running.json new file mode 100644 index 000000000000..3c3ac68b7d66 --- /dev/null +++ b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Execute_Async_Running.json @@ -0,0 +1,31 @@ +{ + "title": "CodeExecution_Execute_Async_Running", + "operationId": "CodeExecution_Execute", + "headers": { + "operation-id": "testExecutionId" + }, + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "codeExecutionRequest": { + "codeInputType": "Inline", + "executionType": "Asynchronous", + "code": "print(7*9)", + "timeoutInSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "operation-id": "testExecutionId", + "Operation-Location": "operation-location-uri" + }, + "body": { + "id": "testExecutionId", + "identifier": "testSessionIdentifier", + "executionType": "Asynchronous", + "status": "Running" + } + } + } +} diff --git a/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Execute_Sync.json b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Execute_Sync.json new file mode 100644 index 000000000000..8eef84622944 --- /dev/null +++ b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Execute_Sync.json @@ -0,0 +1,34 @@ +{ + "title": "CodeExecution_Execute_Sync", + "operationId": "CodeExecution_Execute", + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "codeExecutionRequest": { + "codeInputType": "Inline", + "executionType": "Synchronous", + "code": "print(7*9)", + "timeoutInSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "operation-id": "testExecutionId", + "Operation-Location": "operation-location-uri" + }, + "body": { + "id": "testExecutionId", + "identifier": "testSessionIdentifier", + "executionType": "Asynchronous", + "status": "Succeeded", + "result": { + "stdout": "63/n", + "stderr": "", + "executionResult": "", + "executionTimeInMilliseconds": 4 + } + } + } + } +} diff --git a/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Get_Completed.json b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Get_Completed.json new file mode 100644 index 000000000000..15f98d68ae12 --- /dev/null +++ b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Get_Completed.json @@ -0,0 +1,25 @@ +{ + "title": "CodeExecution_Get_Completed", + "operationId": "CodeExecution_Get", + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "executionId": "testExecutionId" + }, + "responses": { + "200": { + "body": { + "id": "testExecutionId", + "identifier": "testSessionIdentifier", + "executionType": "Asynchronous", + "status": "Succeeded", + "result": { + "stdout": "63/n", + "stderr": "", + "executionResult": "", + "executionTimeInMilliseconds": 4 + } + } + } + } +} diff --git a/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Get_Running.json b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Get_Running.json new file mode 100644 index 000000000000..8629dafc57c3 --- /dev/null +++ b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/CodeExecution_Get_Running.json @@ -0,0 +1,19 @@ +{ + "title": "CodeExecution_Get_Running", + "operationId": "CodeExecution_Get", + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "executionId": "testExecutionId" + }, + "responses": { + "200": { + "body": { + "id": "testExecutionId", + "identifier": "testSessionIdentifier", + "executionType": "Asynchronous", + "status": "Running" + } + } + } +} diff --git a/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_Delete.json b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_Delete.json new file mode 100644 index 000000000000..12ca116d5c8e --- /dev/null +++ b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_Delete.json @@ -0,0 +1,13 @@ +{ + "title": "SessionResourceFiles_Delete", + "operationId": "SessionResourceFiles_Delete", + "parameters": { + "api-version": "2024-10-02-preview", + "name": "testfile", + "identifier": "testSessionIdentifier", + "path": "/" + }, + "responses": { + "204": {} + } +} diff --git a/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_Get.json b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_Get.json new file mode 100644 index 000000000000..01bd73147c15 --- /dev/null +++ b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_Get.json @@ -0,0 +1,21 @@ +{ + "title": "SessionResourceFiles_Get", + "operationId": "SessionResourceFiles_Get", + "parameters": { + "api-version": "2024-10-02-preview", + "name": "testfile", + "identifier": "testSessionIdentifier", + "path": "/" + }, + "responses": { + "200": { + "body": { + "name": "testfile.yaml", + "type": "File", + "contentType": "application/yaml", + "sizeInBytes": 4, + "lastModifiedAt": "2024-05-29T02:17:25.902Z" + } + } + } +} diff --git a/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_GetContent.json b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_GetContent.json new file mode 100644 index 000000000000..b283d41ac31f --- /dev/null +++ b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_GetContent.json @@ -0,0 +1,15 @@ +{ + "title": "SessionResourceFiles_GetContent", + "operationId": "SessionResourceFiles_GetContent", + "parameters": { + "api-version": "2024-10-02-preview", + "name": "testfile", + "identifier": "testSessionIdentifier", + "path": "/" + }, + "responses": { + "200": { + "body": "testfilecontent" + } + } +} diff --git a/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_List.json b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_List.json new file mode 100644 index 000000000000..5202d0d708c7 --- /dev/null +++ b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_List.json @@ -0,0 +1,30 @@ +{ + "title": "SessionResourceFiles_List", + "operationId": "SessionResourceFiles_List", + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "path": "/" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testfile.yaml", + "type": "File", + "contentType": "application/yaml", + "sizeInBytes": 4, + "lastModifiedAt": "2024-05-29T00:00:00.000Z" + }, + { + "name": "test-directory", + "type": "Directory", + "lastModifiedAt": "2024-04-29T00:00:00.000Z" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_Upload.json b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_Upload.json new file mode 100644 index 000000000000..22ba4e27d37f --- /dev/null +++ b/specification/app/data-plane/Microsoft.App.DynamicSessions/preview/2024-10-02-preview/examples/SessionResourceFiles_Upload.json @@ -0,0 +1,21 @@ +{ + "title": "SessionResourceFiles_Upload", + "operationId": "SessionResourceFiles_Upload", + "parameters": { + "api-version": "2024-10-02-preview", + "identifier": "testSessionIdentifier", + "path": "/", + "file": "101010101" + }, + "responses": { + "200": { + "body": { + "name": "testfile.yaml", + "type": "File", + "contentType": "application/yaml", + "sizeInBytes": 4, + "lastModifiedAt": "2024-05-29T02:17:25.902Z" + } + } + } +} diff --git a/specification/app/data-plane/readme.md b/specification/app/data-plane/readme.md new file mode 100644 index 000000000000..6fc752bc4276 --- /dev/null +++ b/specification/app/data-plane/readme.md @@ -0,0 +1,51 @@ +# Container Apps Data Plane Api + +> see https://aka.ms/autorest +This is the AutoRest configuration file for Container Apps Data Plane Api. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` +To see additional help and options, run: + +> `autorest --help` +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the Container Apps Data Plane Api. + +```yaml +openapi-type: data-plane +tag: package-2024-10-02-preview +``` +### Tag: package-2024-10-02-preview +These settings apply only when `--tag=package-2024-10-02-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-10-02-preview' +input-file: + - Microsoft.App.DynamicSessions/preview/2024-10-02-preview/DynamicSessions.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-js + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-net-track2 +``` \ No newline at end of file diff --git a/specification/appconfiguration/resource-manager/readme.python.md b/specification/appconfiguration/resource-manager/readme.python.md index 5a7946f21271..9ba436ef9e68 100644 --- a/specification/appconfiguration/resource-manager/readme.python.md +++ b/specification/appconfiguration/resource-manager/readme.python.md @@ -1,74 +1,20 @@ ## Python These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. ``` yaml $(python) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-appconfiguration -package-version: 1.0.0b1 -no-namespace-folders: true +namespace: azure.mgmt.appconfiguration +package-version: 4.0.0 +clear-output-folder: true modelerfour: lenient-model-deduplication: true ``` -### Python multi-api - -Generate all API versions currently shipped for this package - -```yaml $(python) -clear-output-folder: true -default-api-version: "2024-05-01" -multiapi: true -batch: - - tag: package-2024-05-01 - - tag: package-2023-03-01 - - tag: package-2022-05-01 - - tag: package-2022-03-01-preview - - multiapiscript: true -``` - -``` yaml $(multiapiscript) -output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration/ -perform-load: false -``` - -### Tag: package-2024-05-01 and python - -These settings apply only when `--tag=package-2024-05-01 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2024-05-01' && $(python) -namespace: azure.mgmt.appconfiguration.v2024_05_01 -output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration/v2024_05_01 -``` - -### Tag: package-2023-03-01 and python - -These settings apply only when `--tag=package-2023-03-01 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-03-01' && $(python) -namespace: azure.mgmt.appconfiguration.v2023_03_01 -output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration/v2023_03_01 -``` - -### Tag: package-2022-05-01 and python - -These settings apply only when `--tag=package-2022-05-01 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2022-05-01' && $(python) -namespace: azure.mgmt.appconfiguration.v2022_05_01 -output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration/v2022_05_01 -``` - -### Tag: package-2022-03-01-preview and python - -These settings apply only when `--tag=package-2022-03-01-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2022-03-01-preview' && $(python) -namespace: azure.mgmt.appconfiguration.v2022_03_01_preview -output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration/v2022_03_01_preview +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration ``` diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/cancel_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/cancel_finetuning_job.json index 83811b0e9065..f902d857bd91 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/cancel_finetuning_job.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/cancel_finetuning_job.json @@ -22,4 +22,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/delete_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/delete_file.json index 4fb91291fd3c..9d2e06d1fa50 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/delete_file.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/delete_file.json @@ -10,4 +10,4 @@ "headers": {} } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/delete_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/delete_finetuning_job.json index a788c24e47b3..29efbdff14b4 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/delete_finetuning_job.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/delete_finetuning_job.json @@ -10,4 +10,4 @@ "headers": {} } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_file.json index ea6339deba5c..0d74e8052255 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_file.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_file.json @@ -19,4 +19,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_file_content.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_file_content.json index e31be11da315..c1e4df504792 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_file_content.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_file_content.json @@ -11,4 +11,4 @@ "body": "raw file content" } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_files.json index 421374119560..f7092eaff908 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_files.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_files.json @@ -32,4 +32,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_job.json index a6bd87680089..6096bbb45299 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_job.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_job.json @@ -27,4 +27,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_job_checkpoints.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_job_checkpoints.json index 1ffed7fab52b..6d352cccbde0 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_job_checkpoints.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_job_checkpoints.json @@ -67,4 +67,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_job_events.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_job_events.json index 0fb8afa0e9d7..d1f6b75a601e 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_job_events.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_job_events.json @@ -40,4 +40,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_jobs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_jobs.json index 922e91ffd57b..616141a0b657 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_jobs.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_finetuning_jobs.json @@ -32,4 +32,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_model_base.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_model_base.json index d57dbd72756d..6f31d2b2cbe3 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_model_base.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_model_base.json @@ -28,4 +28,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_model_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_model_finetune.json index baf98755d8ea..a4bdcaf43b8d 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_model_finetune.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_model_finetune.json @@ -29,4 +29,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_models.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_models.json index ae6e782994c2..ba5bdc06f564 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_models.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/get_models.json @@ -51,4 +51,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/import_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/import_file.json index 8226e80ed9cc..92b584263357 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/import_file.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/import_file.json @@ -25,4 +25,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/list_ingestion_jobs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/list_ingestion_jobs.json index 52863dd02de3..f44524f277ce 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/list_ingestion_jobs.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/list_ingestion_jobs.json @@ -1,22 +1,22 @@ { - "parameters": { - "api-version": "2024-05-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "jobId": "usercompute-ingestion-job", - "kind": "UserCompute", - "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev" - }, - { - "jobId": "syscompute-ingestion-job", - "kind": "SystemCompute" - } - ] - } - } - } -} \ No newline at end of file + "parameters": { + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobId": "usercompute-ingestion-job", + "kind": "UserCompute", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev" + }, + { + "jobId": "syscompute-ingestion-job", + "kind": "SystemCompute" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/post_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/post_finetuning_job.json index d1de4cb75b25..11acae427107 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/post_finetuning_job.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/post_finetuning_job.json @@ -27,4 +27,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/upload_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/upload_file.json index dd703192adc8..a06f28e97af9 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/upload_file.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/examples/upload_file.json @@ -22,4 +22,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md index 02c3e7e052ab..ec2c64450f43 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md @@ -350,6 +350,7 @@ directive: reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. ``` + ## AzureOpenAI 2024-08-01-preview These settings apply only when `--tag=release_2024_08_01_preview` is specified on the command line. @@ -409,4 +410,24 @@ directive: reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. - suppress: IntegerTypeMustHaveFormat reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. -``` \ No newline at end of file +``` + +## AzureOpenAI 2024-10-21 +These settings apply only when `--tag=release_2024_10_21` is specified on the command line. + +``` yaml $(tag) == 'release_2024_10_21' +input-file: stable/2024-10-21/azureopenai.json +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolved without breaking compatibility to existing openai api +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Existing external API uses property names like n_epochs, created_at, not following naming/casing guidelines from azure. + - suppress: ValidFormats + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. + - suppress: IntegerTypeMustHaveFormat + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. +``` diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.json index 2894b9a871c3..f0fbc801631a 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/azureopenai.json @@ -1733,7 +1733,7 @@ }, "security": [ { - "api-key": [ ] + "api-key": [] } ], "schemes": [ @@ -1748,4 +1748,4 @@ } ] } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_checkpoints.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_checkpoints.json index 6d7d387cf3dd..972e005e365f 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_checkpoints.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-06-01/examples/get_finetuning_job_checkpoints.json @@ -67,4 +67,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/azureopenai.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/azureopenai.json new file mode 100644 index 000000000000..3991078d97aa --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/azureopenai.json @@ -0,0 +1,2708 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI API version 2024-10-21", + "description": "APIs for fine-tuning and managing deployments of OpenAI models.", + "version": "2024-10-21" + }, + "paths": { + "/batches": { + "get": { + "tags": [ + "Batch:" + ], + "summary": "Gets a list of all batches owned by the Azure OpenAI resource.", + "operationId": "Batch_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of batches to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchesList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all batches owned by this account.": { + "$ref": "./examples/get_batches.json" + } + } + }, + "post": { + "tags": [ + "Batch:" + ], + "summary": "Creates and executes a batch from an uploaded file of requests.\r\nResponse includes details of the enqueued job including job status.\r\nThe ID of the result file is added to the response once complete.", + "operationId": "Batch_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "createBatchRequest", + "description": "The specification of the batch to create and execute.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchCreateRequest" + } + } + ], + "responses": { + "200": { + "description": "The batch has been successfully created.", + "schema": { + "$ref": "#/definitions/Batch" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creating a batch.": { + "$ref": "./examples/post_batch.json" + } + } + } + }, + "/batches/{batch-id}": { + "get": { + "tags": [ + "Batch:" + ], + "summary": "Gets details for a single batch specified by the given batch-id.", + "operationId": "Batch_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "batch-id", + "description": "The identifier of the batch.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Batch" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a batch.": { + "$ref": "./examples/get_batch.json" + } + } + } + }, + "/batches/{batch-id}/cancel": { + "post": { + "tags": [ + "Batch:" + ], + "summary": "Cancels the processing of the batch specified by the given batch-id.", + "operationId": "Batch_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "batch-id", + "description": "The identifier of the batch.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The batch has been successfully canceled.", + "schema": { + "$ref": "#/definitions/Batch" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Canceling a batch.": { + "$ref": "./examples/cancel_batch.json" + } + } + } + }, + "/files": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job.", + "operationId": "Files_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "purpose", + "description": "Only return files with the given purpose.", + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch", + "batch_output" + ], + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + }, + { + "value": "batch", + "description": "This file contains the input data for a batch." + }, + { + "value": "batch_output", + "description": "This file contains the results of a batch." + } + ] + } + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FileList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all files owned by this account.": { + "$ref": "./examples/get_files.json" + } + } + }, + "post": { + "tags": [ + "Files:" + ], + "summary": "Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models.", + "operationId": "Files_Upload", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "formData", + "name": "purpose", + "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.", + "required": true, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch" + ], + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + }, + { + "value": "batch", + "description": "This file contains the input data for a batch." + } + ] + } + }, + { + "in": "formData", + "name": "file", + "description": "Gets or sets the file to upload into Azure OpenAI.", + "required": true, + "type": "file" + } + ], + "responses": { + "201": { + "description": "The file has been successfully created.", + "schema": { + "$ref": "#/definitions/File" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upload a file.": { + "$ref": "./examples/upload_file.json" + } + } + } + }, + "/files/{file-id}": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets details for a single file specified by the given file-id including status, size, purpose, etc.", + "operationId": "Files_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a file.": { + "$ref": "./examples/get_file.json" + } + } + }, + "delete": { + "tags": [ + "Files:" + ], + "summary": "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job.", + "operationId": "Files_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The file was successfully deleted.", + "schema": { + "$ref": "#/definitions/FileDelete" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deleting a file.": { + "$ref": "./examples/delete_file.json" + } + } + } + }, + "/files/{file-id}/content": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job.", + "operationId": "Files_GetContent", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "file" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting the file content.": { + "$ref": "./examples/get_file_content.json" + } + } + } + }, + "/files/import": { + "post": { + "tags": [ + "Files:" + ], + "summary": "Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models.", + "operationId": "Files_Import", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fileImport", + "description": "The definition of the file to create including its purpose, the file name and the url of the file location.", + "required": true, + "schema": { + "$ref": "#/definitions/FileImport" + } + } + ], + "responses": { + "201": { + "description": "The file has been successfully created.", + "schema": { + "$ref": "#/definitions/File" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Importing a file with a blob url as source.": { + "$ref": "./examples/import_file.json" + } + } + } + }, + "/fine_tuning/jobs": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\r\nThe details that are returned for each fine-tune job contain besides its identifier\r\nthe base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of events to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all fine tuning jobs owned by this account.": { + "$ref": "./examples/get_finetuning_jobs.json" + } + } + }, + "post": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Creates a job that fine-tunes a specified model from a given training file.\r\nResponse includes details of the enqueued job including job status and hyper parameters.\r\nThe name of the fine-tuned model is added to the response once complete.", + "operationId": "FineTuning_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fineTuningJob", + "description": "The specification of the fine-tuned model to create.\r\nRequired parameters are the base model and the training file to use.\r\nOptionally a validation file can be specified to compute validation metrics during training.\r\nHyper parameters will be set to default values or can be optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others.", + "required": true, + "schema": { + "$ref": "#/definitions/FineTuningJobCreation" + } + } + ], + "responses": { + "201": { + "description": "The fine tune has been successfully created.", + "schema": { + "$ref": "#/definitions/FineTuningJob" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creating a fine tuning job.": { + "$ref": "./examples/post_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets details for a single fine-tune job specified by the given fine-tune-id.\r\nThe details contain the base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a fine tuning job.": { + "$ref": "./examples/get_finetuning_job.json" + } + } + }, + "delete": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Deletes the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTuning_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The fine tune was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deleting a fine tuning job.": { + "$ref": "./examples/delete_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/events": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets the events for the fine-tune job specified by the given fine-tune-id.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_GetEvents", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of events to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobEventList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting events of a fine tuning job.": { + "$ref": "./examples/get_finetuning_job_events.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.\r\nCheckpoints are created at the end of successful epochs during training.", + "operationId": "FineTuning_GetCheckpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "after", + "description": "Identifier for the last checkpoint ID from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of checkpoints to retrieve. Defaults to 10.", + "type": "integer", + "format": "int32", + "default": 10 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobCheckpointList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting checkpoints of a fine tuning job.": { + "$ref": "./examples/get_finetuning_job_checkpoints.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/cancel": { + "post": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Cancels the processing of the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTuning_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The fine tune has been successfully canceled", + "schema": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Canceling a fine tuning job.": { + "$ref": "./examples/cancel_finetuning_job.json" + } + } + } + }, + "/models": { + "get": { + "tags": [ + "Models:" + ], + "summary": "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource.", + "operationId": "Models_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all models owned by account.": { + "$ref": "./examples/get_models.json" + } + } + } + }, + "/models/{model-id}": { + "get": { + "tags": [ + "Models:" + ], + "summary": "Gets details for the model specified by the given modelId.", + "operationId": "Models_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "model-id", + "description": "The identifier of the model.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Model" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a base model.": { + "$ref": "./examples/get_model_base.json" + }, + "Getting a fine-tuned model.": { + "$ref": "./examples/get_model_finetune.json" + } + } + } + }, + "/uploads": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "An intermediate Upload object is created, allowing you to add Parts to it. Currently, an Upload size can be a maximum of 9 GB in total and will expire two hours after being created.\r\nAfter the Upload is completed a File object will be generated, containing all the uploaded parts. This File object can then be used across our platform just like any other file.", + "operationId": "UploadFile_Start", + "consumes": [ + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "requestBody", + "description": "The definition of the file to create including its purpose and the location on the local machine.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadFileStartBody" + } + } + ], + "responses": { + "200": { + "description": "The upload has been successfully created.", + "schema": { + "$ref": "#/definitions/UploadResource" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start a large file upload operation.": { + "$ref": "./examples/upload_file_start.json" + } + } + } + }, + "/uploads/{upload-id}/parts": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "Adds a Part to an Upload object, where each Part represents a segment of the file you are uploading.\r\nEach Part can be up to the standard size limit for file upload, based on the File Purpose. You can continue adding Parts until reaching the Upload size limit of 9 GB.", + "operationId": "UploadFile_Part", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "upload-id", + "description": "The identifier of the upload.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "formData", + "name": "data", + "required": true, + "type": "file" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UploadPartResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upload a part of large file upload operation.": { + "$ref": "./examples/upload_file_part.json" + } + } + } + }, + "/uploads/{upload-id}/complete": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "This completes the Upload, and the returned Upload object contains a nested File object that is ready for use across the platform.\r\nYou can define the order of the Parts by providing an ordered list of Part IDs.\r\nThe total number of bytes uploaded must match the size originally specified when creating the Upload object.\r\nAfter this operation no additional Parts can be added once the Upload is completed.", + "operationId": "UploadFile_Complete", + "consumes": [ + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "upload-id", + "description": "The identifier of the upload.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "requestBody", + "description": "The definition of the file to create including its purpose and the location on the local machine.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadFileCompleteBody" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UploadResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Complete and validate a large file upload operation.": { + "$ref": "./examples/upload_file_complete.json" + } + } + } + }, + "/uploads/{upload-id}/cancel": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "Cancels the Upload, and will lead to all uploaded parts to be deleted asynchronously.\r\nNo Parts may be added after an Upload is cancelled.", + "operationId": "UploadFile_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "upload-id", + "description": "The identifier of the upload.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UploadResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Cancel a large file upload operation.": { + "$ref": "./examples/upload_file_cancel.json" + } + } + } + } + }, + "definitions": { + "Batch": { + "title": "Batch", + "description": "Defines the values of a batch.", + "required": [ + "id", + "input_file_id" + ], + "type": "object", + "properties": { + "id": { + "description": "The identity of this item.", + "type": "string" + }, + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "endpoint": { + "description": "The API endpoint used by the batch.", + "type": "string", + "readOnly": true + }, + "errors": { + "$ref": "#/definitions/BatchErrors" + }, + "input_file_id": { + "description": "The ID of the input file for the batch.", + "minLength": 1, + "type": "string" + }, + "completion_window": { + "description": "The time frame within which the batch should be processed.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/BatchStatus" + }, + "output_file_id": { + "description": "The ID of the file containing outputs of successfully executed requests.", + "type": "string" + }, + "error_file_id": { + "description": "The ID of the file containing outputs of requests with errors.", + "type": "string" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this batch was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "in_progress_at": { + "format": "unixtime", + "description": "A timestamp when this batch started progressing (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "expires_at": { + "format": "unixtime", + "description": "A timestamp when this batch will expire (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "finalizing_at": { + "format": "unixtime", + "description": "A timestamp when this batch started finalizing (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "completed_at": { + "format": "unixtime", + "description": "A timestamp when this batch was completed (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "failed_at": { + "format": "unixtime", + "description": "A timestamp when this batch failed (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "expired_at": { + "format": "unixtime", + "description": "A timestamp when this batch expired (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "cancelling_at": { + "format": "unixtime", + "description": "A timestamp when this batch started cancelling (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "cancelled_at": { + "format": "unixtime", + "description": "A timestamp when this batch was cancelled (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "request_counts": { + "$ref": "#/definitions/BatchRequestCounts" + }, + "metadata": { + "description": "A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BatchCreateRequest": { + "title": "BatchCreateRequest", + "description": "Defines the request to create a batch.", + "required": [ + "input_file_id", + "endpoint", + "completion_window" + ], + "type": "object", + "properties": { + "input_file_id": { + "description": "The ID if the input file for the batch.", + "minLength": 1, + "type": "string" + }, + "endpoint": { + "description": "The API endpoint used by the batch.", + "type": "string" + }, + "completion_window": { + "description": "The time frame within which the batch should be processed.", + "type": "string" + }, + "metadata": { + "description": "A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BatchErrorData": { + "title": "BatchErrorData", + "description": "Error information for a failure in batch.", + "type": "object", + "properties": { + "code": { + "description": "An error code identifying the error type.", + "type": "string" + }, + "message": { + "description": "A human-readable message providing more details about the error.", + "type": "string" + }, + "param": { + "description": "The name of the parameter that caused the error, if applicable (can be null).", + "type": "string" + }, + "line": { + "description": "The line number of the input file where the error occurred, if applicable (can be null).", + "type": "string" + } + } + }, + "BatchErrors": { + "title": "BatchErrors", + "description": "For batches that have failed, this will contain more information on the cause of the failures.", + "type": "object", + "properties": { + "object": { + "description": "The type of the errors object. This is always 'list'.", + "type": "string" + }, + "data": { + "$ref": "#/definitions/BatchErrorData" + } + } + }, + "BatchRequestCounts": { + "title": "BatchRequestCounts", + "description": "The request counts for different statuses within the batch.", + "type": "object", + "properties": { + "total": { + "description": "The total number of requests in the batch.", + "type": "integer" + }, + "completed": { + "description": "The number of requests in the batch that have been completed successfully.", + "type": "integer" + }, + "failed": { + "description": "The number of requests in the batch that have failed.", + "type": "integer" + } + } + }, + "BatchStatus": { + "title": "BatchStatus", + "description": "The status of a batch.", + "enum": [ + "validating", + "failed", + "in_progress", + "finalizing", + "completed", + "expired", + "cancelling", + "cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BatchStatus", + "modelAsString": true, + "values": [ + { + "value": "validating", + "description": "The input file is being validated before the batch can begin." + }, + { + "value": "failed", + "description": "The input file has failed the validation process." + }, + { + "value": "in_progress", + "description": "The input file was successfully validated and the batch is currently being executed." + }, + { + "value": "finalizing", + "description": "The batch has completed and the results are being prepared." + }, + { + "value": "completed", + "description": "The batch has been completed and the results are ready." + }, + { + "value": "expired", + "description": "The batch was not able to complete within the 24-hour time window." + }, + { + "value": "cancelling", + "description": "Cancellation of the batch has been initiated." + }, + { + "value": "cancelled", + "description": "The batch was cancelled." + } + ] + } + }, + "BatchesList": { + "title": "BatchList", + "description": "Represents a list of batches.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/Batch" + } + }, + "first_id": { + "description": "The id of the first batch in the list of batches returned.", + "type": "string" + }, + "last_id": { + "description": "The id of the last batch in the list of batches returned.", + "type": "string" + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "Capabilities": { + "title": "Capabilities", + "description": "The capabilities of a base or fine tune model.", + "required": [ + "chat_completion", + "completion", + "embeddings", + "fine_tune", + "inference" + ], + "type": "object", + "properties": { + "fine_tune": { + "description": "A value indicating whether a model can be used for fine tuning.", + "type": "boolean" + }, + "inference": { + "description": "A value indicating whether a model can be deployed.", + "type": "boolean" + }, + "completion": { + "description": "A value indicating whether a model supports completion.", + "type": "boolean" + }, + "chat_completion": { + "description": "A value indicating whether a model supports chat completion.", + "type": "boolean" + }, + "embeddings": { + "description": "A value indicating whether a model supports embeddings.", + "type": "boolean" + } + } + }, + "Deprecation": { + "title": "Deprecation", + "description": "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties.", + "required": [ + "inference" + ], + "type": "object", + "properties": { + "fine_tune": { + "format": "unixtime", + "description": "The end date of fine tune support of this model. Will be `null` for fine tune models.", + "type": "integer" + }, + "inference": { + "format": "unixtime", + "description": "The end date of inference support of this model.", + "type": "integer" + } + } + }, + "Error": { + "title": "Error", + "description": "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode" + }, + "message": { + "description": "The message of this error.", + "minLength": 1, + "type": "string" + }, + "target": { + "description": "The location where the error happened if available.", + "type": "string" + }, + "details": { + "description": "The error details if available.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + }, + "readOnly": true + }, + "ErrorCode": { + "title": "ErrorCode", + "description": "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "enum": [ + "conflict", + "invalidPayload", + "forbidden", + "notFound", + "unexpectedEntityState", + "itemDoesAlreadyExist", + "serviceUnavailable", + "internalFailure", + "quotaExceeded", + "jsonlValidationFailed", + "fileImportFailed", + "tooManyRequests", + "unauthorized", + "contentFilter" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "value": "conflict", + "description": "The requested operation conflicts with the current resource state." + }, + { + "value": "invalidPayload", + "description": "The request data is invalid for this operation." + }, + { + "value": "forbidden", + "description": "The operation is forbidden for the current user/api key." + }, + { + "value": "notFound", + "description": "The resource is not found." + }, + { + "value": "unexpectedEntityState", + "description": "The operation cannot be executed in the current resource's state." + }, + { + "value": "itemDoesAlreadyExist", + "description": "The item does already exist." + }, + { + "value": "serviceUnavailable", + "description": "The service is currently not available." + }, + { + "value": "internalFailure", + "description": "Internal error. Please retry." + }, + { + "value": "quotaExceeded", + "description": "Quota exceeded." + }, + { + "value": "jsonlValidationFailed", + "description": "Validation of jsonl data failed." + }, + { + "value": "fileImportFailed", + "description": "Import of file failed." + }, + { + "value": "tooManyRequests", + "description": "Too many requests. Please retry later." + }, + { + "value": "unauthorized", + "description": "The current user/api key is not authorized for the operation." + }, + { + "value": "contentFilter", + "description": "Image generation failed as a result of our safety system." + } + ] + } + }, + "ErrorResponse": { + "title": "ErrorResponse", + "description": "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "EventType": { + "title": "EventType", + "description": "Defines the severity of a content filter result.", + "enum": [ + "message", + "metrics" + ], + "type": "string", + "x-ms-enum": { + "name": "EventType", + "modelAsString": true, + "values": [ + { + "value": "message", + "description": "Event only contains human readable messages." + }, + { + "value": "metrics", + "description": "Event contains metrics." + } + ] + } + }, + "File": { + "title": "File", + "description": "A file is a document usable for training and validation. It can also be a service generated document with result details.", + "required": [ + "filename", + "purpose" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FileState" + }, + "bytes": { + "format": "int64", + "description": "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers.", + "type": "integer", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "description": "The name of the file.", + "minLength": 1, + "type": "string" + }, + "status_details": { + "description": "The error message with details in case processing of this file failed.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "FileCreate": { + "title": "FileCreate", + "description": "Defines a document to import from an external content url to be usable with Azure OpenAI.", + "required": [ + "content_url", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "content_url": { + "format": "url", + "description": "The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).", + "type": "string" + } + } + }, + "FileDelete": { + "title": "FileDelete", + "description": "Defines the response for File Delete.", + "required": [ + "deleted", + "id" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "deleted": { + "description": "A value indicating whether gets if the file was deleted.", + "type": "boolean" + }, + "id": { + "description": "The file-id that was deleted.", + "minLength": 1, + "type": "string" + } + } + }, + "FileDetails": { + "title": "FileDetails", + "description": "A file detail is a document used by batch service to fetch file blob details.", + "required": [ + "filename", + "purpose" + ], + "type": "object", + "properties": { + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "filename": { + "description": "The name of the file.", + "minLength": 1, + "type": "string" + }, + "path": { + "description": "The the relative path to the file within the container.", + "type": "string", + "readOnly": true + }, + "storage_account_uri": { + "format": "url", + "description": "The storage account url of this file.", + "type": "string", + "readOnly": true + }, + "storage_container_name": { + "description": "The Storage Container Name of this file blob.", + "type": "string", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + } + } + }, + "FileImport": { + "title": "FileImport", + "description": "Defines a document to import from an external content url to be usable with Azure OpenAI.", + "required": [ + "content_url", + "filename", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "description": "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples.", + "minLength": 1, + "type": "string" + }, + "content_url": { + "format": "url", + "description": "The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).", + "type": "string" + } + } + }, + "FileList": { + "title": "FileList", + "description": "Represents a list of files.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + } + } + } + }, + "FileState": { + "title": "FileState", + "description": "The state of a file.", + "enum": [ + "uploaded", + "pending", + "running", + "processed", + "error", + "deleting", + "deleted" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FileState", + "modelAsString": true, + "values": [ + { + "value": "uploaded", + "description": "The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state." + }, + { + "value": "pending", + "description": "The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state." + }, + { + "value": "running", + "description": "The operation has started to be processed. It can be categorized as an active state." + }, + { + "value": "processed", + "description": "The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state." + }, + { + "value": "error", + "description": "The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state." + }, + { + "value": "deleting", + "description": "The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state." + }, + { + "value": "deleted", + "description": "The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state." + } + ] + } + }, + "FineTuningHyperParameters": { + "title": "FineTuningHyperParameters", + "description": "The hyper parameter settings used in a fine tune job.", + "type": "object", + "properties": { + "n_epochs": { + "format": "int32", + "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.", + "type": "integer" + }, + "batch_size": { + "format": "int32", + "description": "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model.", + "type": "integer" + }, + "learning_rate_multiplier": { + "format": "double", + "description": "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results.", + "type": "number" + } + } + }, + "FineTuningJob": { + "title": "FineTuningJob", + "description": "Defines the values of a fine tune job.", + "required": [ + "model", + "training_file" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FineTuningState" + }, + "model": { + "description": "The identifier (model-id) of the base model used for the fine-tune.", + "minLength": 1, + "type": "string" + }, + "fine_tuned_model": { + "description": "The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing.", + "type": "string" + }, + "training_file": { + "description": "The file which is used for training.", + "minLength": 1, + "type": "string" + }, + "validation_file": { + "description": "The file which is used to evaluate the fine tuned model during training.", + "type": "string" + }, + "result_files": { + "description": "The result file identities (file-id) containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs.", + "type": "array", + "items": { + "type": "string" + } + }, + "finished_at": { + "format": "int32", + "description": "A timestamp when this job or item has finished successfully (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "organisation_id": { + "description": "The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.", + "type": "string" + }, + "trained_tokens": { + "format": "int32", + "description": "The total number of billable tokens processed by this fine tuning job.", + "type": "integer", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/FineTuningJobError" + }, + "estimated_finish": { + "format": "int32", + "description": "The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.", + "type": "integer" + }, + "hyperparameters": { + "$ref": "#/definitions/FineTuningHyperParameters" + }, + "suffix": { + "description": "The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.", + "type": "string" + }, + "seed": { + "format": "int32", + "description": "The seed used for the finetuning job.", + "type": "integer" + } + } + }, + "FineTuningJobCheckpoint": { + "title": "FineTuningJobCheckpoint", + "required": [ + "created_at", + "fine_tuned_model_checkpoint", + "fine_tuning_job_id", + "metrics", + "step_number" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "id": { + "description": "The identity of this checkpoint.", + "type": "string", + "readOnly": true + }, + "created_at": { + "format": "unixtime", + "description": "The Unix timestamp (in seconds) for when the checkpoint was created.", + "type": "integer" + }, + "fine_tuned_model_checkpoint": { + "description": "The name of the fine-tuned checkpoint model that is created.", + "minLength": 1, + "type": "string" + }, + "step_number": { + "format": "int32", + "description": "The step number that the checkpoint was created at.", + "type": "integer" + }, + "metrics": { + "title": "Dictionary`2", + "description": "The metrics at the step number during the fine-tuning job.", + "type": "object", + "additionalProperties": { + "format": "double", + "type": "number" + } + }, + "fine_tuning_job_id": { + "description": "The name of the fine-tuning job that this checkpoint was created from..", + "minLength": 1, + "type": "string" + } + } + }, + "FineTuningJobCheckpointList": { + "title": "FineTuningJobCheckpointList", + "description": "Represents a list of checkpoints.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJobCheckpoint" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningJobCreation": { + "title": "FineTuningJobCreation", + "description": "Defines the values of a fine tune job.", + "required": [ + "model", + "training_file" + ], + "type": "object", + "properties": { + "model": { + "description": "The identifier (model-id) of the base model used for this fine-tune.", + "minLength": 1, + "type": "string" + }, + "training_file": { + "description": "The file identity (file-id) that is used for training this fine tuned model.", + "minLength": 1, + "type": "string" + }, + "validation_file": { + "description": "The file identity (file-id) that is used to evaluate the fine tuned model during training.", + "type": "string" + }, + "hyperparameters": { + "$ref": "#/definitions/FineTuningHyperParameters" + }, + "suffix": { + "description": "The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.", + "type": "string" + }, + "seed": { + "format": "int32", + "description": "The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.", + "type": "integer" + } + } + }, + "FineTuningJobError": { + "title": "FineTuningJobError", + "description": "For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.", + "type": "object", + "properties": { + "code": { + "description": "The machine-readable error code..", + "type": "string" + }, + "message": { + "description": "The human-readable error message.", + "type": "string" + }, + "param": { + "description": "The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.", + "type": "string" + } + } + }, + "FineTuningJobEvent": { + "title": "FineTuningJobEvent", + "required": [ + "created_at", + "level", + "message", + "type" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "id": { + "description": "The identity of this event.", + "type": "string", + "readOnly": true + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this event was created (in unix epochs).", + "type": "integer" + }, + "level": { + "$ref": "#/definitions/LogLevel" + }, + "message": { + "description": "The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results.", + "minLength": 1, + "type": "string" + }, + "type": { + "$ref": "#/definitions/EventType" + }, + "data": { + "description": "Machine readable data of this event." + } + } + }, + "FineTuningJobEventList": { + "title": "FineTuningJobEventList", + "description": "Represents a list of events.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJobEvent" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningJobList": { + "title": "FineTuningJobList", + "description": "Represents a list of fine tunes.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningState": { + "title": "FineTuningState", + "description": "The state of a finetunes object or fine tuning job.", + "enum": [ + "created", + "pending", + "running", + "succeeded", + "cancelled", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FineTuningState", + "modelAsString": true, + "values": [ + { + "value": "created", + "description": "The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state." + }, + { + "value": "pending", + "description": "The operation is not yet queued to be processed in the future. It can be categorized as an inactive state." + }, + { + "value": "running", + "description": "The operation has started to be processed. It can be categorized as an active state." + }, + { + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state." + }, + { + "value": "cancelled", + "description": "The operation has been cancelled and is incomplete. It can be categorized as a terminal state." + }, + { + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state." + } + ] + } + }, + "InnerError": { + "title": "InnerError", + "description": "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/InnerErrorCode" + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "InnerErrorCode": { + "title": "InnerErrorCode", + "description": "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "enum": [ + "invalidPayload" + ], + "type": "string", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "invalidPayload", + "description": "The request data is invalid for this operation." + } + ] + } + }, + "LifeCycleStatus": { + "title": "LifeCycleStatus", + "description": "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\".", + "enum": [ + "preview", + "generally-available" + ], + "type": "string", + "x-ms-enum": { + "name": "LifeCycleStatus", + "modelAsString": true, + "values": [ + { + "value": "preview", + "description": "Model is in preview and covered by the service preview terms." + }, + { + "value": "generally-available", + "description": "Model is generally available." + } + ] + } + }, + "LogLevel": { + "title": "LogLevel", + "description": "The verbosity level of an event.", + "enum": [ + "info", + "warning", + "error" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": true, + "values": [ + { + "value": "info", + "description": "This event is for information only." + }, + { + "value": "warning", + "description": "This event represents a mitigated issue." + }, + { + "value": "error", + "description": "This message represents a non recoverable issue." + } + ] + } + }, + "Model": { + "title": "Model", + "description": "A model is either a base model or the result of a successful fine tune job.", + "required": [ + "capabilities", + "deprecation", + "lifecycle_status" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FineTuningState" + }, + "model": { + "description": "The base model identity (model-id) if this is a fine tune model; otherwise `null`.", + "type": "string" + }, + "fine_tune": { + "description": "The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`.", + "type": "string" + }, + "capabilities": { + "$ref": "#/definitions/Capabilities" + }, + "lifecycle_status": { + "$ref": "#/definitions/LifeCycleStatus" + }, + "deprecation": { + "$ref": "#/definitions/Deprecation" + } + } + }, + "ModelList": { + "title": "ModelList", + "description": "Represents a list of models.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + } + } + }, + "OperationState": { + "title": "OperationState", + "description": "The state of a job or item.", + "enum": [ + "notRunning", + "running", + "succeeded", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "value": "notRunning", + "description": "The operation is not yet queued to be processed in the future." + }, + { + "value": "running", + "description": "The operation has started to be processed." + }, + { + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption." + }, + { + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed." + } + ] + } + }, + "Purpose": { + "title": "Purpose", + "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch", + "batch_output" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + }, + { + "value": "batch", + "description": "This file contains the input data for a batch." + }, + { + "value": "batch_output", + "description": "This file contains the results of a batch." + } + ] + } + }, + "TypeDiscriminator": { + "title": "TypeDiscriminator", + "description": "Defines the type of an object.", + "enum": [ + "list", + "fine_tuning.job", + "file", + "fine_tuning.job.event", + "fine_tuning.job.checkpoint", + "model", + "batch", + "upload", + "upload.part" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TypeDiscriminator", + "modelAsString": true, + "values": [ + { + "value": "list", + "description": "This object represents a list of other objects." + }, + { + "value": "fine_tuning.job", + "description": "This object represents a fine tune job." + }, + { + "value": "file", + "description": "This object represents a file." + }, + { + "value": "fine_tuning.job.event", + "description": "This object represents an event of a fine tuning job." + }, + { + "value": "fine_tuning.job.checkpoint", + "description": "This object represents a checkpoint of a fine tuning job." + }, + { + "value": "model", + "description": "This object represents a model (can be a base model or fine tune job result)." + }, + { + "value": "batch", + "description": "This object represents a batch." + }, + { + "value": "upload", + "description": "This object represents a file upload." + }, + { + "value": "upload.part", + "description": "This object represents part of a file upload." + } + ] + } + }, + "UploadFileCompleteBody": { + "title": "UploadFileCompleteBody", + "required": [ + "part_ids" + ], + "type": "object", + "properties": { + "part_ids": { + "title": "IList`1", + "type": "array", + "items": { + "type": "string" + } + }, + "md5": { + "type": "string" + } + } + }, + "UploadFileStartBody": { + "title": "UploadFileStartBody", + "required": [ + "bytes", + "filename", + "mime_type", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "minLength": 1, + "type": "string" + }, + "bytes": { + "format": "int64", + "type": "integer" + }, + "mime_type": { + "minLength": 1, + "type": "string" + } + } + }, + "UploadPartResource": { + "title": "UploadPartResource", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "upload_id": { + "type": "string", + "readOnly": true + }, + "azure_block_id": { + "type": "string", + "readOnly": true + } + } + }, + "UploadResource": { + "title": "UploadResource", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "bytes": { + "format": "int64", + "type": "integer", + "readOnly": true + }, + "filename": { + "type": "string", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "status": { + "$ref": "#/definitions/UploadStatus" + }, + "expires_at": { + "format": "unixtime", + "type": "integer", + "readOnly": true + }, + "file": { + "$ref": "#/definitions/File" + } + } + }, + "UploadStatus": { + "title": "UploadStatus", + "enum": [ + "pending", + "expired", + "completed", + "cancelled" + ], + "type": "string", + "readOnly": true + } + }, + "parameters": { + "endpoint": { + "in": "path", + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace \"aoairesource\" with your Azure OpenAI account name).", + "required": true, + "type": "string", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "apiVersionQueryParameter": { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string", + "x-ms-client-default": "2024-10-21", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "api-key": { + "type": "apiKey", + "name": "api-key", + "in": "header", + "description": "Provide your Cognitive Services Azure OpenAI account key here." + } + }, + "security": [ + { + "api-key": [] + } + ], + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/openai", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/endpoint" + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/azureopenai.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/azureopenai.yaml new file mode 100644 index 000000000000..1b6ac795033b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/azureopenai.yaml @@ -0,0 +1,1839 @@ +swagger: '2.0' +info: + title: Azure OpenAI API version 2024-10-21 + description: APIs for fine-tuning and managing deployments of OpenAI models. + version: 2024-10-21 +paths: + /batches: + get: + tags: + - "Batch:" + summary: Gets a list of all batches owned by the Azure OpenAI resource. + operationId: Batch_List + produces: + - application/json + parameters: + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of batches to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/BatchesList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all batches owned by this account.: + $ref: ./examples/get_batches.json + post: + tags: + - "Batch:" + summary: "Creates and executes a batch from an uploaded file of requests.\r\nResponse includes details of the enqueued job including job status.\r\nThe ID of the result file is added to the response once complete." + operationId: Batch_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: createBatchRequest + description: The specification of the batch to create and execute. + required: true + schema: + $ref: "#/definitions/BatchCreateRequest" + responses: + "200": + description: The batch has been successfully created. + schema: + $ref: "#/definitions/Batch" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Creating a batch.: + $ref: ./examples/post_batch.json + /batches/{batch-id}: + get: + tags: + - "Batch:" + summary: Gets details for a single batch specified by the given batch-id. + operationId: Batch_Get + produces: + - application/json + parameters: + - in: path + name: batch-id + description: The identifier of the batch. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/Batch" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a batch.: + $ref: ./examples/get_batch.json + /batches/{batch-id}/cancel: + post: + tags: + - "Batch:" + summary: Cancels the processing of the batch specified by the given batch-id. + operationId: Batch_Cancel + produces: + - application/json + parameters: + - in: path + name: batch-id + description: The identifier of the batch. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: The batch has been successfully canceled. + schema: + $ref: "#/definitions/Batch" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Canceling a batch.: + $ref: ./examples/cancel_batch.json +/files: + get: + tags: + - "Files:" + summary: "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job." + operationId: Files_List + produces: + - application/json + parameters: + - in: query + name: purpose + description: Only return files with the given purpose. + type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + - batch + - batch_output + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + - value: batch + description: This file contains the input data for a batch. + - value: batch_output + description: This file contains the results of a batch. + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FileList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all files owned by this account.: + $ref: ./examples/get_files.yaml + post: + tags: + - "Files:" + summary: Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models. + operationId: Files_Upload + consumes: + - multipart/form-data + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: formData + name: purpose + description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. + required: true + type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + - batch + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + - value: batch + description: This file contains the input data for a batch. + - in: formData + name: file + description: Gets or sets the file to upload into Azure OpenAI. + required: true + type: file + responses: + "201": + description: The file has been successfully created. + schema: + $ref: "#/definitions/File" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Upload a file.: + $ref: ./examples/upload_file.yaml +/files/import: + post: + tags: + - "Files:" + summary: Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models. + operationId: Files_Import + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: fileImport + description: The definition of the file to create including its purpose, the file name and the url of the file location. + required: true + schema: + $ref: "#/definitions/FileImport" + responses: + "201": + description: The file has been successfully created. + schema: + $ref: "#/definitions/File" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Importing a file with a blob url as source.: + $ref: ./examples/import_file.yaml +/files/{file-id}: + get: + tags: + - "Files:" + summary: Gets details for a single file specified by the given file-id including status, size, purpose, etc. + operationId: Files_Get + produces: + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/File" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a file.: + $ref: ./examples/get_file.yaml + delete: + tags: + - "Files:" + summary: "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job." + operationId: Files_Delete + produces: + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: The file was successfully deleted. + schema: + $ref: "#/definitions/FileDelete" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Deleting a file.: + $ref: ./examples/delete_file.yaml +/files/{file-id}/content: + get: + tags: + - "Files:" + summary: "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job." + operationId: Files_GetContent + produces: + - application/octet-stream + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + type: file + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting the file content.: + $ref: ./examples/get_file_content.yaml + /fine_tuning/jobs: + get: + tags: + - 'Fine-tuning:' + summary: "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\r\nThe details that are returned for each fine-tune job contain besides its identifier\r\nthe base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_List + produces: + - application/json + parameters: + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of events to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/FineTuningJobList' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting all fine tuning jobs owned by this account.: + $ref: ./examples/get_finetuning_jobs.yaml + post: + tags: + - 'Fine-tuning:' + summary: "Creates a job that fine-tunes a specified model from a given training file.\r\nResponse includes details of the enqueued job including job status and hyper parameters.\r\nThe name of the fine-tuned model is added to the response once complete." + operationId: FineTuning_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: '#/parameters/apiVersionQueryParameter' + - in: body + name: fineTuningJob + description: "The specification of the fine-tuned model to create.\r\nRequired parameters are the base model and the training file to use.\r\nOptionally a validation file can be specified to compute validation metrics during training.\r\nHyper parameters will be set to default values or can be optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others." + required: true + schema: + $ref: '#/definitions/FineTuningJobCreation' + responses: + '201': + description: The fine tune has been successfully created. + schema: + $ref: '#/definitions/FineTuningJob' + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Creating a fine tuning job.: + $ref: ./examples/post_finetuning_job.yaml + /fine_tuning/jobs/{fine-tuning-job-id}: + get: + tags: + - 'Fine-tuning:' + summary: "Gets details for a single fine-tune job specified by the given fine-tune-id.\r\nThe details contain the base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_Get + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/FineTuningJob' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting a fine tuning job.: + $ref: ./examples/get_finetuning_job.yaml + delete: + tags: + - 'Fine-tuning:' + summary: Deletes the fine-tune job specified by the given fine-tune-id. + operationId: FineTuning_Delete + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '204': + description: The fine tune was successfully deleted. + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Deleting a fine tuning job.: + $ref: ./examples/delete_finetuning_job.yaml + /fine_tuning/jobs/{fine-tuning-job-id}/events: + get: + tags: + - 'Fine-tuning:' + summary: "Gets the events for the fine-tune job specified by the given fine-tune-id.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_GetEvents + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of events to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/FineTuningJobEventList' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting events of a fine tuning job.: + $ref: ./examples/get_finetuning_job_events.yaml + /fine_tuning/jobs/{fine-tuning-job-id}/checkpoints: + get: + tags: + - 'Fine-tuning:' + summary: "Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.\r\nCheckpoints are created at the end of successful epochs during training." + operationId: FineTuning_GetCheckpoints + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - in: query + name: after + description: Identifier for the last checkpoint ID from the previous pagination request. + type: string + - in: query + name: limit + description: Number of checkpoints to retrieve. Defaults to 10. + type: integer + format: int32 + default: 10 + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/FineTuningJobCheckpointList' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting checkpoints of a fine tuning job.: + $ref: ./examples/get_finetuning_job_checkpoints.yaml + /fine_tuning/jobs/{fine-tuning-job-id}/cancel: + post: + tags: + - 'Fine-tuning:' + summary: Cancels the processing of the fine-tune job specified by the given fine-tune-id. + operationId: FineTuning_Cancel + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: The fine tune has been successfully canceled + schema: + $ref: '#/definitions/FineTuningJob' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Canceling a fine tuning job.: + $ref: ./examples/cancel_finetuning_job.yaml + /models: + get: + tags: + - 'Models:' + summary: "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource." + operationId: Models_List + produces: + - application/json + parameters: + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/ModelList' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting all models owned by account.: + $ref: ./examples/get_models.yaml + /models/{model-id}: + get: + tags: + - 'Models:' + summary: Gets details for the model specified by the given modelId. + operationId: Models_Get + produces: + - application/json + parameters: + - in: path + name: model-id + description: The identifier of the model. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/Model' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Getting a base model.: + $ref: ./examples/get_model_base.yaml + Getting a fine-tuned model.: + $ref: ./examples/get_model_finetune.yaml + /uploads: + post: + tags: + - 'UploadFile:' + summary: 'An intermediate Upload object is created, allowing you to add Parts to it. Currently, an Upload size can be a maximum of 9 GB in total and will expire two hours after being created.\r\nAfter the Upload is completed a File object will be generated, containing all the uploaded parts. This File object can then be used across our platform just like any other file.' + operationId: UploadFile_Start + consumes: + - application/json + - text/json + - application/*+json + produces: + - application/json + parameters: + - $ref: '#/parameters/apiVersionQueryParameter' + - in: body + name: requestBody + description: The definition of the file to create including its purpose and the location on the local machine. + required: true + schema: + $ref: '#/definitions/UploadFileStartBody' + responses: + '200': + description: The upload has been successfully created. + schema: + $ref: '#/definitions/UploadResource' + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Start a large file upload operation.: + $ref: ./examples/upload_file_start.yaml + '/uploads/{upload-id}/parts': + post: + tags: + - 'UploadFile:' + summary: 'Adds a Part to an Upload object, where each Part represents a segment of the file you are uploading.\r\nEach Part can be up to the standard size limit for file upload, based on the File Purpose. You can continue adding Parts until reaching the Upload size limit of 9 GB.' + operationId: UploadFile_Part + consumes: + - multipart/form-data + produces: + - application/json + parameters: + - in: path + name: upload-id + description: The identifier of the upload. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + - in: formData + name: data + required: true + type: file + responses: + '200': + description: Success + schema: + $ref: '#/definitions/UploadPartResource' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Upload a part of large file upload operation.: + $ref: ./examples/upload_file_part.yaml + '/uploads/{upload-id}/complete': + post: + tags: + - 'UploadFile:' + summary: 'This completes the Upload, and the returned Upload object contains a nested File object that is ready for use across the platform.\r\nYou can define the order of the Parts by providing an ordered list of Part IDs.\r\nThe total number of bytes uploaded must match the size originally specified when creating the Upload object.\r\nAfter this operation no additional Parts can be added once the Upload is completed.' + operationId: UploadFile_Complete + consumes: + - application/json + - text/json + - application/*+json + produces: + - application/json + parameters: + - in: path + name: upload-id + description: The identifier of the upload. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + - in: body + name: requestBody + description: The definition of the file to create including its purpose and the location on the local machine. + required: true + schema: + $ref: '#/definitions/UploadFileCompleteBody' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/UploadResource' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Complete and validate a large file upload operation.: + $ref: ./examples/upload_file_complete.yaml + '/uploads/{upload-id}/cancel': + post: + tags: + - 'UploadFile:' + summary: 'Cancels the Upload, and will lead to all uploaded parts to be deleted asynchronously.\r\nNo Parts may be added after an Upload is cancelled.' + operationId: UploadFile_Cancel + produces: + - application/json + parameters: + - in: path + name: upload-id + description: The identifier of the upload. + required: true + type: string + - $ref: '#/parameters/apiVersionQueryParameter' + responses: + '200': + description: Success + schema: + $ref: '#/definitions/UploadResource' + default: + description: An error occurred. + schema: + $ref: '#/definitions/ErrorResponse' + x-ms-examples: + Cancel a large file upload operation.: + $ref: ./examples/upload_file_cancel.yaml +definitions: + Batch: + title: Batch + description: Defines the values of a batch. + required: + - id + - input_file_id + type: object + properties: + id: + description: The identity of this item. + type: string + object: + $ref: "#/definitions/TypeDiscriminator" + endpoint: + description: The API endpoint used by the batch. + type: string + readOnly: true + errors: + $ref: "#/definitions/BatchErrors" + input_file_id: + description: The ID of the input file for the batch. + minLength: 1 + type: string + completion_window: + description: The time frame within which the batch should be processed. + type: string + status: + $ref: "#/definitions/BatchStatus" + output_file_id: + description: The ID of the file containing outputs of successfully executed requests. + type: string + error_file_id: + description: The ID of the file containing outputs of requests with errors. + type: string + created_at: + format: unixtime + description: A timestamp when this batch was created (in unix epochs). + type: integer + readOnly: true + in_progress_at: + format: unixtime + description: A timestamp when this batch started progressing (in unix epochs). + type: integer + readOnly: true + expires_at: + format: unixtime + description: A timestamp when this batch will expire (in unix epochs). + type: integer + readOnly: true + finalizing_at: + format: unixtime + description: A timestamp when this batch started finalizing (in unix epochs). + type: integer + readOnly: true + completed_at: + format: unixtime + description: A timestamp when this batch was completed (in unix epochs). + type: integer + readOnly: true + failed_at: + format: unixtime + description: A timestamp when this batch failed (in unix epochs). + type: integer + readOnly: true + expired_at: + format: unixtime + description: A timestamp when this batch expired (in unix epochs). + type: integer + readOnly: true + cancelling_at: + format: unixtime + description: A timestamp when this batch started cancelling (in unix epochs). + type: integer + readOnly: true + cancelled_at: + format: unixtime + description: A timestamp when this batch was cancelled (in unix epochs). + type: integer + readOnly: true + request_counts: + $ref: "#/definitions/BatchRequestCounts" + metadata: + description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format. + type: object + additionalProperties: + type: string + BatchCreateRequest: + title: BatchCreateRequest + description: Defines the request to create a batch. + required: + - input_file_id + - endpoint + - completion_window + type: object + properties: + input_file_id: + description: The ID if the input file for the batch. + minLength: 1 + type: string + endpoint: + description: The API endpoint used by the batch. + type: string + completion_window: + description: The time frame within which the batch should be processed. + type: string + metadata: + description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format. + type: object + additionalProperties: + type: string + BatchErrorData: + title: BatchErrorData + description: Error information for a failure in batch. + type: object + properties: + code: + description: An error code identifying the error type. + type: string + message: + description: A human-readable message providing more details about the error. + type: string + param: + description: The name of the parameter that caused the error, if applicable (can be null). + type: string + line: + description: The line number of the input file where the error occurred, if applicable (can be null). + type: string + BatchErrors: + title: BatchErrors + description: For batches that have failed, this will contain more information on the cause of the failures. + type: object + properties: + object: + description: The type of the errors object. This is always 'list'. + type: string + data: + $ref: "#/definitions/BatchErrorData" + BatchRequestCounts: + title: BatchRequestCounts + description: The request counts for different statuses within the batch. + type: object + properties: + total: + description: The total number of requests in the batch. + type: integer + completed: + description: The number of requests in the batch that have been completed successfully. + type: integer + failed: + description: The number of requests in the batch that have failed. + type: integer + BatchStatus: + title: BatchStatus + description: The status of a batch. + enum: + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled + type: string + readOnly: true + x-ms-enum: + name: BatchStatus + modelAsString: true + values: + - value: validating + description: The input file is being validated before the batch can begin. + - value: failed + description: The input file has failed the validation process. + - value: in_progress + description: The input file was successfully validated and the batch is currently being executed. + - value: finalizing + description: The batch has completed and the results are being prepared. + - value: completed + description: The batch has been completed and the results are ready. + - value: expired + description: The batch was not able to complete within the 24-hour time window. + - value: cancelling + description: Cancellation of the batch has been initiated. + - value: cancelled + description: The batch was cancelled. + BatchesList: + title: BatchList + description: Represents a list of batches. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/Batch" + first_id: + description: The id of the first batch in the list of batches returned. + type: string + last_id: + description: The id of the last batch in the list of batches returned. + type: string + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + Capabilities: + title: Capabilities + description: The capabilities of a base or fine tune model. + required: + - chat_completion + - completion + - embeddings + - fine_tune + - inference + type: object + properties: + fine_tune: + description: A value indicating whether a model can be used for fine tuning. + type: boolean + inference: + description: A value indicating whether a model can be deployed. + type: boolean + completion: + description: A value indicating whether a model supports completion. + type: boolean + chat_completion: + description: A value indicating whether a model supports chat completion. + type: boolean + embeddings: + description: A value indicating whether a model supports embeddings. + type: boolean + Deprecation: + title: Deprecation + description: "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties." + required: + - inference + type: object + properties: + fine_tune: + format: unixtime + description: The end date of fine tune support of this model. Will be `null` for fine tune models. + type: integer + inference: + format: unixtime + description: The end date of inference support of this model. + type: integer + Error: + title: Error + description: "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + required: + - code + - message + type: object + properties: + code: + $ref: '#/definitions/ErrorCode' + message: + description: The message of this error. + minLength: 1 + type: string + target: + description: The location where the error happened if available. + type: string + details: + description: The error details if available. + type: array + items: + $ref: '#/definitions/Error' + innererror: + $ref: '#/definitions/InnerError' + readOnly: true + ErrorCode: + title: ErrorCode + description: "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + enum: + - conflict + - invalidPayload + - forbidden + - notFound + - unexpectedEntityState + - itemDoesAlreadyExist + - serviceUnavailable + - internalFailure + - quotaExceeded + - jsonlValidationFailed + - fileImportFailed + - tooManyRequests + - unauthorized + - contentFilter + type: string + x-ms-enum: + name: ErrorCode + modelAsString: true + values: + - value: conflict + description: The requested operation conflicts with the current resource state. + - value: invalidPayload + description: The request data is invalid for this operation. + - value: forbidden + description: The operation is forbidden for the current user/api key. + - value: notFound + description: The resource is not found. + - value: unexpectedEntityState + description: The operation cannot be executed in the current resource's state. + - value: itemDoesAlreadyExist + description: The item does already exist. + - value: serviceUnavailable + description: The service is currently not available. + - value: internalFailure + description: Internal error. Please retry. + - value: quotaExceeded + description: Quota exceeded. + - value: jsonlValidationFailed + description: Validation of jsonl data failed. + - value: fileImportFailed + description: Import of file failed. + - value: tooManyRequests + description: Too many requests. Please retry later. + - value: unauthorized + description: The current user/api key is not authorized for the operation. + - value: contentFilter + description: Image generation failed as a result of our safety system. + ErrorResponse: + title: ErrorResponse + description: "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + required: + - error + type: object + properties: + error: + $ref: '#/definitions/Error' + EventType: + title: EventType + description: Defines the severity of a content filter result. + enum: + - message + - metrics + type: string + x-ms-enum: + name: EventType + modelAsString: true + values: + - value: message + description: Event only contains human readable messages. + - value: metrics + description: Event contains metrics. + File: + title: File + description: A file is a document usable for training and validation. It can also be a service generated document with result details. + required: + - filename + - purpose + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: '#/definitions/FileState' + bytes: + format: int64 + description: "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers." + type: integer + readOnly: true + purpose: + $ref: "#/definitions/Purpose" + filename: + description: The name of the file. + minLength: 1 + type: string + status_details: + description: The error message with details in case processing of this file failed. + type: string + readOnly: true + FileCreate: + title: FileCreate + description: Defines a document to import from an external content url to be usable with Azure OpenAI. + required: + - content_url + - purpose + type: object + properties: + purpose: + $ref: "#/definitions/Purpose" + content_url: + format: url + description: The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request). + type: string + FileDetails: + title: FileDetails + description: A file detail is a document used by batch service to fetch file blob details. + required: + - filename + - purpose + type: object + properties: + id: + description: The identity of this item. + type: string + readOnly: true + filename: + description: The name of the file. + minLength: 1 + type: string + path: + description: The the relative path to the file within the container. + type: string + readOnly: true + storage_account_uri: + format: url + description: The storage account url of this file. + type: string + readOnly: true + storage_container_name: + description: The Storage Container Name of this file blob. + type: string + readOnly: true + purpose: + $ref: "#/definitions/Purpose" + FileDelete: + title: FileDelete + description: Defines the response for File Delete. + required: + - deleted + - id + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + deleted: + description: A value indicating whether gets if the file was deleted. + type: boolean + id: + description: The file-id that was deleted. + minLength: 1 + type: string + FileImport: + title: FileImport + description: Defines a document to import from an external content url to be usable with Azure OpenAI. + required: + - content_url + - filename + - purpose + type: object + properties: + purpose: + $ref: "#/definitions/Purpose" + filename: + description: "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples." + minLength: 1 + type: string + content_url: + format: url + description: The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request). + type: string + FileList: + title: FileList + description: Represents a list of files. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/File" + FileState: + title: FileState + description: The state of a file. + enum: + - uploaded + - pending + - running + - processed + - error + - deleting + - deleted + type: string + readOnly: true + x-ms-enum: + name: FileState + modelAsString: true + values: + - value: uploaded + description: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. + - value: pending + description: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. + - value: running + description: The operation has started to be processed. It can be categorized as an active state. + - value: processed + description: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. + - value: error + description: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. + - value: deleting + description: The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. + - value: deleted + description: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. + FineTuningHyperParameters: + title: FineTuningHyperParameters + description: The hyper parameter settings used in a fine tune job. + type: object + properties: + n_epochs: + format: int32 + description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. + type: integer + batch_size: + format: int32 + description: "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model." + type: integer + learning_rate_multiplier: + format: double + description: "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results." + type: number + FineTuningJob: + title: FineTuningJob + description: Defines the values of a fine tune job. + required: + - model + - training_file + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: '#/definitions/FineTuningState' + model: + description: The identifier (model-id) of the base model used for the fine-tune. + minLength: 1 + type: string + fine_tuned_model: + description: "The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing." + type: string + training_file: + description: The file which is used for training. + minLength: 1 + type: string + validation_file: + description: The file which is used to evaluate the fine tuned model during training. + type: string + result_files: + description: "The result file identities (file-id) containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs." + type: array + items: + type: string + finished_at: + format: int32 + description: A timestamp when this job or item has finished successfully (in unix epochs). + type: integer + readOnly: true + organisation_id: + description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only. + type: string + trained_tokens: + format: int32 + description: The total number of billable tokens processed by this fine tuning job. + type: integer + readOnly: true + error: + $ref: '#/definitions/FineTuningJobError' + estimated_finish: + format: int32 + description: The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running. + type: integer + hyperparameters: + $ref: '#/definitions/FineTuningHyperParameters' + suffix: + description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. + type: string + seed: + format: int32 + description: The seed used for the finetuning job. + type: integer + FineTuningJobCheckpoint: + title: FineTuningJobCheckpoint + required: + - created_at + - fine_tuned_model_checkpoint + - fine_tuning_job_id + - metrics + - step_number + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + id: + description: The identity of this checkpoint. + type: string + readOnly: true + created_at: + format: unixtime + description: The Unix timestamp (in seconds) for when the checkpoint was created. + type: integer + fine_tuned_model_checkpoint: + description: The name of the fine-tuned checkpoint model that is created. + minLength: 1 + type: string + step_number: + format: int32 + description: The step number that the checkpoint was created at. + type: integer + metrics: + title: Dictionary`2 + description: The metrics at the step number during the fine-tuning job. + type: object + additionalProperties: + format: double + type: number + fine_tuning_job_id: + description: The name of the fine-tuning job that this checkpoint was created from.. + minLength: 1 + type: string + FineTuningJobCheckpointList: + title: FineTuningJobCheckpointList + description: Represents a list of checkpoints. + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + data: + description: The list of items. + type: array + items: + $ref: '#/definitions/FineTuningJobCheckpoint' + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningJobCreation: + title: FineTuningJobCreation + description: Defines the values of a fine tune job. + required: + - model + - training_file + type: object + properties: + model: + description: The identifier (model-id) of the base model used for this fine-tune. + minLength: 1 + type: string + training_file: + description: The file identity (file-id) that is used for training this fine tuned model. + minLength: 1 + type: string + validation_file: + description: The file identity (file-id) that is used to evaluate the fine tuned model during training. + type: string + hyperparameters: + $ref: '#/definitions/FineTuningHyperParameters' + suffix: + description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. + type: string + seed: + format: int32 + description: The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you. + type: integer + FineTuningJobError: + title: FineTuningJobError + description: 'For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.' + type: object + properties: + code: + description: The machine-readable error code.. + type: string + message: + description: The human-readable error message. + type: string + param: + description: 'The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.' + type: string + FineTuningJobEvent: + title: FineTuningJobEvent + required: + - created_at + - level + - message + - type + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + id: + description: The identity of this event. + type: string + readOnly: true + created_at: + format: unixtime + description: A timestamp when this event was created (in unix epochs). + type: integer + level: + $ref: '#/definitions/LogLevel' + message: + description: The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results. + minLength: 1 + type: string + type: + $ref: '#/definitions/EventType' + data: + description: Machine readable data of this event. + FineTuningJobEventList: + title: FineTuningJobEventList + description: Represents a list of events. + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + data: + description: The list of items. + type: array + items: + $ref: '#/definitions/FineTuningJobEvent' + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningJobList: + title: FineTuningJobList + description: Represents a list of fine tunes. + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + data: + description: The list of items. + type: array + items: + $ref: '#/definitions/FineTuningJob' + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningState: + title: FineTuningState + description: The state of a finetunes object or fine tuning job. + enum: + - created + - pending + - running + - succeeded + - cancelled + - failed + type: string + readOnly: true + x-ms-enum: + name: FineTuningState + modelAsString: true + values: + - value: created + description: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. + - value: pending + description: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state. + - value: running + description: The operation has started to be processed. It can be categorized as an active state. + - value: succeeded + description: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. + - value: cancelled + description: The operation has been cancelled and is incomplete. It can be categorized as a terminal state. + - value: failed + description: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. + InnerError: + title: InnerError + description: "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + type: object + properties: + code: + $ref: '#/definitions/InnerErrorCode' + innererror: + $ref: '#/definitions/InnerError' + InnerErrorCode: + title: InnerErrorCode + description: "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + enum: + - invalidPayload + type: string + x-ms-enum: + name: InnerErrorCode + modelAsString: true + values: + - value: invalidPayload + description: The request data is invalid for this operation. + LifeCycleStatus: + title: LifeCycleStatus + description: "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\"." + enum: + - preview + - generally-available + type: string + x-ms-enum: + name: LifeCycleStatus + modelAsString: true + values: + - value: preview + description: Model is in preview and covered by the service preview terms. + - value: generally-available + description: Model is generally available. + LogLevel: + title: LogLevel + description: The verbosity level of an event. + enum: + - info + - warning + - error + type: string + x-ms-enum: + name: LogLevel + modelAsString: true + values: + - value: info + description: This event is for information only. + - value: warning + description: This event represents a mitigated issue. + - value: error + description: This message represents a non recoverable issue. + Model: + title: Model + description: A model is either a base model or the result of a successful fine tune job. + required: + - capabilities + - deprecation + - lifecycle_status + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: '#/definitions/FineTuningState' + model: + description: The base model identity (model-id) if this is a fine tune model; otherwise `null`. + type: string + fine_tune: + description: The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`. + type: string + capabilities: + $ref: '#/definitions/Capabilities' + lifecycle_status: + $ref: '#/definitions/LifeCycleStatus' + deprecation: + $ref: '#/definitions/Deprecation' + ModelList: + title: ModelList + description: Represents a list of models. + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + data: + description: The list of items. + type: array + items: + $ref: '#/definitions/Model' + OperationState: + title: OperationState + description: The state of a job or item. + enum: + - notRunning + - running + - succeeded + - failed + type: string + readOnly: true + x-ms-enum: + name: OperationState + modelAsString: true + values: + - value: notRunning + description: The operation is not yet queued to be processed in the future. + - value: running + description: The operation has started to be processed. + - value: succeeded + description: The operation has successfully be processed and is ready for consumption. + - value: failed + description: The operation has completed processing with a failure and cannot be further consumed. + Purpose: + title: Purpose + description: >- + The intended purpose of the uploaded documents. Use "fine-tune" for + fine-tuning. This allows us to validate the format of the uploaded file. + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + - batch + - batch_output + type: string + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + - value: batch + description: This file contains the input data for a batch. + - value: batch_output + description: This file contains the results of a batch. + TypeDiscriminator: + title: TypeDiscriminator + description: Defines the type of an object. + enum: + - list + - fine_tuning.job + - file + - fine_tuning.job.event + - fine_tuning.job.checkpoint + - model + - batch + - upload + - upload.part + type: string + readOnly: true + x-ms-enum: + name: TypeDiscriminator + modelAsString: true + values: + - value: list + description: This object represents a list of other objects. + - value: fine_tuning.job + description: This object represents a fine tune job. + - value: file + description: This object represents a file. + - value: fine_tuning.job.event + description: This object represents an event of a fine tuning job. + - value: fine_tuning.job.checkpoint + description: This object represents a checkpoint of a fine tuning job. + - value: model + description: This object represents a model (can be a base model or fine tune job result). + - value: batch + description: This object represents a batch. + - value: upload + description: This object represents a file upload. + - value: upload.part + description: This object represents part of a file upload. + UploadFileCompleteBody: + title: UploadFileCompleteBody + required: + - part_ids + type: object + properties: + part_ids: + title: IList`1 + type: array + items: + type: string + md5: + type: string + UploadFileStartBody: + title: UploadFileStartBody + required: + - bytes + - filename + - mime_type + - purpose + type: object + properties: + purpose: + $ref: '#/definitions/Purpose' + filename: + minLength: 1 + type: string + bytes: + format: int64 + type: integer + mime_type: + minLength: 1 + type: string + UploadPartResource: + title: UploadPartResource + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + upload_id: + type: string + readOnly: true + azure_block_id: + type: string + readOnly: true + UploadResource: + title: UploadResource + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + bytes: + format: int64 + type: integer + readOnly: true + filename: + type: string + readOnly: true + purpose: + $ref: '#/definitions/Purpose' + status: + $ref: '#/definitions/UploadStatus' + expires_at: + format: unixtime + type: integer + readOnly: true + file: + $ref: '#/definitions/File' + UploadStatus: + title: UploadStatus + enum: + - pending + - expired + - completed + - cancelled + type: string + readOnly: true +parameters: + endpoint: + in: path + name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace "aoairesource" with your Azure OpenAI account name).' + required: true + type: string + format: url + x-ms-skip-url-encoding: true + x-ms-parameter-location: client + apiVersionQueryParameter: + in: query + name: api-version + description: The requested API version. + required: true + type: string + x-ms-client-default: 2024-10-21 + x-ms-parameter-location: client +securityDefinitions: + api-key: + type: apiKey + name: api-key + in: header + description: Provide your Cognitive Services Azure OpenAI account key here. +security: + - api-key: [ ] +schemes: + - https +x-ms-parameterized-host: + hostTemplate: '{endpoint}/openai' + useSchemePrefix: false + parameters: + - $ref: '#/parameters/endpoint' \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/cancel_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/cancel_batch.json new file mode 100644 index 000000000000..603ae8a41c73 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/cancel_batch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "batch-id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "cancelling", + "output_file_id": null, + "error_file_id": null, + "created_at": 1646126127, + "in_progress_at": 1646126130, + "expires_at": 1646126170, + "finalizing_at": null, + "completed_at": null, + "failed_at": null, + "expired_at": null, + "cancelling_at": 1646126138, + "cancelled_at": null, + "request_counts": { + "total": 500, + "completed": 100, + "failed": 5 + }, + "metadata": { + "batch_description": "Evaluation job" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/cancel_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/cancel_batch.yaml new file mode 100644 index 000000000000..7c844f7253f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/cancel_batch.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-10-21 + batch-id: batch_72a2792ef7d24ba7b82c7fe4a37e379f +responses: + "200": + headers: {} + body: + object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: cancelling + output_file_id: null + error_file_id: null + created_at: 1646126127 + in_progress_at: 1646126130 + expires_at: 1646126170 + finalizing_at: null + completed_at: null + failed_at: null + expired_at: null + cancelling_at: 1646126138 + cancelled_at: null + request_counts: + total: 500 + completed: 100 + failed: 5 + metadata: + batch_description: Evaluation job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/cancel_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/cancel_finetuning_job.json new file mode 100644 index 000000000000..463808f30cd7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/cancel_finetuning_job.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparameters": { + "n_epochs": -1 + }, + "status": "cancelled", + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "finished_at": 1646127311, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/cancel_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/cancel_finetuning_job.yaml new file mode 100644 index 000000000000..b15bf3c606d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/cancel_finetuning_job.yaml @@ -0,0 +1,25 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + hyperparameters: + n_epochs: -1 + suffix: + seed: + status: cancelled + model: curie + fine_tuned_model: + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + finished_at: 1646127311 + organisation_id: + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_file.json new file mode 100644 index 000000000000..3f665e07ce12 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_file.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "object": "file", + "deleted": true, + "id": "file-181a1cbdcdcf4677ada87f63a0928099" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_file.yaml new file mode 100644 index 000000000000..6f5607f5f35b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_file.yaml @@ -0,0 +1,12 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: + object: file + deleted: true + id: file-181a1cbdcdcf4677ada87f63a0928099 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_finetune.json new file mode 100644 index 000000000000..e5de451d4490 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_finetune.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "fine-tune-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_finetune.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_finetune.yaml new file mode 100644 index 000000000000..48901d780220 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_finetune.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + fine-tune-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 204: + headers: {} + body: diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_finetuning_job.json new file mode 100644 index 000000000000..52bedff2eb58 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_finetuning_job.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_finetuning_job.yaml new file mode 100644 index 000000000000..b58c42b80fc9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/delete_finetuning_job.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 204: + headers: {} + body: diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_batch.json new file mode 100644 index 000000000000..b2262bc0bca5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_batch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "batch-id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "completed", + "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b", + "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c", + "created_at": 1646126127, + "in_progress_at": 1646126130, + "expires_at": 1646126170, + "finalizing_at": 1646126134, + "completed_at": 1646126136, + "failed_at": null, + "expired_at": null, + "cancelling_at": null, + "cancelled_at": null, + "request_counts": { + "total": 500, + "completed": 400, + "failed": 100 + }, + "metadata": { + "batch_description": "Evaluation job" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_batch.yaml new file mode 100644 index 000000000000..76b11278f6ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_batch.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-10-21 + batch-id: batch_72a2792ef7d24ba7b82c7fe4a37e379f +responses: + "200": + headers: {} + body: + object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: completed + output_file_id: file-f2ddaf43-b48b-46dd-b264-90da10c7a85b + error_file_id: file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c + created_at: 1646126127 + in_progress_at: 1646126130 + expires_at: 1646126170 + finalizing_at: 1646126134 + completed_at: 1646126136 + failed_at: null + expired_at: null + cancelling_at: null + cancelled_at: null + request_counts: + total: 500 + completed: 400 + failed: 100 + metadata: + batch_description: Evaluation job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_batches.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_batches.json new file mode 100644 index 000000000000..9e2d5988c8f2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_batches.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "completed", + "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b", + "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c", + "created_at": 1646126127, + "in_progress_at": 1646126130, + "expires_at": 1646126170, + "finalizing_at": 1646126134, + "completed_at": 1646126136, + "failed_at": null, + "expired_at": null, + "cancelling_at": null, + "cancelled_at": null, + "request_counts": { + "total": 500, + "completed": 400, + "failed": 100 + }, + "first_id": "batch_abc123", + "last_id": "batch_abc456", + "metadata": { + "batch_description": "Evaluation job" + } + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_batches.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_batches.yaml new file mode 100644 index 000000000000..c824c213c304 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_batches.yaml @@ -0,0 +1,37 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-10-21 +responses: + "200": + headers: {} + body: + has_more: false + data: + - object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: completed + output_file_id: file-f2ddaf43-b48b-46dd-b264-90da10c7a85b + error_file_id: file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c + created_at: 1646126127 + in_progress_at: 1646126130 + expires_at: 1646126170 + finalizing_at: 1646126134 + completed_at: 1646126136 + failed_at: null + expired_at: null + cancelling_at: null + cancelled_at: null + request_counts: + total: 500 + completed: 400 + failed: 100 + first_id: batch_abc123 + last_id: batch_abc456 + metadata: + batch_description: Evaluation job + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_file.json new file mode 100644 index 000000000000..17cab3827f83 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_file.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "status": "processed", + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_file.yaml new file mode 100644 index 000000000000..a5378d9646ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_file.yaml @@ -0,0 +1,18 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: + status_details: + metadata: + status: processed + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_file_content.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_file_content.json new file mode 100644 index 000000000000..cb05abfffb7c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_file_content.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": "raw file content" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_file_content.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_file_content.yaml new file mode 100644 index 000000000000..145cfc7c9d2d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_file_content.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-10-21 + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: raw file content diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_files.json new file mode 100644 index 000000000000..569e4cfb7765 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_files.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "status": "processed", + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + { + "status": "processed", + "bytes": 32423, + "purpose": "fine-tune-results", + "filename": "results.csv", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_files.yaml new file mode 100644 index 000000000000..4c662722f0f3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_files.yaml @@ -0,0 +1,28 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 +responses: + 200: + headers: {} + body: + data: + - status_details: + metadata: + status: processed + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + - status_details: + metadata: + status: processed + bytes: 32423 + purpose: fine-tune-results + filename: results.csv + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job.json new file mode 100644 index 000000000000..8076a8e94b28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparameters": { + "n_epochs": -1 + }, + "status": "succeeded", + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "result_files": [ + "file-181a1cbdcdcf4677ada87f63a0928099" + ], + "finished_at": 1646127311, + "trained_tokens": 2342, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job.yaml new file mode 100644 index 000000000000..139b46fbb390 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job.yaml @@ -0,0 +1,27 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + hyperparameters: + n_epochs: -1 + suffix: + seed: + status: succeeded + model: curie + fine_tuned_model: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + - file-181a1cbdcdcf4677ada87f63a0928099 + finished_at: 1646127311 + organisation_id: + trained_tokens: 2342 + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job_checkpoints.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job_checkpoints.json new file mode 100644 index 000000000000..06be04dbf976 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job_checkpoints.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "fine-tuning-job-id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "id": "ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P", + "created_at": 1646126127, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10", + "step_number": 10, + "metrics": { + "step": 10, + "train_loss": 0.478, + "train_mean_token_accuracy": 0.924, + "valid_loss": 10.112, + "valid_mean_token_accuracy": 0.145, + "full_valid_loss": 0.567, + "full_valid_mean_token_accuracy": 0.944 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + }, + { + "id": "ftckpt_frtXDR2453C4FG67t03MLPs5", + "created_at": 1646126137, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20", + "step_number": 20, + "metrics": { + "step": 20, + "train_loss": 0.355, + "train_mean_token_accuracy": 0.947, + "valid_loss": 11.32, + "valid_mean_token_accuracy": 0.122, + "full_valid_loss": 0.317, + "full_valid_mean_token_accuracy": 0.955 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + }, + { + "id": "ftckpt_agLk6Gio560ORp14gl123fgd", + "created_at": 1646126147, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30", + "step_number": 30, + "metrics": { + "step": 30, + "train_loss": 0.155, + "train_mean_token_accuracy": 0.975, + "valid_loss": 9.31, + "valid_mean_token_accuracy": 0.092, + "full_valid_loss": 0.114, + "full_valid_mean_token_accuracy": 0.963 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job_checkpoints.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job_checkpoints.yaml new file mode 100644 index 000000000000..ad9dcef6dd7c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job_checkpoints.yaml @@ -0,0 +1,54 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + fine-tuning-job-id: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + has_more: false + data: + - id: ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P + created_at: 1646126127 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10 + stepNumber: 10 + metrics: + step: 10 + train_loss: 0.478 + train_mean_token_accuracy: 0.924 + valid_loss: 10.112 + valid_mean_token_accuracy: 0.145 + full_valid_loss: 0.567 + full_valid_mean_token_accuracy: 0.944 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + - id: ftckpt_frtXDR2453C4FG67t03MLPs5 + created_at: 1646126137 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20 + stepNumber: 20 + metrics: + step: 20 + train_loss: 0.355 + train_mean_token_accuracy: 0.947 + valid_loss: 11.32 + valid_mean_token_accuracy: 0.122 + full_valid_loss: 0.317 + full_valid_mean_token_accuracy: 0.955 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + - id: ftckpt_agLk6Gio560ORp14gl123fgd + created_at: 1646126147 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30 + stepNumber: 30 + metrics: + step: 30 + train_loss: 0.155 + train_mean_token_accuracy: 0.975 + valid_loss: 9.31 + valid_mean_token_accuracy: 0.092 + full_valid_loss: 0.114 + full_valid_mean_token_accuracy: 0.963 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job_events.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job_events.json new file mode 100644 index 000000000000..45c8867a49e6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job_events.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "id": "ftevent-363dcd7cb4c74539bc53293c1dceef05", + "created_at": 1646126127, + "level": "info", + "message": "Job enqueued. Waiting for jobs ahead to complete.", + "type": "message", + "object": "fine_tuning.job.event" + }, + { + "id": "ftevent-8c2a44999790437cb3230e543fa2cf0f", + "created_at": 1646126169, + "level": "info", + "message": "Job started.", + "type": "message", + "object": "fine_tuning.job.event" + }, + { + "id": "ftevent-2d47d651d2f3484c8187c88c00078147", + "created_at": 1646126192, + "level": "info", + "message": "Job succeeded.", + "type": "message", + "object": "fine_tuning.job.event" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job_events.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job_events.yaml new file mode 100644 index 000000000000..f4c9be926a5a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_job_events.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + has_more: false + data: + - id: ftevent-363dcd7cb4c74539bc53293c1dceef05 + created_at: 1646126127 + level: Info + message: Job enqueued. Waiting for jobs ahead to complete. + type: message + data: + object: fine_tuning.job.event + - id: ftevent-8c2a44999790437cb3230e543fa2cf0f + created_at: 1646126169 + level: Info + message: Job started. + type: message + data: + object: fine_tuning.job.event + - id: ftevent-2d47d651d2f3484c8187c88c00078147 + created_at: 1646126192 + level: Info + message: Job succeeded. + type: message + data: + object: fine_tuning.job.event + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_jobs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_jobs.json new file mode 100644 index 000000000000..71d54e78a449 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_jobs.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "hyperparameters": { + "n_epochs": -1 + }, + "status": "succeeded", + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "result_files": [ + "file-181a1cbdcdcf4677ada87f63a0928099" + ], + "finished_at": 1646127311, + "trained_tokens": 2342, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_jobs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_jobs.yaml new file mode 100644 index 000000000000..d391ba729a3e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_finetuning_jobs.yaml @@ -0,0 +1,29 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 +responses: + 200: + headers: {} + body: + has_more: false + data: + - hyperparameters: + n_epochs: -1 + suffix: + seed: + status: succeeded + model: curie + fine_tuned_model: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + - file-181a1cbdcdcf4677ada87f63a0928099 + finished_at: 1646127311 + organisation_id: + trained_tokens: 2342 + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_model_base.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_model_base.json new file mode 100644 index 000000000000..7d9d9c1464b8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_model_base.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "model-id": "curie" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "status": "succeeded", + "capabilities": { + "fine_tune": true, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "fine_tune": 1677662127, + "inference": 1709284527 + }, + "id": "curie", + "created_at": 1646126127, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_model_base.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_model_base.yaml new file mode 100644 index 000000000000..102f647f1907 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_model_base.yaml @@ -0,0 +1,25 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + model-id: curie +responses: + 200: + headers: {} + body: + status: succeeded + model: + fine_tune: + capabilities: + fine_tune: true + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + fine_tune: 1677662127 + inference: 1709284527 + id: curie + created_at: 1646126127 + object: model diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_model_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_model_finetune.json new file mode 100644 index 000000000000..6941a11cddae --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_model_finetune.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "model-id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "status": "succeeded", + "model": "curie", + "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "capabilities": { + "fine_tune": false, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "inference": 1709284527 + }, + "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_model_finetune.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_model_finetune.yaml new file mode 100644 index 000000000000..26be5fe41f0a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_model_finetune.yaml @@ -0,0 +1,24 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + model-id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + status: succeeded + model: curie + fine_tune: ft-72a2792ef7d24ba7b82c7fe4a37e379f + capabilities: + fine_tune: false + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + inference: 1709284527 + id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: model diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_models.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_models.json new file mode 100644 index 000000000000..57615b5cb926 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_models.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "status": "succeeded", + "capabilities": { + "fine_tune": true, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "fine_tune": 1677662127, + "inference": 1709284527 + }, + "id": "curie", + "created_at": 1646126127, + "object": "model" + }, + { + "status": "succeeded", + "model": "curie", + "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "capabilities": { + "fine_tune": false, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "inference": 1709284527 + }, + "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "model" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_models.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_models.yaml new file mode 100644 index 000000000000..a88e5d3e2edd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/get_models.yaml @@ -0,0 +1,41 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 +responses: + 200: + headers: {} + body: + data: + - status: succeeded + model: + fine_tune: + capabilities: + fine_tune: true + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + fine_tune: 1677662127 + inference: 1709284527 + id: curie + created_at: 1646126127 + object: model + - status: succeeded + model: curie + fine_tune: ft-72a2792ef7d24ba7b82c7fe4a37e379f + capabilities: + fine_tune: false + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + inference: 1709284527 + id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: model + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/import_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/import_file.json new file mode 100644 index 000000000000..583e04cc3242 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/import_file.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "fileImport": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "content_url": "https://www.contoso.com/trainingdata/puppy.jsonl" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099" + }, + "body": { + "status": "pending", + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/import_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/import_file.yaml new file mode 100644 index 000000000000..1666d937937a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/import_file.yaml @@ -0,0 +1,49 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + fileImport: + purpose: fine-tune + filename: puppy.jsonl + content_url: &o0 + absolutePath: /trainingdata/puppy.jsonl + absoluteUri: *o0 + localPath: /trainingdata/puppy.jsonl + authority: www.contoso.com + hostNameType: Dns + isDefaultPort: true + isFile: false + isLoopback: false + pathAndQuery: /trainingdata/puppy.jsonl + segments: + - / + - trainingdata/ + - puppy.jsonl + isUnc: false + host: www.contoso.com + port: 443 + query: '' + fragment: '' + scheme: https + originalString: *o0 + dnsSafeHost: www.contoso.com + idnHost: www.contoso.com + isAbsoluteUri: true + userEscaped: false + userInfo: '' + metadata: + Content-Type: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099 + body: + status_details: + metadata: + status: pending + bytes: + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/post_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/post_batch.json new file mode 100644 index 000000000000..caf8d6fd0ea3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/post_batch.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "batchCreateRequest": { + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "endpoint": "/chat/completions", + "completion_window": "24h", + "metadata": { + "batch_description": "Evaluation job" + } + }, + "content-Type": "application/json" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "validating", + "output_file_id": null, + "error_file_id": null, + "created_at": 1646126127, + "in_progress_at": null, + "expires_at": null, + "finalizing_at": null, + "completed_at": null, + "failed_at": null, + "expired_at": null, + "cancelling_at": null, + "cancelled_at": null, + "request_counts": { + "total": 0, + "completed": 0, + "failed": 0 + }, + "metadata": { + "batch_description": "Evaluation job" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/post_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/post_batch.yaml new file mode 100644 index 000000000000..ac5c826435af --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/post_batch.yaml @@ -0,0 +1,39 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-10-21 + batchCreateRequest: + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + endpoint: /chat/completions + completion_window: 24h + metadata: + batch_description: Evaluation job + content-Type: application/json +responses: + "200": + headers: {} + body: + object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: validating + output_file_id: null + error_file_id: null + created_at: 1646126127 + in_progress_at: null + expires_at: null + finalizing_at: null + completed_at: null + failed_at: null + expired_at: null + cancelling_at: null + cancelled_at: null + request_counts: + total: 0 + completed: 0 + failed: 0 + metadata: + batch_description: Evaluation job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/post_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/post_finetuning_job.json new file mode 100644 index 000000000000..f010ff57daf9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/post_finetuning_job.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "fineTuningJob": { + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "body": { + "hyperparameters": { + "n_epochs": -1 + }, + "status": "pending", + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/post_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/post_finetuning_job.yaml new file mode 100644 index 000000000000..6457644b802c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/post_finetuning_job.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + fineTuningJob: + hyperparameters: + suffix: + seed: + model: curie + trainingFile: file-181a1cbdcdcf4677ada87f63a0928099 + validationFile: + Content-Type: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f + body: + hyperparameters: + n_epochs: -1 + suffix: + seed: + status: pending + model: curie + fine_tuned_model: + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + finished_at: + organisation_id: + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file.json new file mode 100644 index 000000000000..8496ceaaad9b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "purpose": "fine-tune", + "content-Type": "multipart/form-data", + "file": "raw file content" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099" + }, + "body": { + "status": "pending", + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file.yaml new file mode 100644 index 000000000000..4e3187076632 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file.yaml @@ -0,0 +1,21 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + purpose: fine-tune + Content-Type: multipart/form-data + file: raw file content +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099 + body: + status_details: + metadata: + status: pending + bytes: + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_cancel.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_cancel.json new file mode 100644 index 000000000000..3efd6f0ee359 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_cancel.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "upload-id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 2097152, + "filename": "training_data_v21.jsonl", + "purpose": "fine-tune", + "status": "cancelled", + "expires_at": 1646133327, + "file": { + "status": "processed", + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_cancel.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_cancel.yaml new file mode 100644 index 000000000000..b9836a7c3537 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_cancel.yaml @@ -0,0 +1,27 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + upload-id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + bytes: 2097152 + filename: training_data_v21.jsonl + purpose: fine-tune + status: cancelled + expires_at: 1646133327 + file: + status_details: + metadata: + status: processed + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_complete.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_complete.json new file mode 100644 index 000000000000..f7b9ff3433ea --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_complete.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "upload-id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "body": { + "part_ids": [ + "LnmictL3p0u4LH/ko343nw==", + "LmmictL3p0u4LH/ko343nw==" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 2097152, + "filename": "training_data_v21.jsonl", + "purpose": "fine-tune", + "status": "completed", + "expires_at": 1646133327, + "file": { + "status": "processed", + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_complete.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_complete.yaml new file mode 100644 index 000000000000..7296941330c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_complete.yaml @@ -0,0 +1,32 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + upload-id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + body: + part_ids: + - LnmictL3p0u4LH/ko343nw== + - LmmictL3p0u4LH/ko343nw== + md5: +responses: + 200: + headers: {} + body: + bytes: 2097152 + filename: training_data_v21.jsonl + purpose: fine-tune + status: completed + expires_at: 1646133327 + file: + status_details: + metadata: + status: processed + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_part.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_part.json new file mode 100644 index 000000000000..16d98195a4cd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_part.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "upload-id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "data": "raw file content", + "content-Type": "multipart/form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "upload_id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "azure_block_id": "LnmictL3p0u4LH/ko343nw==", + "id": "uplprt-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload.part" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_part.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_part.yaml new file mode 100644 index 000000000000..061c4d30d636 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_part.yaml @@ -0,0 +1,16 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + upload-id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + data: raw file content + Content-Type: multipart/form-data +responses: + 200: + headers: {} + body: + upload_id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + azure_block_id: LnmictL3p0u4LH/ko343nw== + id: uplprt-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload.part diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_start.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_start.json new file mode 100644 index 000000000000..6f1e048426fd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_start.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-10-21", + "body": { + "purpose": "fine-tune", + "filename": "training_data_v21.jsonl", + "bytes": 2097152, + "mime_type": "application/json" + } + }, + "responses": { + "200": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "body": { + "bytes": 2097152, + "filename": "training_data_v21.jsonl", + "purpose": "fine-tune", + "status": "pending", + "expires_at": 1646133327, + "file": { + "status": "processed", + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_start.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_start.yaml new file mode 100644 index 000000000000..371df99f6959 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2024-10-21/examples/upload_file_start.yaml @@ -0,0 +1,32 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-10-21 + body: + purpose: fine-tune + filename: training_data_v21.jsonl + bytes: 2097152 + mimeType: application/json +responses: + 200: + headers: + Location: https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + body: + bytes: 2097152 + filename: training_data_v21.jsonl + purpose: fine-tune + status: pending + expires_at: 1646133327 + file: + status_details: + metadata: + status: processed + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md index 7fcfb0378a9c..d9291ee7d8e0 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md @@ -280,3 +280,10 @@ These settings apply only when `--tag=release_2024_10_01_preview` is specified o ``` yaml $(tag) == 'release_2024_10_01_preview' input-file: preview/2024-09-01-preview/inference.json ``` + +## AzureOpenAI 2024-10-21 +These settings apply only when `--tag=release_2024_10_21` is specified on the command line. + +``` yaml $(tag) == 'release_2024_10_21' +input-file: stable/2024-10-21/inference.json +``` diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_transcription_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_transcription_object.json new file mode 100644 index 000000000000..e5a1e7445d35 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_transcription_object.json @@ -0,0 +1,15 @@ +{ + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deployment-id": "" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_transcription_object.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_transcription_object.yaml new file mode 100644 index 000000000000..eafac2da0519 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_transcription_object.yaml @@ -0,0 +1,9 @@ +parameters: + api-version: 2024-10-21 + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + body: + text: A structured object when requesting json or verbose_json +title: Gets transcribed text and associated metadata from provided spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_transcription_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_transcription_text.json new file mode 100644 index 000000000000..161f2a228047 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_transcription_text.json @@ -0,0 +1,15 @@ +{ + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deployment-id": "", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "type": "string", + "example": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_transcription_text.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_transcription_text.yaml new file mode 100644 index 000000000000..f87f8c3165b0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_transcription_text.yaml @@ -0,0 +1,19 @@ +parameters: + api-version: 2024-10-21 + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + example: plain text when requesting text, srt, or vtt + type: string +title: Gets transcribed text and associated metadata from provided spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_translation_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_translation_object.json new file mode 100644 index 000000000000..9966f133877d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_translation_object.json @@ -0,0 +1,16 @@ +{ + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deployment-id": "", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_translation_object.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_translation_object.yaml new file mode 100644 index 000000000000..5e0650384346 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_translation_object.yaml @@ -0,0 +1,20 @@ +parameters: + api-version: 2024-10-21 + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + body: + text: A structured object when requesting json or verbose_json +title: Gets English language transcribed text and associated metadata from provided + spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_translation_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_translation_text.json new file mode 100644 index 000000000000..a1323ed52881 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_translation_text.json @@ -0,0 +1,15 @@ +{ + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deployment-id": "", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "type": "string", + "example": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_translation_text.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_translation_text.yaml new file mode 100644 index 000000000000..bbce9835ca3d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/audio_translation_text.yaml @@ -0,0 +1,20 @@ +parameters: + api-version: 2024-10-21 + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: + endpoint: '{endpoint}' +responses: + '200': + example: plain text when requesting text, srt, or vtt + type: string +title: Gets English language transcribed text and associated metadata from provided + spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions.json new file mode 100644 index 000000000000..8a7871acd6ba --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions.json @@ -0,0 +1,43 @@ +{ + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!" + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions.yaml new file mode 100644 index 000000000000..eed0ab72ad87 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions.yaml @@ -0,0 +1,45 @@ +title: Creates a completion for the provided prompt, parameters and chosen model. +parameters: + endpoint: '{endpoint}' + api-version: 2024-10-21 + deployment-id: + body: + messages: + - role: system + content: you are a helpful assistant that talks like a pirate + - role: user + content: can you tell me how to care for a parrot? +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: |- + Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy: + + 1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr! + + 2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh! + + 3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands! + + 4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh! + + 5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr! + + 6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag! + + 7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be. + + 8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners. + + So there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' "Yo-ho-ho" for many years to come! Good luck, sailor, and may the wind be at yer back! + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..d240d70e8f92 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_azure_search_advanced.json @@ -0,0 +1,96 @@ +{ + "title": "Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a cat?" + }, + { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "intent": "cat care" + } + }, + { + "role": "user", + "content": "how about dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "authentication": { + "type": "user_assigned_managed_identity", + "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" + }, + "index_name": "{index name}", + "query_type": "vector", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "in_scope": true, + "top_n_documents": 5, + "strictness": 3, + "role_information": "You are an AI assistant that helps people find information.", + "fields_mapping": { + "content_fields_separator": "\\n", + "content_fields": [ + "content" + ], + "filepath_field": "filepath", + "title_field": "title", + "url_field": "url", + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content 2.", + "title": "Citation Title 2", + "filepath": "contoso2.txt", + "url": "https://contoso.blob.windows.net/container/contoso2.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_azure_search_advanced.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_azure_search_advanced.yaml new file mode 100644 index 000000000000..627608d6c28a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_azure_search_advanced.yaml @@ -0,0 +1,63 @@ +title: Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity. +parameters: + endpoint: '{endpoint}' + api-version: 2024-10-21 + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a cat? + - role: assistant + content: Content of the completion [doc1]. + context: + intent: cat care + - role: user + content: how about dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + authentication: + type: user_assigned_managed_identity + managed_identity_resource_id: /subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name} + index_name: '{index name}' + query_type: vector + embedding_dependency: + type: deployment_name + deployment_name: '{embedding deployment name}' + in_scope: true + top_n_documents: 5 + strictness: 3 + role_information: You are an AI assistant that helps people find information. + fields_mapping: + content_fields_separator: \n + content_fields: + - content + filepath_field: filepath + title_field: title + url_field: url + vector_fields: + - contentvector +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content 2. + title: Citation Title 2 + filepath: contoso2.txt + url: https://contoso.blob.windows.net/container/contoso2.txt + chunk_id: '0' + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..2a1e63ce9ab4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_azure_search_minimum.json @@ -0,0 +1,63 @@ +{ + "title": "Creates a completion based on Azure Search data and system-assigned managed identity.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "authentication": { + "type": "system_assigned_managed_identity" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_azure_search_minimum.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_azure_search_minimum.yaml new file mode 100644 index 000000000000..ca9c6d07e7cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_azure_search_minimum.yaml @@ -0,0 +1,39 @@ +title: Creates a completion based on Azure Search data and system-assigned managed identity. +parameters: + endpoint: '{endpoint}' + api-version: 2024-10-21 + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + index_name: '{index name}' + authentication: + type: system_assigned_managed_identity +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: '0' + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_cosmos_db.json new file mode 100644 index 000000000000..33186328a08a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_cosmos_db.json @@ -0,0 +1,77 @@ +{ + "title": "Creates a completion for the provided Azure Cosmos DB.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_cosmos_db", + "parameters": { + "authentication": { + "type": "connection_string", + "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" + }, + "database_name": "vectordb", + "container_name": "azuredocs", + "index_name": "azuredocindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_cosmos_db.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_cosmos_db.yaml new file mode 100644 index 000000000000..be82f32152a4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/chat_completions_cosmos_db.yaml @@ -0,0 +1,49 @@ +title: Creates a completion for the provided Azure Cosmos DB. +parameters: + endpoint: '{endpoint}' + api-version: 2024-10-21 + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_cosmos_db + parameters: + authentication: + type: connection_string + connection_string: mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000 + database_name: vectordb + container_name: azuredocs + index_name: azuredocindex + embedding_dependency: + type: deployment_name + deployment_name: '{embedding deployment name}' + fields_mapping: + content_fields: + - content + vector_fields: + - contentvector +responses: + '200': + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: '0' + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/completions.json new file mode 100644 index 000000000000..4c222a1db7f2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/completions.json @@ -0,0 +1,38 @@ +{ + "operationId": "GetCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "body": { + "prompt": [ + "tell me a joke about mango" + ], + "max_tokens": 32, + "temperature": 1.0, + "n": 1 + } + }, + "responses": { + "200": { + "body": { + "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq", + "created": 1686617332, + "choices": [ + { + "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.", + "index": 0, + "finish_reason": "stop", + "logprobs": null + } + ], + "usage": { + "completion_tokens": 20, + "prompt_tokens": 6, + "total_tokens": 26 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/embeddings.json new file mode 100644 index 000000000000..3ee10ef57f51 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/embeddings.json @@ -0,0 +1,1566 @@ +{ + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deployment-id": "deployment-afa0669ca01e4693ae3a93baf40f26d6", + "body": { + "input": [ + "this is a test" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "index": 0, + "embedding": [ + -0.012838088, + -0.007421397, + -0.017617522, + -0.028278312, + -0.018666342, + 0.01737855, + -0.01821495, + -0.006950092, + -0.009937238, + -0.038580645, + 0.010674067, + 0.02412286, + -0.013647936, + 0.013189907, + 0.0021125758, + 0.012406612, + 0.020790534, + 0.00074595667, + 0.008397198, + -0.00535031, + 0.008968075, + 0.014351576, + -0.014086051, + 0.015055214, + -0.022211088, + -0.025198232, + 0.0065186154, + -0.036350243, + 0.009180495, + -0.009698266, + 0.009446018, + -0.008463579, + -0.0040426035, + -0.03443847, + -0.00091273896, + -0.0019217303, + 0.002349888, + -0.021560553, + 0.016515596, + -0.015572986, + 0.0038666942, + -0.00008432463, + 0.0032178196, + -0.020365695, + -0.009631885, + -0.007647093, + 0.0033837722, + -0.026764825, + -0.010501476, + 0.020219658, + 0.024640633, + -0.0066912062, + -0.036456455, + -0.0040923897, + -0.013966565, + 0.017816665, + 0.005366905, + 0.022835068, + 0.0103488, + -0.0010811808, + -0.028942121, + 0.0074280356, + -0.017033368, + 0.0074877786, + 0.021640211, + 0.002499245, + 0.013316032, + 0.0021524043, + 0.010129742, + 0.0054731146, + 0.03143805, + 0.014856071, + 0.0023366117, + -0.0008243692, + 0.022781964, + 0.003038591, + -0.017617522, + 0.0013309394, + 0.0022154662, + 0.00097414135, + 0.012041516, + -0.027906578, + -0.023817508, + 0.013302756, + -0.003003741, + -0.006890349, + 0.0016744611, + 0.023658194, + -0.015851786, + -0.0045305043, + -0.003038591, + 0.017710455, + 0.019237218, + 0.016037652, + -0.022503164, + 0.025795663, + -0.001129307, + 0.032500144, + -0.008178141, + -0.019940857, + -0.009877495, + 0.00018918588, + 0.023060765, + -0.005692172, + -0.018347712, + -0.011039163, + -0.0062066247, + -0.0000524047, + 0.020126723, + -0.0011691356, + -0.015811957, + 0.020086896, + -0.009114114, + -0.03056182, + 0.0029025099, + -0.006591635, + -0.014046223, + -0.01590489, + -0.02307404, + -0.008861865, + -0.004832538, + 0.010030171, + 0.02311387, + -0.012652221, + 0.024906157, + 0.003860056, + -0.01936998, + -0.02957938, + -0.008357369, + -0.0016371218, + 0.027800368, + 0.0077333883, + 0.021626934, + 0.02140124, + -0.030482162, + 0.026406368, + -0.008277712, + 0.012884554, + -0.043784916, + -0.0145639945, + -0.0070297495, + 0.034889862, + -0.00041508878, + -0.010528029, + -0.009572142, + 0.015692472, + 0.037810627, + -0.0022021902, + 0.008662722, + -0.016794397, + 0.0003090866, + -0.0060506295, + 0.015227805, + 0.0006650548, + 0.01842737, + 0.036801632, + -0.002461076, + -0.0029390194, + -0.0057120863, + -0.012486269, + -0.0046831807, + -0.0017474802, + -0.0036210844, + -0.01178263, + 0.017869769, + 0.039111692, + 0.010946229, + 0.018467197, + 0.0027780454, + -0.005851486, + -0.016489044, + 0.03186289, + -0.040333103, + 0.016648358, + -0.006870435, + 0.0072687212, + 0.000002370982, + 0.006465511, + -0.018201673, + -0.00020526254, + -0.025410652, + 0.02010017, + 0.017537864, + 0.022821793, + 0.0064555537, + -0.0012969191, + 0.02157383, + -0.0053536287, + -0.0087622935, + -0.010952868, + 0.017564416, + 0.02185263, + 0.0004733796, + 0.0018337755, + -0.6954606, + -0.011231667, + 0.02748174, + 0.003929756, + 0.0144843375, + 0.045192193, + 0.01898497, + -0.0070363875, + -0.007813046, + 0.017604245, + -0.017790113, + 0.011165286, + -0.0036376796, + -0.014736585, + 0.0016421003, + -0.019144284, + -0.0072222543, + -0.023127146, + 0.006936816, + 0.025198232, + 0.0030219958, + 0.011722887, + -0.004271618, + -0.0011127117, + -0.0051047, + 0.00077333883, + 0.018599961, + 0.0074877786, + 0.010820106, + 0.0033406245, + -0.015055214, + 0.02384406, + 0.006090458, + 0.00891497, + 0.023366116, + -0.011078991, + -0.019582398, + 0.0011566891, + 0.015413672, + 0.01793615, + -0.014736585, + 0.002492607, + 0.027800368, + 0.023923717, + -0.007421397, + 0.0016105693, + 0.011337877, + -0.015041938, + -0.008768932, + -0.003982861, + 0.002884255, + -0.007832959, + 0.0025457118, + -0.0023548664, + -0.0061767534, + -0.016754568, + 0.0006036523, + 0.0105346665, + 0.0055361767, + 0.01478969, + -0.0011251582, + 0.009605332, + -0.0037140178, + -0.017537864, + -0.021733144, + 0.012897831, + -0.024481317, + 0.022290744, + 0.0056523434, + -0.005366905, + 0.0020412162, + 0.013435517, + -0.003408665, + -0.01705992, + 0.029446619, + 0.022011945, + 0.009226961, + -0.003310753, + -0.007939169, + 0.021308305, + 0.0026718357, + 0.002129171, + -0.020047067, + -0.007474502, + 0.021534001, + -0.0110590765, + -0.018374264, + -0.001664504, + -0.003923118, + 0.015387119, + 0.025516862, + 0.0016421003, + -0.017498035, + -0.01825478, + 0.01451089, + -0.008198055, + -0.011656506, + 0.0044242945, + 0.031491153, + 0.01017621, + -0.010408543, + -0.009034456, + -0.0023283141, + 0.012021601, + 0.015639367, + 0.011736163, + 0.007912617, + 0.02031259, + 0.022104878, + -0.02241023, + 0.00041156227, + -0.009817752, + -0.030880447, + -0.0017823302, + 0.0030933553, + -0.04128899, + -0.0007783174, + 0.012393335, + 0.0122273825, + -0.009087561, + 0.022728859, + -0.002884255, + 0.028065892, + 0.0047396044, + 0.008065294, + 0.015519881, + 0.0133956885, + -0.02279524, + -0.011729525, + 0.0037206558, + -0.0046732235, + 0.003587894, + 0.024401661, + -0.013574918, + 0.012685412, + -0.0041620894, + 0.020578114, + 0.007394845, + 0.014139156, + -0.012512821, + -0.021042781, + 0.022423506, + -0.015360567, + 0.004009413, + 0.0104550095, + -0.024799947, + -0.0081449505, + -0.00063850236, + 0.0070231115, + -0.0009633545, + -0.015705748, + -0.0028942123, + -0.008815398, + 0.007461226, + -0.014417957, + -0.012931022, + 0.0015674217, + -0.02506547, + -0.0063128346, + -0.013422241, + -0.0058614435, + -0.0006007482, + -0.015002109, + 0.0037040606, + -0.008410474, + -0.0016089098, + -0.018653065, + 0.020538285, + -0.016980262, + -0.042244878, + -0.017498035, + 0.006727716, + -0.01877255, + 0.008987989, + 0.00077665783, + -0.0007119364, + -0.0067243967, + 0.0038467797, + -0.018055636, + -0.01440468, + 0.007534245, + 0.0051212953, + 0.002741536, + 0.011523744, + -0.0018603279, + 0.023684746, + 0.016196968, + 0.01731217, + -0.01992758, + 0.009372999, + -0.01982137, + 0.001150051, + -0.014417957, + 0.005672258, + -0.015785405, + 0.0049387473, + -0.0051445286, + 0.012632307, + 0.0011666464, + 0.024587527, + 0.04259006, + -0.0025672857, + 0.02311387, + -0.014524166, + 0.0013848739, + -0.04105002, + -0.010089914, + -0.009087561, + 0.015440224, + 0.009207047, + 0.0128048975, + -0.030216638, + -0.02549031, + 0.00499849, + 0.02737553, + 0.024985814, + -0.015055214, + 0.007580712, + -0.003979542, + 0.0016304837, + 0.0010446712, + 0.0033373055, + 0.0066314633, + -0.011948583, + -0.021281753, + 0.012161002, + 0.030747686, + 0.03555367, + 0.023751127, + -0.03159736, + -0.0110590765, + 0.015758853, + -0.0012197511, + -0.0023249951, + -0.0007488608, + 0.0074877786, + 0.01643594, + -0.008098484, + 0.03730613, + -0.0010056724, + -0.000034798173, + 0.011702972, + 0.039563086, + -0.012280487, + 0.027747264, + 0.018387541, + 0.033057746, + -0.004835857, + -0.00471969, + 0.025450481, + -0.0051146573, + 0.014603823, + 0.00022258384, + 0.00060863094, + 0.015665919, + -0.021626934, + -0.013674489, + 0.0062066247, + 0.018560132, + 0.031942543, + 0.012054792, + 0.004902238, + 0.0028510645, + -0.027667606, + 0.009817752, + -0.002580562, + 0.0069036256, + 0.020047067, + -0.009704905, + -0.012619031, + -0.0056755766, + -0.0036443176, + 0.019383255, + 0.0030701219, + 0.024972538, + 0.009100837, + 0.026353262, + 0.012758431, + 0.029074885, + 0.021202097, + -0.0038102702, + -0.032048754, + 0.003996137, + 0.0029738694, + 0.0032277768, + -0.026127568, + -0.02213143, + 0.0028742978, + 0.0010637557, + 0.000580419, + 0.0021789568, + 0.00083764544, + 0.026924139, + -0.03265946, + 0.0059211864, + 0.021892458, + 0.01178263, + 0.0018188398, + 0.009718181, + -0.020047067, + 0.017989255, + 0.0046035233, + -0.010561219, + -0.010342162, + 0.009505761, + -0.018334435, + -0.00667793, + -0.024534423, + 0.00035347888, + 0.00082561385, + -0.006143563, + 0.016820949, + -0.0013500239, + -0.0069832825, + 0.015347291, + -0.005094743, + 0.001838754, + 0.017073197, + 0.02521151, + 0.006209944, + -0.015612815, + -0.009744733, + -0.019794818, + 0.007786493, + 0.037624758, + 0.017564416, + 0.0076802834, + 0.0026203906, + 0.0022403593, + -0.024560975, + -0.04062518, + -0.016581977, + 0.00789934, + 0.0099305995, + 0.006996559, + 0.011078991, + 0.016236795, + -0.0068969876, + 0.01374087, + 0.014922452, + -0.0042882133, + 0.00022901449, + -0.0006692036, + 0.001359981, + -0.00007581957, + 0.0042616613, + 0.0066381013, + 0.012512821, + 0.021534001, + 0.0032775626, + 0.016913882, + -0.00789934, + -0.009200408, + -0.020286039, + -0.017033368, + 0.014378128, + 0.009233599, + 0.0070828544, + -0.013229736, + 0.025928425, + -0.011862287, + 0.008383922, + 0.012632307, + -0.0003097089, + 0.007593988, + 0.0059079104, + -0.0026369859, + -0.0262205, + 0.003335646, + -0.0067609064, + -0.0042882133, + 0.008549875, + -0.007600626, + -0.012592479, + 0.028623493, + -0.0030502076, + -0.006989921, + -0.015785405, + 0.010050085, + 0.016714739, + -0.023724575, + -0.006346025, + -0.014245366, + -0.032154962, + -0.03388087, + -0.024308728, + -0.002461076, + -0.003733932, + -0.02195884, + -0.021069333, + -0.022144707, + -0.007872788, + -0.017179407, + -0.009034456, + -0.010893124, + -0.02478667, + -0.020153277, + -0.023976821, + 0.014656927, + 0.0005368565, + -0.015878338, + 0.010123105, + -0.0030717815, + 0.01555971, + 0.0018321159, + -0.036244035, + 0.00017176087, + -0.013375774, + -0.010375353, + 0.026512576, + 0.016581977, + 0.013847079, + 0.015719024, + 0.013223098, + 0.004975257, + -0.0010579474, + -0.0034385365, + -0.029048331, + 0.017298892, + -0.022529716, + 0.008463579, + -0.014723309, + -0.005814977, + -0.009027818, + -0.009738095, + -0.0104682855, + -0.005044957, + 0.007905979, + 0.011656506, + 0.003153098, + -0.0005231654, + 0.019954132, + -0.021985391, + -0.005307162, + 0.0021839354, + -0.025184957, + 0.013926737, + -0.0059908866, + 0.0065717204, + 0.009884133, + -0.0062298584, + 0.03388087, + 0.0028577026, + -0.015931444, + 0.0010986058, + -0.025808938, + 0.0022835068, + 0.014152432, + 0.015227805, + 0.013701041, + -0.007872788, + -0.030614924, + -0.026393091, + 0.0010753724, + -0.016940435, + 0.013647936, + -0.007408121, + -0.024308728, + -0.031915992, + -0.018161846, + 0.00072521257, + 0.028862465, + 0.012234021, + -0.019555846, + -0.027641054, + -0.00082810316, + -0.0019150922, + -0.016276624, + -0.01125822, + -0.034146395, + -0.015294186, + 0.006671292, + -0.015533158, + 0.013674489, + -0.0011766035, + -0.017325444, + -0.023233354, + -0.013189907, + 0.0005580154, + -0.03188944, + -0.007056302, + -0.0059942054, + 0.03411984, + 0.04317421, + 0.029420065, + 0.006488744, + -0.0022436783, + 0.013063784, + 0.00012207884, + 0.008118398, + -0.023246631, + 0.0051909955, + -0.00894816, + 0.0081316745, + 0.0023200165, + 0.011510468, + -0.0005770999, + 0.00016979019, + 0.010129742, + 0.015506605, + -0.0073815687, + 0.0031995648, + -0.026578957, + -0.016674912, + 0.0049652997, + 0.0072687212, + -0.016568702, + -0.001964878, + -0.015692472, + -0.0048955996, + 0.027773816, + 0.012864641, + 0.01594472, + 0.008244522, + 0.017139578, + -0.01772373, + -0.0012521119, + 0.011689696, + 0.0111121815, + -0.0036476366, + 0.0012570905, + -0.007826322, + -0.016754568, + 0.011948583, + -0.0045968853, + 0.023963546, + -0.0052739717, + 0.014656927, + 0.009731457, + 0.010727172, + -0.01705992, + -0.0026071144, + 0.010760362, + 0.000919377, + -0.006365939, + -0.03013698, + -0.010554581, + -0.018613236, + 0.013886908, + 0.029420065, + -0.013030593, + 0.016860778, + -0.019237218, + -0.022118153, + 0.007919255, + -0.0004003605, + 0.046546366, + 0.01349526, + 0.006352663, + 0.014258642, + 0.0031813101, + -0.027017072, + 0.0070828544, + -0.020219658, + 0.0037140178, + 0.023366116, + 0.040386207, + -0.016382834, + -0.0023681426, + 0.0064522345, + 0.016528873, + 0.0006804054, + -0.02891557, + -0.0043545947, + 0.01101261, + -0.0014778073, + -0.018055636, + -0.0077001974, + -0.0358723, + 0.003373815, + -0.00071940426, + -0.011822458, + -0.024295451, + -0.009791199, + -0.026565682, + 0.020989677, + -0.035155386, + 0.01832116, + 0.014776413, + -0.028012788, + -0.007262083, + 0.0030402504, + -0.029446619, + 0.00010174965, + 0.009758009, + 0.03767786, + -0.0154535, + 0.009346447, + 0.016077481, + 0.0041189417, + -0.027800368, + 0.01720596, + -0.011158649, + 0.027800368, + -0.03003077, + -0.0072819972, + 0.0014296811, + 0.0145374425, + 0.0043280423, + -0.017086472, + -0.01611731, + -0.01258584, + -0.016927158, + 0.007607264, + 0.018825656, + 0.011331239, + -0.0057784673, + 0.001569911, + -0.013900184, + -0.014776413, + -0.0050814664, + -0.0012454737, + -0.0115967635, + -0.017458206, + -0.013203184, + -0.0063692583, + -0.01244644, + 0.011882202, + 0.0007708495, + -0.02035242, + 0.016250072, + 0.018414093, + -0.029526275, + 0.012751793, + -0.01555971, + 0.0013840442, + -0.019502742, + 0.0063758963, + 0.0037538463, + -0.035686433, + 0.027534844, + -0.016409386, + -0.03247359, + -0.008782208, + -0.0059842486, + 0.014338299, + 0.009233599, + -0.0053171194, + 0.006160158, + 0.0072952732, + 0.01401967, + 0.008815398, + -0.023790956, + 0.013096974, + -0.0031365028, + 0.005044957, + 0.0005356118, + -0.009379637, + 0.0066248253, + -0.00010724682, + 0.010289057, + 0.008815398, + -0.02279524, + -0.019701885, + -0.0027747264, + 0.016183691, + -0.014205537, + -0.003933075, + -0.013375774, + -0.005751915, + -0.010116466, + 0.004988533, + -0.005904591, + -0.008656085, + -0.017431654, + -0.011988411, + -0.01594472, + 0.00660823, + -0.027216217, + 0.0073218257, + -0.029977666, + -0.004593566, + -0.026671892, + -0.028517283, + -0.0050084474, + 0.009844304, + 0.025729282, + -0.013780698, + -0.026751548, + 0.004905557, + -0.035951957, + -0.026738273, + -0.019768266, + 0.0048690476, + 0.005250738, + 0.0014603822, + -0.018892037, + 0.017683903, + 0.0067177587, + 0.027694158, + -0.002618731, + -0.012419888, + 0.01772373, + -0.0032593077, + 0.006611549, + 0.016648358, + -0.03789028, + -0.023100592, + 0.023684746, + 0.0031248862, + 0.016382834, + 0.019967409, + -0.008941523, + -0.02014, + 0.0073882067, + 0.011357792, + -0.0031796505, + -0.0030253148, + -0.0010206081, + -0.017577693, + -0.009598695, + 0.002915786, + 0.001325131, + -0.0029207645, + -0.010780277, + -0.00325101, + -0.00811176, + -0.00073434, + -0.030083876, + -0.012864641, + -0.012745155, + -0.011769353, + 0.018785827, + -0.008264436, + -0.002675155, + 0.024255622, + 0.005483072, + -0.018480474, + -0.005426648, + 0.015095043, + 0.00044392303, + 0.011271496, + -0.0027548121, + 0.0026884312, + -0.00894816, + -0.015161424, + -0.014975557, + -0.024600804, + 0.004457485, + -0.015519881, + -0.012366783, + -0.012579202, + 0.01478969, + 0.0075541595, + -0.017962702, + -0.0017441611, + -0.014059499, + 0.005499667, + -0.0026884312, + 0.0031929268, + 0.0010853296, + -0.008045379, + 0.017471483, + 0.02590187, + -0.018546855, + -0.007826322, + 0.009333171, + 0.0157323, + 0.000086036016, + 0.004776114, + 0.22155327, + 0.006787459, + -0.0017823302, + 0.024919434, + 0.0023449094, + 0.03210186, + 0.0047329664, + -0.010879848, + 0.0044342517, + 0.015334014, + 0.029499723, + 0.019715162, + -0.008569789, + -0.0018901994, + -0.0077400263, + -0.019210665, + -0.005088105, + -0.023153698, + -0.032739118, + -0.029313855, + 0.00082146504, + -0.0212552, + 0.0044309325, + -0.005446562, + 0.018613236, + -0.009751371, + -0.013023955, + -0.001996409, + 0.01915756, + 0.017431654, + -0.031092867, + -0.0070231115, + 0.025330994, + -0.00018099198, + -0.025131851, + -0.011025886, + 0.0116498675, + -0.02506547, + 0.029234199, + -0.012287126, + 0.0069766445, + 0.0018752636, + 0.014271918, + 0.005108019, + -0.0109064, + 0.014391404, + 0.0062597296, + -0.031411495, + 0.00014935728, + 0.013236375, + -0.02891557, + -0.0006671292, + 0.008662722, + 0.012161002, + 0.020963125, + -0.0133691365, + 0.02653913, + -0.017989255, + 0.007978998, + 0.0093398085, + -0.02024621, + 0.03265946, + -0.02846418, + 0.025397375, + -0.024693737, + -0.0027050264, + -0.019330151, + -0.0104417335, + 0.015626092, + -0.006541849, + 0.004653309, + -0.025118576, + 0.0038268655, + 0.004045923, + -0.017564416, + -0.02444149, + 0.030296294, + 0.028756255, + 0.03927101, + 0.010767001, + -0.012034878, + -0.007122683, + -0.022476612, + -0.034942966, + -0.028411074, + -0.03927101, + -0.0037505273, + -0.0038799702, + -0.00037111135, + -0.009718181, + -0.013455432, + -0.015400395, + -0.0066978442, + -0.010760362, + 0.015121595, + 0.03111942, + 0.007992274, + 0.0270569, + -0.003104972, + 0.010056724, + -0.018414093, + 0.006472149, + 0.021281753, + 0.0043579135, + -0.00021490853, + 0.0008546556, + -0.01269205, + -0.003936394, + 0.0008870163, + 0.0009816092, + 0.0054664765, + -0.031278733, + 0.017245788, + 0.00027734818, + 0.005161124, + 0.0048093046, + -0.003923118, + -0.027149836, + 0.006950092, + -0.00615352, + 0.014205537, + 0.0016620146, + 0.0047396044, + 0.0039994563, + -0.015440224, + -0.0055627287, + -0.026273604, + 0.0013276202, + 0.0021009592, + -0.034810204, + 0.0064522345, + 0.00042608313, + 0.02307404, + -0.005957696, + 0.0016869075, + -0.0032775626, + -0.009041094, + -0.01227385, + -0.04349284, + 0.015652644, + 0.013468708, + -0.0023249951, + -0.011171925, + 0.0030352718, + -0.0061203293, + -0.023153698, + 0.046068422, + -0.005582643, + -0.02405648, + 0.005433286, + -0.02814555, + -0.0036874653, + 0.0067841397, + 0.006628144, + 0.029844904, + -0.0044276137, + -0.029127989, + -0.04548427, + 0.022091601, + 0.0038069512, + -0.030269742, + 0.0051578046, + 0.043572497, + -0.0144843375, + -0.02891557, + -0.010461648, + -0.17375894, + 0.029154541, + 0.019648781, + -0.00038335036, + 0.0029572742, + -0.0026469429, + 0.035925403, + -0.012021601, + 0.0015566348, + -0.0033124126, + 0.0010430117, + -0.010620962, + -0.022582822, + 0.00601412, + 0.008364008, + -0.0016586956, + -0.0011102224, + -0.013860356, + 0.022542993, + 0.020564837, + 0.018414093, + -0.008908332, + 0.032951534, + -0.011908754, + 0.010169571, + -0.011198477, + 0.0029108075, + 0.033084296, + 0.0029008503, + -0.0010015236, + -0.019794818, + 0.005844848, + 0.011669782, + 0.0052208668, + 0.010129742, + 0.0037737607, + 0.02880936, + -0.018599961, + -0.015095043, + 0.026578957, + 0.019662056, + 0.006823968, + -0.00045885876, + -0.019396532, + -0.0047993474, + 0.017192682, + 0.039589636, + -0.00874238, + 0.02146762, + -0.007667007, + 0.018785827, + -0.012758431, + -0.010010257, + -0.02052501, + 0.016090758, + 0.0061867107, + -0.0145507185, + 0.008065294, + 0.0104284575, + -0.0022386997, + -0.008324179, + -0.021640211, + 0.01705992, + -0.010541305, + -0.01639611, + -0.0074413116, + -0.034703992, + 0.007016473, + -0.003083398, + 0.0013691084, + -0.005108019, + -0.007886064, + 0.00053270767, + -0.018865485, + 0.025503585, + 0.005101381, + -0.027534844, + 0.015028661, + -0.009286704, + 0.006233177, + 0.00004343289, + 0.036031615, + 0.00957878, + 0.019250493, + 0.0024411618, + 0.0023664832, + -0.0030269742, + -0.007939169, + 0.0058581247, + 0.00587472, + 0.036589216, + -0.035288148, + -0.012997403, + -0.0110989055, + -0.002492607, + 0.008151589, + -0.008085207, + -0.00734174, + -0.0016802694, + 0.008403837, + -0.007793131, + -0.003913161, + -0.025437204, + 0.027123282, + 0.019330151, + -0.008729103, + 0.003943032, + 0.010289057, + 0.029977666, + 0.0014836156, + -0.024282174, + -0.0024361832, + 0.0110325245, + 0.021719867, + 0.012844726, + 0.015002109, + 0.020737428, + -0.013037231, + 0.014802966, + -0.0027332383, + 0.041634172, + -0.00926679, + -0.018759275, + 0.018666342, + 0.005386819, + -0.008822037, + -0.068399, + -0.054804165, + 0.027800368, + 0.04954679, + -0.00437119, + 0.029127989, + 0.03180978, + 0.021321582, + -0.022503164, + 0.010554581, + -0.006823968, + -0.021387963, + -0.021865906, + -0.0074479496, + 0.0037206558, + 0.004132218, + 0.01073381, + -0.0021673401, + -0.0012819833, + 0.041235887, + -0.010202762, + 0.004839176, + 0.0081715025, + -0.030402504, + -0.023764404, + -0.010800191, + -0.018374264, + 0.033641897, + 0.005416691, + -0.0055096243, + -0.0032775626, + -0.018095464, + 0.008563151, + -0.02339267, + -0.013674489, + 0.0023382711, + -0.028411074, + -0.0024063117, + 0.026658615, + -0.012413249, + 0.009333171, + 0.026446195, + -0.009107475, + -0.024560975, + 0.0011085629, + -0.02395027, + 0.0013857037, + 0.01926377, + -0.0020710877, + -0.031278733, + -0.015095043, + 0.0041720467, + -0.012798259, + 0.010162933, + 0.0063128346, + -0.010972782, + 0.045617033, + 0.016874054, + -0.010368714, + -0.0055992384, + -0.0092999805, + 0.0015782086, + -0.013581555, + 0.017843217, + -0.01615714, + 0.0036575939, + -0.027110007, + -0.013621384, + 0.022197811, + 0.0013964906, + -0.007348378, + 0.0145772705, + -0.003996137, + 0.0008364008, + -0.03411984, + 0.013030593, + -0.021454344, + -0.05034336, + 0.021095887, + -0.0055029863, + -0.025623072, + -0.023525432, + 0.007335102, + -0.043413185, + 0.016316453, + 0.016196968, + 0.0093132565, + -0.0110989055, + 0.0154535, + -0.045218747, + 0.0037737607, + 0.01639611, + 0.019887751, + -0.023366116, + -0.024043202, + 0.014258642, + 0.004271618, + -0.006877073, + 0.021387963, + -0.0019781543, + -0.036350243, + -0.009114114, + -0.037359234, + 0.01919739, + 0.011829097, + -0.015665919, + -0.0015591241, + 0.0144843375, + -0.003139822, + -0.024083031, + -0.015307462, + -0.0040990277, + -0.013223098, + 0.0024278855, + -0.008702551, + -0.0033207103, + -0.009804476, + -0.010554581, + 0.031066315, + 0.0044408897, + 0.025370823, + 0.009406189, + 0.025583243, + -0.002066109, + 0.015267633, + 0.008337456, + -0.009426104, + 0.01590489, + -0.011716249, + 0.007713474, + -0.029552827, + -0.013900184, + 0.0050150855, + -0.01650232, + -0.0015757193, + 0.008549875, + -0.020471904, + 0.008397198, + -0.013136802, + 0.021520725, + 0.0060406723, + 0.012858002, + -0.004723009, + -0.029313855, + 0.009240237, + -0.0212552, + -0.028118998, + 0.017803388, + -0.0314646, + 0.012353507, + 0.029632485, + -0.000016128512, + 0.016966987, + 0.009711542, + -0.037253026, + -0.015095043, + 0.013442155, + -0.00905437, + -0.000982439, + -0.0020495139, + 0.008337456, + -0.020644495, + 0.042085562, + -0.000744712, + 0.021135716, + -0.0072886352, + 0.01643594, + 0.013767422, + -0.0044707614, + -0.014763137, + 0.018852208, + -0.03080079, + -0.0049188333, + 0.0058846767, + 0.008330817, + 0.008257798, + 0.024202518, + 0.02307404, + 0.011065715, + 0.00036053188, + -0.00049412367, + 0.036270585, + 0.027043626, + 0.011902116, + -0.027773816, + 0.013289479, + 0.018374264, + -0.0033157317, + 0.0016636741, + 0.0020677685, + -0.012293763, + 0.008184779, + -0.034252603, + 0.010753725, + 0.008675998, + 0.00968499, + -0.003793675, + -0.011218391, + 0.010375353, + -0.0005737809, + 0.019781543, + 0.020591391, + 0.019954132, + -0.00053976063, + -0.0059444197, + -0.022675755, + -0.010003619, + 0.0038467797, + -0.0212552, + -0.033482585, + -0.015572986, + 0.0037737607, + 0.01451089, + 0.0036376796, + 0.007454588, + 0.013979842, + -0.013402327, + 0.014975557, + -0.010435095, + 0.0151747, + -0.030375952, + 0.023166973, + -0.0024760119, + -0.005881358, + 0.019914305, + -0.008596341, + 0.017737007, + -0.0036111271, + 0.012499545, + -0.02647275, + 0.0053901384, + 0.008556513, + 0.019648781, + 0.00874238, + -0.012439802, + -0.028623493, + -0.022330573, + -0.0029340407, + -0.016303178, + 0.007474502, + -0.016555425, + 0.060645696, + 0.0023631642, + -0.012054792, + 0.017604245, + 0.013103612, + 0.026061187, + 0.015533158, + 0.025742557, + 0.00013753316, + -0.013940013, + 0.02880936, + 0.010109829, + -0.0036111271, + -0.012419888, + -0.045457717, + 0.022835068, + -0.014139156, + 0.007819683, + -0.010461648, + -0.012008325, + 0.008895056, + 0.015984548, + 0.024043202, + -0.00059825886, + -0.0036376796, + -0.007939169, + 0.0242689, + -0.022197811, + -0.026313433, + -0.026724996, + 0.010939592, + 0.0023449094, + -0.012074706, + -0.018493751, + 0.017697178, + -0.0052142288, + -0.00360117, + 0.0056058764, + 0.01070062, + 0.0035248317, + 0.023671469, + 0.030880447, + -0.020299314, + -0.0145905465, + 0.018055636, + -0.013727593, + -0.023313012, + 0.013236375, + -0.0020113448 + ] + } + ], + "usage": { + "prompt_tokens": 4, + "total_tokens": 4 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/embeddings.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/embeddings.yaml new file mode 100644 index 000000000000..b62e31fa6129 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/embeddings.yaml @@ -0,0 +1,1553 @@ +title: Return the embeddings for a given prompt. +parameters: + endpoint: "{endpoint}" + api-version: '2024-10-21' + deployment-id: deployment-afa0669ca01e4693ae3a93baf40f26d6 + body: + input: + - this is a test +responses: + '200': + body: + data: + - index: 0 + embedding: + - -0.012838088 + - -0.007421397 + - -0.017617522 + - -0.028278312 + - -0.018666342 + - 0.01737855 + - -0.01821495 + - -0.006950092 + - -0.009937238 + - -0.038580645 + - 0.010674067 + - 0.02412286 + - -0.013647936 + - 0.013189907 + - 0.0021125758 + - 0.012406612 + - 0.020790534 + - 0.00074595667 + - 0.008397198 + - -0.00535031 + - 0.008968075 + - 0.014351576 + - -0.014086051 + - 0.015055214 + - -0.022211088 + - -0.025198232 + - 0.0065186154 + - -0.036350243 + - 0.009180495 + - -0.009698266 + - 0.009446018 + - -0.008463579 + - -0.0040426035 + - -0.03443847 + - -0.00091273896 + - -0.0019217303 + - 0.002349888 + - -0.021560553 + - 0.016515596 + - -0.015572986 + - 0.0038666942 + - -8.432463e-05 + - 0.0032178196 + - -0.020365695 + - -0.009631885 + - -0.007647093 + - 0.0033837722 + - -0.026764825 + - -0.010501476 + - 0.020219658 + - 0.024640633 + - -0.0066912062 + - -0.036456455 + - -0.0040923897 + - -0.013966565 + - 0.017816665 + - 0.005366905 + - 0.022835068 + - 0.0103488 + - -0.0010811808 + - -0.028942121 + - 0.0074280356 + - -0.017033368 + - 0.0074877786 + - 0.021640211 + - 0.002499245 + - 0.013316032 + - 0.0021524043 + - 0.010129742 + - 0.0054731146 + - 0.03143805 + - 0.014856071 + - 0.0023366117 + - -0.0008243692 + - 0.022781964 + - 0.003038591 + - -0.017617522 + - 0.0013309394 + - 0.0022154662 + - 0.00097414135 + - 0.012041516 + - -0.027906578 + - -0.023817508 + - 0.013302756 + - -0.003003741 + - -0.006890349 + - 0.0016744611 + - 0.023658194 + - -0.015851786 + - -0.0045305043 + - -0.003038591 + - 0.017710455 + - 0.019237218 + - 0.016037652 + - -0.022503164 + - 0.025795663 + - -0.001129307 + - 0.032500144 + - -0.008178141 + - -0.019940857 + - -0.009877495 + - 0.00018918588 + - 0.023060765 + - -0.005692172 + - -0.018347712 + - -0.011039163 + - -0.0062066247 + - -5.24047e-05 + - 0.020126723 + - -0.0011691356 + - -0.015811957 + - 0.020086896 + - -0.009114114 + - -0.03056182 + - 0.0029025099 + - -0.006591635 + - -0.014046223 + - -0.01590489 + - -0.02307404 + - -0.008861865 + - -0.004832538 + - 0.010030171 + - 0.02311387 + - -0.012652221 + - 0.024906157 + - 0.003860056 + - -0.01936998 + - -0.02957938 + - -0.008357369 + - -0.0016371218 + - 0.027800368 + - 0.0077333883 + - 0.021626934 + - 0.02140124 + - -0.030482162 + - 0.026406368 + - -0.008277712 + - 0.012884554 + - -0.043784916 + - -0.0145639945 + - -0.0070297495 + - 0.034889862 + - -0.00041508878 + - -0.010528029 + - -0.009572142 + - 0.015692472 + - 0.037810627 + - -0.0022021902 + - 0.008662722 + - -0.016794397 + - 0.0003090866 + - -0.0060506295 + - 0.015227805 + - 0.0006650548 + - 0.01842737 + - 0.036801632 + - -0.002461076 + - -0.0029390194 + - -0.0057120863 + - -0.012486269 + - -0.0046831807 + - -0.0017474802 + - -0.0036210844 + - -0.01178263 + - 0.017869769 + - 0.039111692 + - 0.010946229 + - 0.018467197 + - 0.0027780454 + - -0.005851486 + - -0.016489044 + - 0.03186289 + - -0.040333103 + - 0.016648358 + - -0.006870435 + - 0.0072687212 + - 2.370982e-06 + - 0.006465511 + - -0.018201673 + - -0.00020526254 + - -0.025410652 + - 0.02010017 + - 0.017537864 + - 0.022821793 + - 0.0064555537 + - -0.0012969191 + - 0.02157383 + - -0.0053536287 + - -0.0087622935 + - -0.010952868 + - 0.017564416 + - 0.02185263 + - 0.0004733796 + - 0.0018337755 + - -0.6954606 + - -0.011231667 + - 0.02748174 + - 0.003929756 + - 0.0144843375 + - 0.045192193 + - 0.01898497 + - -0.0070363875 + - -0.007813046 + - 0.017604245 + - -0.017790113 + - 0.011165286 + - -0.0036376796 + - -0.014736585 + - 0.0016421003 + - -0.019144284 + - -0.0072222543 + - -0.023127146 + - 0.006936816 + - 0.025198232 + - 0.0030219958 + - 0.011722887 + - -0.004271618 + - -0.0011127117 + - -0.0051047 + - 0.00077333883 + - 0.018599961 + - 0.0074877786 + - 0.010820106 + - 0.0033406245 + - -0.015055214 + - 0.02384406 + - 0.006090458 + - 0.00891497 + - 0.023366116 + - -0.011078991 + - -0.019582398 + - 0.0011566891 + - 0.015413672 + - 0.01793615 + - -0.014736585 + - 0.002492607 + - 0.027800368 + - 0.023923717 + - -0.007421397 + - 0.0016105693 + - 0.011337877 + - -0.015041938 + - -0.008768932 + - -0.003982861 + - 0.002884255 + - -0.007832959 + - 0.0025457118 + - -0.0023548664 + - -0.0061767534 + - -0.016754568 + - 0.0006036523 + - 0.0105346665 + - 0.0055361767 + - 0.01478969 + - -0.0011251582 + - 0.009605332 + - -0.0037140178 + - -0.017537864 + - -0.021733144 + - 0.012897831 + - -0.024481317 + - 0.022290744 + - 0.0056523434 + - -0.005366905 + - 0.0020412162 + - 0.013435517 + - -0.003408665 + - -0.01705992 + - 0.029446619 + - 0.022011945 + - 0.009226961 + - -0.003310753 + - -0.007939169 + - 0.021308305 + - 0.0026718357 + - 0.002129171 + - -0.020047067 + - -0.007474502 + - 0.021534001 + - -0.0110590765 + - -0.018374264 + - -0.001664504 + - -0.003923118 + - 0.015387119 + - 0.025516862 + - 0.0016421003 + - -0.017498035 + - -0.01825478 + - 0.01451089 + - -0.008198055 + - -0.011656506 + - 0.0044242945 + - 0.031491153 + - 0.01017621 + - -0.010408543 + - -0.009034456 + - -0.0023283141 + - 0.012021601 + - 0.015639367 + - 0.011736163 + - 0.007912617 + - 0.02031259 + - 0.022104878 + - -0.02241023 + - 0.00041156227 + - -0.009817752 + - -0.030880447 + - -0.0017823302 + - 0.0030933553 + - -0.04128899 + - -0.0007783174 + - 0.012393335 + - 0.0122273825 + - -0.009087561 + - 0.022728859 + - -0.002884255 + - 0.028065892 + - 0.0047396044 + - 0.008065294 + - 0.015519881 + - 0.0133956885 + - -0.02279524 + - -0.011729525 + - 0.0037206558 + - -0.0046732235 + - 0.003587894 + - 0.024401661 + - -0.013574918 + - 0.012685412 + - -0.0041620894 + - 0.020578114 + - 0.007394845 + - 0.014139156 + - -0.012512821 + - -0.021042781 + - 0.022423506 + - -0.015360567 + - 0.004009413 + - 0.0104550095 + - -0.024799947 + - -0.0081449505 + - -0.00063850236 + - 0.0070231115 + - -0.0009633545 + - -0.015705748 + - -0.0028942123 + - -0.008815398 + - 0.007461226 + - -0.014417957 + - -0.012931022 + - 0.0015674217 + - -0.02506547 + - -0.0063128346 + - -0.013422241 + - -0.0058614435 + - -0.0006007482 + - -0.015002109 + - 0.0037040606 + - -0.008410474 + - -0.0016089098 + - -0.018653065 + - 0.020538285 + - -0.016980262 + - -0.042244878 + - -0.017498035 + - 0.006727716 + - -0.01877255 + - 0.008987989 + - 0.00077665783 + - -0.0007119364 + - -0.0067243967 + - 0.0038467797 + - -0.018055636 + - -0.01440468 + - 0.007534245 + - 0.0051212953 + - 0.002741536 + - 0.011523744 + - -0.0018603279 + - 0.023684746 + - 0.016196968 + - 0.01731217 + - -0.01992758 + - 0.009372999 + - -0.01982137 + - 0.001150051 + - -0.014417957 + - 0.005672258 + - -0.015785405 + - 0.0049387473 + - -0.0051445286 + - 0.012632307 + - 0.0011666464 + - 0.024587527 + - 0.04259006 + - -0.0025672857 + - 0.02311387 + - -0.014524166 + - 0.0013848739 + - -0.04105002 + - -0.010089914 + - -0.009087561 + - 0.015440224 + - 0.009207047 + - 0.0128048975 + - -0.030216638 + - -0.02549031 + - 0.00499849 + - 0.02737553 + - 0.024985814 + - -0.015055214 + - 0.007580712 + - -0.003979542 + - 0.0016304837 + - 0.0010446712 + - 0.0033373055 + - 0.0066314633 + - -0.011948583 + - -0.021281753 + - 0.012161002 + - 0.030747686 + - 0.03555367 + - 0.023751127 + - -0.03159736 + - -0.0110590765 + - 0.015758853 + - -0.0012197511 + - -0.0023249951 + - -0.0007488608 + - 0.0074877786 + - 0.01643594 + - -0.008098484 + - 0.03730613 + - -0.0010056724 + - -3.4798173e-05 + - 0.011702972 + - 0.039563086 + - -0.012280487 + - 0.027747264 + - 0.018387541 + - 0.033057746 + - -0.004835857 + - -0.00471969 + - 0.025450481 + - -0.0051146573 + - 0.014603823 + - 0.00022258384 + - 0.00060863094 + - 0.015665919 + - -0.021626934 + - -0.013674489 + - 0.0062066247 + - 0.018560132 + - 0.031942543 + - 0.012054792 + - 0.004902238 + - 0.0028510645 + - -0.027667606 + - 0.009817752 + - -0.002580562 + - 0.0069036256 + - 0.020047067 + - -0.009704905 + - -0.012619031 + - -0.0056755766 + - -0.0036443176 + - 0.019383255 + - 0.0030701219 + - 0.024972538 + - 0.009100837 + - 0.026353262 + - 0.012758431 + - 0.029074885 + - 0.021202097 + - -0.0038102702 + - -0.032048754 + - 0.003996137 + - 0.0029738694 + - 0.0032277768 + - -0.026127568 + - -0.02213143 + - 0.0028742978 + - 0.0010637557 + - 0.000580419 + - 0.0021789568 + - 0.00083764544 + - 0.026924139 + - -0.03265946 + - 0.0059211864 + - 0.021892458 + - 0.01178263 + - 0.0018188398 + - 0.009718181 + - -0.020047067 + - 0.017989255 + - 0.0046035233 + - -0.010561219 + - -0.010342162 + - 0.009505761 + - -0.018334435 + - -0.00667793 + - -0.024534423 + - 0.00035347888 + - 0.00082561385 + - -0.006143563 + - 0.016820949 + - -0.0013500239 + - -0.0069832825 + - 0.015347291 + - -0.005094743 + - 0.001838754 + - 0.017073197 + - 0.02521151 + - 0.006209944 + - -0.015612815 + - -0.009744733 + - -0.019794818 + - 0.007786493 + - 0.037624758 + - 0.017564416 + - 0.0076802834 + - 0.0026203906 + - 0.0022403593 + - -0.024560975 + - -0.04062518 + - -0.016581977 + - 0.00789934 + - 0.0099305995 + - 0.006996559 + - 0.011078991 + - 0.016236795 + - -0.0068969876 + - 0.01374087 + - 0.014922452 + - -0.0042882133 + - 0.00022901449 + - -0.0006692036 + - 0.001359981 + - -7.581957e-05 + - 0.0042616613 + - 0.0066381013 + - 0.012512821 + - 0.021534001 + - 0.0032775626 + - 0.016913882 + - -0.00789934 + - -0.009200408 + - -0.020286039 + - -0.017033368 + - 0.014378128 + - 0.009233599 + - 0.0070828544 + - -0.013229736 + - 0.025928425 + - -0.011862287 + - 0.008383922 + - 0.012632307 + - -0.0003097089 + - 0.007593988 + - 0.0059079104 + - -0.0026369859 + - -0.0262205 + - 0.003335646 + - -0.0067609064 + - -0.0042882133 + - 0.008549875 + - -0.007600626 + - -0.012592479 + - 0.028623493 + - -0.0030502076 + - -0.006989921 + - -0.015785405 + - 0.010050085 + - 0.016714739 + - -0.023724575 + - -0.006346025 + - -0.014245366 + - -0.032154962 + - -0.03388087 + - -0.024308728 + - -0.002461076 + - -0.003733932 + - -0.02195884 + - -0.021069333 + - -0.022144707 + - -0.007872788 + - -0.017179407 + - -0.009034456 + - -0.010893124 + - -0.02478667 + - -0.020153277 + - -0.023976821 + - 0.014656927 + - 0.0005368565 + - -0.015878338 + - 0.010123105 + - -0.0030717815 + - 0.01555971 + - 0.0018321159 + - -0.036244035 + - 0.00017176087 + - -0.013375774 + - -0.010375353 + - 0.026512576 + - 0.016581977 + - 0.013847079 + - 0.015719024 + - 0.013223098 + - 0.004975257 + - -0.0010579474 + - -0.0034385365 + - -0.029048331 + - 0.017298892 + - -0.022529716 + - 0.008463579 + - -0.014723309 + - -0.005814977 + - -0.009027818 + - -0.009738095 + - -0.0104682855 + - -0.005044957 + - 0.007905979 + - 0.011656506 + - 0.003153098 + - -0.0005231654 + - 0.019954132 + - -0.021985391 + - -0.005307162 + - 0.0021839354 + - -0.025184957 + - 0.013926737 + - -0.0059908866 + - 0.0065717204 + - 0.009884133 + - -0.0062298584 + - 0.03388087 + - 0.0028577026 + - -0.015931444 + - 0.0010986058 + - -0.025808938 + - 0.0022835068 + - 0.014152432 + - 0.015227805 + - 0.013701041 + - -0.007872788 + - -0.030614924 + - -0.026393091 + - 0.0010753724 + - -0.016940435 + - 0.013647936 + - -0.007408121 + - -0.024308728 + - -0.031915992 + - -0.018161846 + - 0.00072521257 + - 0.028862465 + - 0.012234021 + - -0.019555846 + - -0.027641054 + - -0.00082810316 + - -0.0019150922 + - -0.016276624 + - -0.01125822 + - -0.034146395 + - -0.015294186 + - 0.006671292 + - -0.015533158 + - 0.013674489 + - -0.0011766035 + - -0.017325444 + - -0.023233354 + - -0.013189907 + - 0.0005580154 + - -0.03188944 + - -0.007056302 + - -0.0059942054 + - 0.03411984 + - 0.04317421 + - 0.029420065 + - 0.006488744 + - -0.0022436783 + - 0.013063784 + - 0.00012207884 + - 0.008118398 + - -0.023246631 + - 0.0051909955 + - -0.00894816 + - 0.0081316745 + - 0.0023200165 + - 0.011510468 + - -0.0005770999 + - 0.00016979019 + - 0.010129742 + - 0.015506605 + - -0.0073815687 + - 0.0031995648 + - -0.026578957 + - -0.016674912 + - 0.0049652997 + - 0.0072687212 + - -0.016568702 + - -0.001964878 + - -0.015692472 + - -0.0048955996 + - 0.027773816 + - 0.012864641 + - 0.01594472 + - 0.008244522 + - 0.017139578 + - -0.01772373 + - -0.0012521119 + - 0.011689696 + - 0.0111121815 + - -0.0036476366 + - 0.0012570905 + - -0.007826322 + - -0.016754568 + - 0.011948583 + - -0.0045968853 + - 0.023963546 + - -0.0052739717 + - 0.014656927 + - 0.009731457 + - 0.010727172 + - -0.01705992 + - -0.0026071144 + - 0.010760362 + - 0.000919377 + - -0.006365939 + - -0.03013698 + - -0.010554581 + - -0.018613236 + - 0.013886908 + - 0.029420065 + - -0.013030593 + - 0.016860778 + - -0.019237218 + - -0.022118153 + - 0.007919255 + - -0.0004003605 + - 0.046546366 + - 0.01349526 + - 0.006352663 + - 0.014258642 + - 0.0031813101 + - -0.027017072 + - 0.0070828544 + - -0.020219658 + - 0.0037140178 + - 0.023366116 + - 0.040386207 + - -0.016382834 + - -0.0023681426 + - 0.0064522345 + - 0.016528873 + - 0.0006804054 + - -0.02891557 + - -0.0043545947 + - 0.01101261 + - -0.0014778073 + - -0.018055636 + - -0.0077001974 + - -0.0358723 + - 0.003373815 + - -0.00071940426 + - -0.011822458 + - -0.024295451 + - -0.009791199 + - -0.026565682 + - 0.020989677 + - -0.035155386 + - 0.01832116 + - 0.014776413 + - -0.028012788 + - -0.007262083 + - 0.0030402504 + - -0.029446619 + - 0.00010174965 + - 0.009758009 + - 0.03767786 + - -0.0154535 + - 0.009346447 + - 0.016077481 + - 0.0041189417 + - -0.027800368 + - 0.01720596 + - -0.011158649 + - 0.027800368 + - -0.03003077 + - -0.0072819972 + - 0.0014296811 + - 0.0145374425 + - 0.0043280423 + - -0.017086472 + - -0.01611731 + - -0.01258584 + - -0.016927158 + - 0.007607264 + - 0.018825656 + - 0.011331239 + - -0.0057784673 + - 0.001569911 + - -0.013900184 + - -0.014776413 + - -0.0050814664 + - -0.0012454737 + - -0.0115967635 + - -0.017458206 + - -0.013203184 + - -0.0063692583 + - -0.01244644 + - 0.011882202 + - 0.0007708495 + - -0.02035242 + - 0.016250072 + - 0.018414093 + - -0.029526275 + - 0.012751793 + - -0.01555971 + - 0.0013840442 + - -0.019502742 + - 0.0063758963 + - 0.0037538463 + - -0.035686433 + - 0.027534844 + - -0.016409386 + - -0.03247359 + - -0.008782208 + - -0.0059842486 + - 0.014338299 + - 0.009233599 + - -0.0053171194 + - 0.006160158 + - 0.0072952732 + - 0.01401967 + - 0.008815398 + - -0.023790956 + - 0.013096974 + - -0.0031365028 + - 0.005044957 + - 0.0005356118 + - -0.009379637 + - 0.0066248253 + - -0.00010724682 + - 0.010289057 + - 0.008815398 + - -0.02279524 + - -0.019701885 + - -0.0027747264 + - 0.016183691 + - -0.014205537 + - -0.003933075 + - -0.013375774 + - -0.005751915 + - -0.010116466 + - 0.004988533 + - -0.005904591 + - -0.008656085 + - -0.017431654 + - -0.011988411 + - -0.01594472 + - 0.00660823 + - -0.027216217 + - 0.0073218257 + - -0.029977666 + - -0.004593566 + - -0.026671892 + - -0.028517283 + - -0.0050084474 + - 0.009844304 + - 0.025729282 + - -0.013780698 + - -0.026751548 + - 0.004905557 + - -0.035951957 + - -0.026738273 + - -0.019768266 + - 0.0048690476 + - 0.005250738 + - 0.0014603822 + - -0.018892037 + - 0.017683903 + - 0.0067177587 + - 0.027694158 + - -0.002618731 + - -0.012419888 + - 0.01772373 + - -0.0032593077 + - 0.006611549 + - 0.016648358 + - -0.03789028 + - -0.023100592 + - 0.023684746 + - 0.0031248862 + - 0.016382834 + - 0.019967409 + - -0.008941523 + - -0.02014 + - 0.0073882067 + - 0.011357792 + - -0.0031796505 + - -0.0030253148 + - -0.0010206081 + - -0.017577693 + - -0.009598695 + - 0.002915786 + - 0.001325131 + - -0.0029207645 + - -0.010780277 + - -0.00325101 + - -0.00811176 + - -0.00073434 + - -0.030083876 + - -0.012864641 + - -0.012745155 + - -0.011769353 + - 0.018785827 + - -0.008264436 + - -0.002675155 + - 0.024255622 + - 0.005483072 + - -0.018480474 + - -0.005426648 + - 0.015095043 + - 0.00044392303 + - 0.011271496 + - -0.0027548121 + - 0.0026884312 + - -0.00894816 + - -0.015161424 + - -0.014975557 + - -0.024600804 + - 0.004457485 + - -0.015519881 + - -0.012366783 + - -0.012579202 + - 0.01478969 + - 0.0075541595 + - -0.017962702 + - -0.0017441611 + - -0.014059499 + - 0.005499667 + - -0.0026884312 + - 0.0031929268 + - 0.0010853296 + - -0.008045379 + - 0.017471483 + - 0.02590187 + - -0.018546855 + - -0.007826322 + - 0.009333171 + - 0.0157323 + - 8.6036016e-05 + - 0.004776114 + - 0.22155327 + - 0.006787459 + - -0.0017823302 + - 0.024919434 + - 0.0023449094 + - 0.03210186 + - 0.0047329664 + - -0.010879848 + - 0.0044342517 + - 0.015334014 + - 0.029499723 + - 0.019715162 + - -0.008569789 + - -0.0018901994 + - -0.0077400263 + - -0.019210665 + - -0.005088105 + - -0.023153698 + - -0.032739118 + - -0.029313855 + - 0.00082146504 + - -0.0212552 + - 0.0044309325 + - -0.005446562 + - 0.018613236 + - -0.009751371 + - -0.013023955 + - -0.001996409 + - 0.01915756 + - 0.017431654 + - -0.031092867 + - -0.0070231115 + - 0.025330994 + - -0.00018099198 + - -0.025131851 + - -0.011025886 + - 0.0116498675 + - -0.02506547 + - 0.029234199 + - -0.012287126 + - 0.0069766445 + - 0.0018752636 + - 0.014271918 + - 0.005108019 + - -0.0109064 + - 0.014391404 + - 0.0062597296 + - -0.031411495 + - 0.00014935728 + - 0.013236375 + - -0.02891557 + - -0.0006671292 + - 0.008662722 + - 0.012161002 + - 0.020963125 + - -0.0133691365 + - 0.02653913 + - -0.017989255 + - 0.007978998 + - 0.0093398085 + - -0.02024621 + - 0.03265946 + - -0.02846418 + - 0.025397375 + - -0.024693737 + - -0.0027050264 + - -0.019330151 + - -0.0104417335 + - 0.015626092 + - -0.006541849 + - 0.004653309 + - -0.025118576 + - 0.0038268655 + - 0.004045923 + - -0.017564416 + - -0.02444149 + - 0.030296294 + - 0.028756255 + - 0.03927101 + - 0.010767001 + - -0.012034878 + - -0.007122683 + - -0.022476612 + - -0.034942966 + - -0.028411074 + - -0.03927101 + - -0.0037505273 + - -0.0038799702 + - -0.00037111135 + - -0.009718181 + - -0.013455432 + - -0.015400395 + - -0.0066978442 + - -0.010760362 + - 0.015121595 + - 0.03111942 + - 0.007992274 + - 0.0270569 + - -0.003104972 + - 0.010056724 + - -0.018414093 + - 0.006472149 + - 0.021281753 + - 0.0043579135 + - -0.00021490853 + - 0.0008546556 + - -0.01269205 + - -0.003936394 + - 0.0008870163 + - 0.0009816092 + - 0.0054664765 + - -0.031278733 + - 0.017245788 + - 0.00027734818 + - 0.005161124 + - 0.0048093046 + - -0.003923118 + - -0.027149836 + - 0.006950092 + - -0.00615352 + - 0.014205537 + - 0.0016620146 + - 0.0047396044 + - 0.0039994563 + - -0.015440224 + - -0.0055627287 + - -0.026273604 + - 0.0013276202 + - 0.0021009592 + - -0.034810204 + - 0.0064522345 + - 0.00042608313 + - 0.02307404 + - -0.005957696 + - 0.0016869075 + - -0.0032775626 + - -0.009041094 + - -0.01227385 + - -0.04349284 + - 0.015652644 + - 0.013468708 + - -0.0023249951 + - -0.011171925 + - 0.0030352718 + - -0.0061203293 + - -0.023153698 + - 0.046068422 + - -0.005582643 + - -0.02405648 + - 0.005433286 + - -0.02814555 + - -0.0036874653 + - 0.0067841397 + - 0.006628144 + - 0.029844904 + - -0.0044276137 + - -0.029127989 + - -0.04548427 + - 0.022091601 + - 0.0038069512 + - -0.030269742 + - 0.0051578046 + - 0.043572497 + - -0.0144843375 + - -0.02891557 + - -0.010461648 + - -0.17375894 + - 0.029154541 + - 0.019648781 + - -0.00038335036 + - 0.0029572742 + - -0.0026469429 + - 0.035925403 + - -0.012021601 + - 0.0015566348 + - -0.0033124126 + - 0.0010430117 + - -0.010620962 + - -0.022582822 + - 0.00601412 + - 0.008364008 + - -0.0016586956 + - -0.0011102224 + - -0.013860356 + - 0.022542993 + - 0.020564837 + - 0.018414093 + - -0.008908332 + - 0.032951534 + - -0.011908754 + - 0.010169571 + - -0.011198477 + - 0.0029108075 + - 0.033084296 + - 0.0029008503 + - -0.0010015236 + - -0.019794818 + - 0.005844848 + - 0.011669782 + - 0.0052208668 + - 0.010129742 + - 0.0037737607 + - 0.02880936 + - -0.018599961 + - -0.015095043 + - 0.026578957 + - 0.019662056 + - 0.006823968 + - -0.00045885876 + - -0.019396532 + - -0.0047993474 + - 0.017192682 + - 0.039589636 + - -0.00874238 + - 0.02146762 + - -0.007667007 + - 0.018785827 + - -0.012758431 + - -0.010010257 + - -0.02052501 + - 0.016090758 + - 0.0061867107 + - -0.0145507185 + - 0.008065294 + - 0.0104284575 + - -0.0022386997 + - -0.008324179 + - -0.021640211 + - 0.01705992 + - -0.010541305 + - -0.01639611 + - -0.0074413116 + - -0.034703992 + - 0.007016473 + - -0.003083398 + - 0.0013691084 + - -0.005108019 + - -0.007886064 + - 0.00053270767 + - -0.018865485 + - 0.025503585 + - 0.005101381 + - -0.027534844 + - 0.015028661 + - -0.009286704 + - 0.006233177 + - 4.343289e-05 + - 0.036031615 + - 0.00957878 + - 0.019250493 + - 0.0024411618 + - 0.0023664832 + - -0.0030269742 + - -0.007939169 + - 0.0058581247 + - 0.00587472 + - 0.036589216 + - -0.035288148 + - -0.012997403 + - -0.0110989055 + - -0.002492607 + - 0.008151589 + - -0.008085207 + - -0.00734174 + - -0.0016802694 + - 0.008403837 + - -0.007793131 + - -0.003913161 + - -0.025437204 + - 0.027123282 + - 0.019330151 + - -0.008729103 + - 0.003943032 + - 0.010289057 + - 0.029977666 + - 0.0014836156 + - -0.024282174 + - -0.0024361832 + - 0.0110325245 + - 0.021719867 + - 0.012844726 + - 0.015002109 + - 0.020737428 + - -0.013037231 + - 0.014802966 + - -0.0027332383 + - 0.041634172 + - -0.00926679 + - -0.018759275 + - 0.018666342 + - 0.005386819 + - -0.008822037 + - -0.068399 + - -0.054804165 + - 0.027800368 + - 0.04954679 + - -0.00437119 + - 0.029127989 + - 0.03180978 + - 0.021321582 + - -0.022503164 + - 0.010554581 + - -0.006823968 + - -0.021387963 + - -0.021865906 + - -0.0074479496 + - 0.0037206558 + - 0.004132218 + - 0.01073381 + - -0.0021673401 + - -0.0012819833 + - 0.041235887 + - -0.010202762 + - 0.004839176 + - 0.0081715025 + - -0.030402504 + - -0.023764404 + - -0.010800191 + - -0.018374264 + - 0.033641897 + - 0.005416691 + - -0.0055096243 + - -0.0032775626 + - -0.018095464 + - 0.008563151 + - -0.02339267 + - -0.013674489 + - 0.0023382711 + - -0.028411074 + - -0.0024063117 + - 0.026658615 + - -0.012413249 + - 0.009333171 + - 0.026446195 + - -0.009107475 + - -0.024560975 + - 0.0011085629 + - -0.02395027 + - 0.0013857037 + - 0.01926377 + - -0.0020710877 + - -0.031278733 + - -0.015095043 + - 0.0041720467 + - -0.012798259 + - 0.010162933 + - 0.0063128346 + - -0.010972782 + - 0.045617033 + - 0.016874054 + - -0.010368714 + - -0.0055992384 + - -0.0092999805 + - 0.0015782086 + - -0.013581555 + - 0.017843217 + - -0.01615714 + - 0.0036575939 + - -0.027110007 + - -0.013621384 + - 0.022197811 + - 0.0013964906 + - -0.007348378 + - 0.0145772705 + - -0.003996137 + - 0.0008364008 + - -0.03411984 + - 0.013030593 + - -0.021454344 + - -0.05034336 + - 0.021095887 + - -0.0055029863 + - -0.025623072 + - -0.023525432 + - 0.007335102 + - -0.043413185 + - 0.016316453 + - 0.016196968 + - 0.0093132565 + - -0.0110989055 + - 0.0154535 + - -0.045218747 + - 0.0037737607 + - 0.01639611 + - 0.019887751 + - -0.023366116 + - -0.024043202 + - 0.014258642 + - 0.004271618 + - -0.006877073 + - 0.021387963 + - -0.0019781543 + - -0.036350243 + - -0.009114114 + - -0.037359234 + - 0.01919739 + - 0.011829097 + - -0.015665919 + - -0.0015591241 + - 0.0144843375 + - -0.003139822 + - -0.024083031 + - -0.015307462 + - -0.0040990277 + - -0.013223098 + - 0.0024278855 + - -0.008702551 + - -0.0033207103 + - -0.009804476 + - -0.010554581 + - 0.031066315 + - 0.0044408897 + - 0.025370823 + - 0.009406189 + - 0.025583243 + - -0.002066109 + - 0.015267633 + - 0.008337456 + - -0.009426104 + - 0.01590489 + - -0.011716249 + - 0.007713474 + - -0.029552827 + - -0.013900184 + - 0.0050150855 + - -0.01650232 + - -0.0015757193 + - 0.008549875 + - -0.020471904 + - 0.008397198 + - -0.013136802 + - 0.021520725 + - 0.0060406723 + - 0.012858002 + - -0.004723009 + - -0.029313855 + - 0.009240237 + - -0.0212552 + - -0.028118998 + - 0.017803388 + - -0.0314646 + - 0.012353507 + - 0.029632485 + - -1.6128512e-05 + - 0.016966987 + - 0.009711542 + - -0.037253026 + - -0.015095043 + - 0.013442155 + - -0.00905437 + - -0.000982439 + - -0.0020495139 + - 0.008337456 + - -0.020644495 + - 0.042085562 + - -0.000744712 + - 0.021135716 + - -0.0072886352 + - 0.01643594 + - 0.013767422 + - -0.0044707614 + - -0.014763137 + - 0.018852208 + - -0.03080079 + - -0.0049188333 + - 0.0058846767 + - 0.008330817 + - 0.008257798 + - 0.024202518 + - 0.02307404 + - 0.011065715 + - 0.00036053188 + - -0.00049412367 + - 0.036270585 + - 0.027043626 + - 0.011902116 + - -0.027773816 + - 0.013289479 + - 0.018374264 + - -0.0033157317 + - 0.0016636741 + - 0.0020677685 + - -0.012293763 + - 0.008184779 + - -0.034252603 + - 0.010753725 + - 0.008675998 + - 0.00968499 + - -0.003793675 + - -0.011218391 + - 0.010375353 + - -0.0005737809 + - 0.019781543 + - 0.020591391 + - 0.019954132 + - -0.00053976063 + - -0.0059444197 + - -0.022675755 + - -0.010003619 + - 0.0038467797 + - -0.0212552 + - -0.033482585 + - -0.015572986 + - 0.0037737607 + - 0.01451089 + - 0.0036376796 + - 0.007454588 + - 0.013979842 + - -0.013402327 + - 0.014975557 + - -0.010435095 + - 0.0151747 + - -0.030375952 + - 0.023166973 + - -0.0024760119 + - -0.005881358 + - 0.019914305 + - -0.008596341 + - 0.017737007 + - -0.0036111271 + - 0.012499545 + - -0.02647275 + - 0.0053901384 + - 0.008556513 + - 0.019648781 + - 0.00874238 + - -0.012439802 + - -0.028623493 + - -0.022330573 + - -0.0029340407 + - -0.016303178 + - 0.007474502 + - -0.016555425 + - 0.060645696 + - 0.0023631642 + - -0.012054792 + - 0.017604245 + - 0.013103612 + - 0.026061187 + - 0.015533158 + - 0.025742557 + - 0.00013753316 + - -0.013940013 + - 0.02880936 + - 0.010109829 + - -0.0036111271 + - -0.012419888 + - -0.045457717 + - 0.022835068 + - -0.014139156 + - 0.007819683 + - -0.010461648 + - -0.012008325 + - 0.008895056 + - 0.015984548 + - 0.024043202 + - -0.00059825886 + - -0.0036376796 + - -0.007939169 + - 0.0242689 + - -0.022197811 + - -0.026313433 + - -0.026724996 + - 0.010939592 + - 0.0023449094 + - -0.012074706 + - -0.018493751 + - 0.017697178 + - -0.0052142288 + - -0.00360117 + - 0.0056058764 + - 0.01070062 + - 0.0035248317 + - 0.023671469 + - 0.030880447 + - -0.020299314 + - -0.0145905465 + - 0.018055636 + - -0.013727593 + - -0.023313012 + - 0.013236375 + - -0.0020113448 + usage: + prompt_tokens: 4 + total_tokens: 4 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_speech.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_speech.json new file mode 100644 index 000000000000..b8a14fb4c214 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_speech.json @@ -0,0 +1,19 @@ +{ + "operationId": "GenerateSpeechFromText", + "title": "Generates text-to-speech audio from the input text.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "body": { + "input": "The text to generate audio for", + "voice": "alloy" + } + }, + "responses": { + "200": { + "content-type": "application/octet-stream", + "body": "RIFF...audio.data.omitted" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_transcription_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_transcription_object.json new file mode 100644 index 000000000000..f212d198016b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_transcription_object.json @@ -0,0 +1,17 @@ +{ + "operationId": "GetAudioTranscriptionAsResponseObject", + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_transcription_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_transcription_text.json new file mode 100644 index 000000000000..86c80021a228 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_transcription_text.json @@ -0,0 +1,16 @@ +{ + "operationId": "GetAudioTranscriptionAsPlainText", + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "type": "string", + "body": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_translation_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_translation_object.json new file mode 100644 index 000000000000..a1fc77ae7e54 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_translation_object.json @@ -0,0 +1,17 @@ +{ + "operationId": "GetAudioTranslationAsResponseObject", + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_translation_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_translation_text.json new file mode 100644 index 000000000000..f6ab0b665b01 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_audio_translation_text.json @@ -0,0 +1,16 @@ +{ + "operationId": "GetAudioTranslationAsPlainText", + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "type": "string", + "body": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_chat_completions.json new file mode 100644 index 000000000000..187c015a313a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_chat_completions.json @@ -0,0 +1,45 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!" + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_completions.json new file mode 100644 index 000000000000..4c222a1db7f2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_completions.json @@ -0,0 +1,38 @@ +{ + "operationId": "GetCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "body": { + "prompt": [ + "tell me a joke about mango" + ], + "max_tokens": 32, + "temperature": 1.0, + "n": 1 + } + }, + "responses": { + "200": { + "body": { + "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq", + "created": 1686617332, + "choices": [ + { + "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.", + "index": 0, + "finish_reason": "stop", + "logprobs": null + } + ], + "usage": { + "completion_tokens": 20, + "prompt_tokens": 6, + "total_tokens": 26 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_embeddings.json new file mode 100644 index 000000000000..5dc79433d2ff --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_embeddings.json @@ -0,0 +1,1567 @@ +{ + "operationId": "GetEmbeddings", + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "deployment-afa0669ca01e4693ae3a93baf40f26d6", + "body": { + "input": [ + "this is a test" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "index": 0, + "embedding": [ + -0.012838088, + -0.007421397, + -0.017617522, + -0.028278312, + -0.018666342, + 0.01737855, + -0.01821495, + -0.006950092, + -0.009937238, + -0.038580645, + 0.010674067, + 0.02412286, + -0.013647936, + 0.013189907, + 0.0021125758, + 0.012406612, + 0.020790534, + 0.00074595667, + 0.008397198, + -0.00535031, + 0.008968075, + 0.014351576, + -0.014086051, + 0.015055214, + -0.022211088, + -0.025198232, + 0.0065186154, + -0.036350243, + 0.009180495, + -0.009698266, + 0.009446018, + -0.008463579, + -0.0040426035, + -0.03443847, + -0.00091273896, + -0.0019217303, + 0.002349888, + -0.021560553, + 0.016515596, + -0.015572986, + 0.0038666942, + -0.00008432463, + 0.0032178196, + -0.020365695, + -0.009631885, + -0.007647093, + 0.0033837722, + -0.026764825, + -0.010501476, + 0.020219658, + 0.024640633, + -0.0066912062, + -0.036456455, + -0.0040923897, + -0.013966565, + 0.017816665, + 0.005366905, + 0.022835068, + 0.0103488, + -0.0010811808, + -0.028942121, + 0.0074280356, + -0.017033368, + 0.0074877786, + 0.021640211, + 0.002499245, + 0.013316032, + 0.0021524043, + 0.010129742, + 0.0054731146, + 0.03143805, + 0.014856071, + 0.0023366117, + -0.0008243692, + 0.022781964, + 0.003038591, + -0.017617522, + 0.0013309394, + 0.0022154662, + 0.00097414135, + 0.012041516, + -0.027906578, + -0.023817508, + 0.013302756, + -0.003003741, + -0.006890349, + 0.0016744611, + 0.023658194, + -0.015851786, + -0.0045305043, + -0.003038591, + 0.017710455, + 0.019237218, + 0.016037652, + -0.022503164, + 0.025795663, + -0.001129307, + 0.032500144, + -0.008178141, + -0.019940857, + -0.009877495, + 0.00018918588, + 0.023060765, + -0.005692172, + -0.018347712, + -0.011039163, + -0.0062066247, + -0.0000524047, + 0.020126723, + -0.0011691356, + -0.015811957, + 0.020086896, + -0.009114114, + -0.03056182, + 0.0029025099, + -0.006591635, + -0.014046223, + -0.01590489, + -0.02307404, + -0.008861865, + -0.004832538, + 0.010030171, + 0.02311387, + -0.012652221, + 0.024906157, + 0.003860056, + -0.01936998, + -0.02957938, + -0.008357369, + -0.0016371218, + 0.027800368, + 0.0077333883, + 0.021626934, + 0.02140124, + -0.030482162, + 0.026406368, + -0.008277712, + 0.012884554, + -0.043784916, + -0.0145639945, + -0.0070297495, + 0.034889862, + -0.00041508878, + -0.010528029, + -0.009572142, + 0.015692472, + 0.037810627, + -0.0022021902, + 0.008662722, + -0.016794397, + 0.0003090866, + -0.0060506295, + 0.015227805, + 0.0006650548, + 0.01842737, + 0.036801632, + -0.002461076, + -0.0029390194, + -0.0057120863, + -0.012486269, + -0.0046831807, + -0.0017474802, + -0.0036210844, + -0.01178263, + 0.017869769, + 0.039111692, + 0.010946229, + 0.018467197, + 0.0027780454, + -0.005851486, + -0.016489044, + 0.03186289, + -0.040333103, + 0.016648358, + -0.006870435, + 0.0072687212, + 0.000002370982, + 0.006465511, + -0.018201673, + -0.00020526254, + -0.025410652, + 0.02010017, + 0.017537864, + 0.022821793, + 0.0064555537, + -0.0012969191, + 0.02157383, + -0.0053536287, + -0.0087622935, + -0.010952868, + 0.017564416, + 0.02185263, + 0.0004733796, + 0.0018337755, + -0.6954606, + -0.011231667, + 0.02748174, + 0.003929756, + 0.0144843375, + 0.045192193, + 0.01898497, + -0.0070363875, + -0.007813046, + 0.017604245, + -0.017790113, + 0.011165286, + -0.0036376796, + -0.014736585, + 0.0016421003, + -0.019144284, + -0.0072222543, + -0.023127146, + 0.006936816, + 0.025198232, + 0.0030219958, + 0.011722887, + -0.004271618, + -0.0011127117, + -0.0051047, + 0.00077333883, + 0.018599961, + 0.0074877786, + 0.010820106, + 0.0033406245, + -0.015055214, + 0.02384406, + 0.006090458, + 0.00891497, + 0.023366116, + -0.011078991, + -0.019582398, + 0.0011566891, + 0.015413672, + 0.01793615, + -0.014736585, + 0.002492607, + 0.027800368, + 0.023923717, + -0.007421397, + 0.0016105693, + 0.011337877, + -0.015041938, + -0.008768932, + -0.003982861, + 0.002884255, + -0.007832959, + 0.0025457118, + -0.0023548664, + -0.0061767534, + -0.016754568, + 0.0006036523, + 0.0105346665, + 0.0055361767, + 0.01478969, + -0.0011251582, + 0.009605332, + -0.0037140178, + -0.017537864, + -0.021733144, + 0.012897831, + -0.024481317, + 0.022290744, + 0.0056523434, + -0.005366905, + 0.0020412162, + 0.013435517, + -0.003408665, + -0.01705992, + 0.029446619, + 0.022011945, + 0.009226961, + -0.003310753, + -0.007939169, + 0.021308305, + 0.0026718357, + 0.002129171, + -0.020047067, + -0.007474502, + 0.021534001, + -0.0110590765, + -0.018374264, + -0.001664504, + -0.003923118, + 0.015387119, + 0.025516862, + 0.0016421003, + -0.017498035, + -0.01825478, + 0.01451089, + -0.008198055, + -0.011656506, + 0.0044242945, + 0.031491153, + 0.01017621, + -0.010408543, + -0.009034456, + -0.0023283141, + 0.012021601, + 0.015639367, + 0.011736163, + 0.007912617, + 0.02031259, + 0.022104878, + -0.02241023, + 0.00041156227, + -0.009817752, + -0.030880447, + -0.0017823302, + 0.0030933553, + -0.04128899, + -0.0007783174, + 0.012393335, + 0.0122273825, + -0.009087561, + 0.022728859, + -0.002884255, + 0.028065892, + 0.0047396044, + 0.008065294, + 0.015519881, + 0.0133956885, + -0.02279524, + -0.011729525, + 0.0037206558, + -0.0046732235, + 0.003587894, + 0.024401661, + -0.013574918, + 0.012685412, + -0.0041620894, + 0.020578114, + 0.007394845, + 0.014139156, + -0.012512821, + -0.021042781, + 0.022423506, + -0.015360567, + 0.004009413, + 0.0104550095, + -0.024799947, + -0.0081449505, + -0.00063850236, + 0.0070231115, + -0.0009633545, + -0.015705748, + -0.0028942123, + -0.008815398, + 0.007461226, + -0.014417957, + -0.012931022, + 0.0015674217, + -0.02506547, + -0.0063128346, + -0.013422241, + -0.0058614435, + -0.0006007482, + -0.015002109, + 0.0037040606, + -0.008410474, + -0.0016089098, + -0.018653065, + 0.020538285, + -0.016980262, + -0.042244878, + -0.017498035, + 0.006727716, + -0.01877255, + 0.008987989, + 0.00077665783, + -0.0007119364, + -0.0067243967, + 0.0038467797, + -0.018055636, + -0.01440468, + 0.007534245, + 0.0051212953, + 0.002741536, + 0.011523744, + -0.0018603279, + 0.023684746, + 0.016196968, + 0.01731217, + -0.01992758, + 0.009372999, + -0.01982137, + 0.001150051, + -0.014417957, + 0.005672258, + -0.015785405, + 0.0049387473, + -0.0051445286, + 0.012632307, + 0.0011666464, + 0.024587527, + 0.04259006, + -0.0025672857, + 0.02311387, + -0.014524166, + 0.0013848739, + -0.04105002, + -0.010089914, + -0.009087561, + 0.015440224, + 0.009207047, + 0.0128048975, + -0.030216638, + -0.02549031, + 0.00499849, + 0.02737553, + 0.024985814, + -0.015055214, + 0.007580712, + -0.003979542, + 0.0016304837, + 0.0010446712, + 0.0033373055, + 0.0066314633, + -0.011948583, + -0.021281753, + 0.012161002, + 0.030747686, + 0.03555367, + 0.023751127, + -0.03159736, + -0.0110590765, + 0.015758853, + -0.0012197511, + -0.0023249951, + -0.0007488608, + 0.0074877786, + 0.01643594, + -0.008098484, + 0.03730613, + -0.0010056724, + -0.000034798173, + 0.011702972, + 0.039563086, + -0.012280487, + 0.027747264, + 0.018387541, + 0.033057746, + -0.004835857, + -0.00471969, + 0.025450481, + -0.0051146573, + 0.014603823, + 0.00022258384, + 0.00060863094, + 0.015665919, + -0.021626934, + -0.013674489, + 0.0062066247, + 0.018560132, + 0.031942543, + 0.012054792, + 0.004902238, + 0.0028510645, + -0.027667606, + 0.009817752, + -0.002580562, + 0.0069036256, + 0.020047067, + -0.009704905, + -0.012619031, + -0.0056755766, + -0.0036443176, + 0.019383255, + 0.0030701219, + 0.024972538, + 0.009100837, + 0.026353262, + 0.012758431, + 0.029074885, + 0.021202097, + -0.0038102702, + -0.032048754, + 0.003996137, + 0.0029738694, + 0.0032277768, + -0.026127568, + -0.02213143, + 0.0028742978, + 0.0010637557, + 0.000580419, + 0.0021789568, + 0.00083764544, + 0.026924139, + -0.03265946, + 0.0059211864, + 0.021892458, + 0.01178263, + 0.0018188398, + 0.009718181, + -0.020047067, + 0.017989255, + 0.0046035233, + -0.010561219, + -0.010342162, + 0.009505761, + -0.018334435, + -0.00667793, + -0.024534423, + 0.00035347888, + 0.00082561385, + -0.006143563, + 0.016820949, + -0.0013500239, + -0.0069832825, + 0.015347291, + -0.005094743, + 0.001838754, + 0.017073197, + 0.02521151, + 0.006209944, + -0.015612815, + -0.009744733, + -0.019794818, + 0.007786493, + 0.037624758, + 0.017564416, + 0.0076802834, + 0.0026203906, + 0.0022403593, + -0.024560975, + -0.04062518, + -0.016581977, + 0.00789934, + 0.0099305995, + 0.006996559, + 0.011078991, + 0.016236795, + -0.0068969876, + 0.01374087, + 0.014922452, + -0.0042882133, + 0.00022901449, + -0.0006692036, + 0.001359981, + -0.00007581957, + 0.0042616613, + 0.0066381013, + 0.012512821, + 0.021534001, + 0.0032775626, + 0.016913882, + -0.00789934, + -0.009200408, + -0.020286039, + -0.017033368, + 0.014378128, + 0.009233599, + 0.0070828544, + -0.013229736, + 0.025928425, + -0.011862287, + 0.008383922, + 0.012632307, + -0.0003097089, + 0.007593988, + 0.0059079104, + -0.0026369859, + -0.0262205, + 0.003335646, + -0.0067609064, + -0.0042882133, + 0.008549875, + -0.007600626, + -0.012592479, + 0.028623493, + -0.0030502076, + -0.006989921, + -0.015785405, + 0.010050085, + 0.016714739, + -0.023724575, + -0.006346025, + -0.014245366, + -0.032154962, + -0.03388087, + -0.024308728, + -0.002461076, + -0.003733932, + -0.02195884, + -0.021069333, + -0.022144707, + -0.007872788, + -0.017179407, + -0.009034456, + -0.010893124, + -0.02478667, + -0.020153277, + -0.023976821, + 0.014656927, + 0.0005368565, + -0.015878338, + 0.010123105, + -0.0030717815, + 0.01555971, + 0.0018321159, + -0.036244035, + 0.00017176087, + -0.013375774, + -0.010375353, + 0.026512576, + 0.016581977, + 0.013847079, + 0.015719024, + 0.013223098, + 0.004975257, + -0.0010579474, + -0.0034385365, + -0.029048331, + 0.017298892, + -0.022529716, + 0.008463579, + -0.014723309, + -0.005814977, + -0.009027818, + -0.009738095, + -0.0104682855, + -0.005044957, + 0.007905979, + 0.011656506, + 0.003153098, + -0.0005231654, + 0.019954132, + -0.021985391, + -0.005307162, + 0.0021839354, + -0.025184957, + 0.013926737, + -0.0059908866, + 0.0065717204, + 0.009884133, + -0.0062298584, + 0.03388087, + 0.0028577026, + -0.015931444, + 0.0010986058, + -0.025808938, + 0.0022835068, + 0.014152432, + 0.015227805, + 0.013701041, + -0.007872788, + -0.030614924, + -0.026393091, + 0.0010753724, + -0.016940435, + 0.013647936, + -0.007408121, + -0.024308728, + -0.031915992, + -0.018161846, + 0.00072521257, + 0.028862465, + 0.012234021, + -0.019555846, + -0.027641054, + -0.00082810316, + -0.0019150922, + -0.016276624, + -0.01125822, + -0.034146395, + -0.015294186, + 0.006671292, + -0.015533158, + 0.013674489, + -0.0011766035, + -0.017325444, + -0.023233354, + -0.013189907, + 0.0005580154, + -0.03188944, + -0.007056302, + -0.0059942054, + 0.03411984, + 0.04317421, + 0.029420065, + 0.006488744, + -0.0022436783, + 0.013063784, + 0.00012207884, + 0.008118398, + -0.023246631, + 0.0051909955, + -0.00894816, + 0.0081316745, + 0.0023200165, + 0.011510468, + -0.0005770999, + 0.00016979019, + 0.010129742, + 0.015506605, + -0.0073815687, + 0.0031995648, + -0.026578957, + -0.016674912, + 0.0049652997, + 0.0072687212, + -0.016568702, + -0.001964878, + -0.015692472, + -0.0048955996, + 0.027773816, + 0.012864641, + 0.01594472, + 0.008244522, + 0.017139578, + -0.01772373, + -0.0012521119, + 0.011689696, + 0.0111121815, + -0.0036476366, + 0.0012570905, + -0.007826322, + -0.016754568, + 0.011948583, + -0.0045968853, + 0.023963546, + -0.0052739717, + 0.014656927, + 0.009731457, + 0.010727172, + -0.01705992, + -0.0026071144, + 0.010760362, + 0.000919377, + -0.006365939, + -0.03013698, + -0.010554581, + -0.018613236, + 0.013886908, + 0.029420065, + -0.013030593, + 0.016860778, + -0.019237218, + -0.022118153, + 0.007919255, + -0.0004003605, + 0.046546366, + 0.01349526, + 0.006352663, + 0.014258642, + 0.0031813101, + -0.027017072, + 0.0070828544, + -0.020219658, + 0.0037140178, + 0.023366116, + 0.040386207, + -0.016382834, + -0.0023681426, + 0.0064522345, + 0.016528873, + 0.0006804054, + -0.02891557, + -0.0043545947, + 0.01101261, + -0.0014778073, + -0.018055636, + -0.0077001974, + -0.0358723, + 0.003373815, + -0.00071940426, + -0.011822458, + -0.024295451, + -0.009791199, + -0.026565682, + 0.020989677, + -0.035155386, + 0.01832116, + 0.014776413, + -0.028012788, + -0.007262083, + 0.0030402504, + -0.029446619, + 0.00010174965, + 0.009758009, + 0.03767786, + -0.0154535, + 0.009346447, + 0.016077481, + 0.0041189417, + -0.027800368, + 0.01720596, + -0.011158649, + 0.027800368, + -0.03003077, + -0.0072819972, + 0.0014296811, + 0.0145374425, + 0.0043280423, + -0.017086472, + -0.01611731, + -0.01258584, + -0.016927158, + 0.007607264, + 0.018825656, + 0.011331239, + -0.0057784673, + 0.001569911, + -0.013900184, + -0.014776413, + -0.0050814664, + -0.0012454737, + -0.0115967635, + -0.017458206, + -0.013203184, + -0.0063692583, + -0.01244644, + 0.011882202, + 0.0007708495, + -0.02035242, + 0.016250072, + 0.018414093, + -0.029526275, + 0.012751793, + -0.01555971, + 0.0013840442, + -0.019502742, + 0.0063758963, + 0.0037538463, + -0.035686433, + 0.027534844, + -0.016409386, + -0.03247359, + -0.008782208, + -0.0059842486, + 0.014338299, + 0.009233599, + -0.0053171194, + 0.006160158, + 0.0072952732, + 0.01401967, + 0.008815398, + -0.023790956, + 0.013096974, + -0.0031365028, + 0.005044957, + 0.0005356118, + -0.009379637, + 0.0066248253, + -0.00010724682, + 0.010289057, + 0.008815398, + -0.02279524, + -0.019701885, + -0.0027747264, + 0.016183691, + -0.014205537, + -0.003933075, + -0.013375774, + -0.005751915, + -0.010116466, + 0.004988533, + -0.005904591, + -0.008656085, + -0.017431654, + -0.011988411, + -0.01594472, + 0.00660823, + -0.027216217, + 0.0073218257, + -0.029977666, + -0.004593566, + -0.026671892, + -0.028517283, + -0.0050084474, + 0.009844304, + 0.025729282, + -0.013780698, + -0.026751548, + 0.004905557, + -0.035951957, + -0.026738273, + -0.019768266, + 0.0048690476, + 0.005250738, + 0.0014603822, + -0.018892037, + 0.017683903, + 0.0067177587, + 0.027694158, + -0.002618731, + -0.012419888, + 0.01772373, + -0.0032593077, + 0.006611549, + 0.016648358, + -0.03789028, + -0.023100592, + 0.023684746, + 0.0031248862, + 0.016382834, + 0.019967409, + -0.008941523, + -0.02014, + 0.0073882067, + 0.011357792, + -0.0031796505, + -0.0030253148, + -0.0010206081, + -0.017577693, + -0.009598695, + 0.002915786, + 0.001325131, + -0.0029207645, + -0.010780277, + -0.00325101, + -0.00811176, + -0.00073434, + -0.030083876, + -0.012864641, + -0.012745155, + -0.011769353, + 0.018785827, + -0.008264436, + -0.002675155, + 0.024255622, + 0.005483072, + -0.018480474, + -0.005426648, + 0.015095043, + 0.00044392303, + 0.011271496, + -0.0027548121, + 0.0026884312, + -0.00894816, + -0.015161424, + -0.014975557, + -0.024600804, + 0.004457485, + -0.015519881, + -0.012366783, + -0.012579202, + 0.01478969, + 0.0075541595, + -0.017962702, + -0.0017441611, + -0.014059499, + 0.005499667, + -0.0026884312, + 0.0031929268, + 0.0010853296, + -0.008045379, + 0.017471483, + 0.02590187, + -0.018546855, + -0.007826322, + 0.009333171, + 0.0157323, + 0.000086036016, + 0.004776114, + 0.22155327, + 0.006787459, + -0.0017823302, + 0.024919434, + 0.0023449094, + 0.03210186, + 0.0047329664, + -0.010879848, + 0.0044342517, + 0.015334014, + 0.029499723, + 0.019715162, + -0.008569789, + -0.0018901994, + -0.0077400263, + -0.019210665, + -0.005088105, + -0.023153698, + -0.032739118, + -0.029313855, + 0.00082146504, + -0.0212552, + 0.0044309325, + -0.005446562, + 0.018613236, + -0.009751371, + -0.013023955, + -0.001996409, + 0.01915756, + 0.017431654, + -0.031092867, + -0.0070231115, + 0.025330994, + -0.00018099198, + -0.025131851, + -0.011025886, + 0.0116498675, + -0.02506547, + 0.029234199, + -0.012287126, + 0.0069766445, + 0.0018752636, + 0.014271918, + 0.005108019, + -0.0109064, + 0.014391404, + 0.0062597296, + -0.031411495, + 0.00014935728, + 0.013236375, + -0.02891557, + -0.0006671292, + 0.008662722, + 0.012161002, + 0.020963125, + -0.0133691365, + 0.02653913, + -0.017989255, + 0.007978998, + 0.0093398085, + -0.02024621, + 0.03265946, + -0.02846418, + 0.025397375, + -0.024693737, + -0.0027050264, + -0.019330151, + -0.0104417335, + 0.015626092, + -0.006541849, + 0.004653309, + -0.025118576, + 0.0038268655, + 0.004045923, + -0.017564416, + -0.02444149, + 0.030296294, + 0.028756255, + 0.03927101, + 0.010767001, + -0.012034878, + -0.007122683, + -0.022476612, + -0.034942966, + -0.028411074, + -0.03927101, + -0.0037505273, + -0.0038799702, + -0.00037111135, + -0.009718181, + -0.013455432, + -0.015400395, + -0.0066978442, + -0.010760362, + 0.015121595, + 0.03111942, + 0.007992274, + 0.0270569, + -0.003104972, + 0.010056724, + -0.018414093, + 0.006472149, + 0.021281753, + 0.0043579135, + -0.00021490853, + 0.0008546556, + -0.01269205, + -0.003936394, + 0.0008870163, + 0.0009816092, + 0.0054664765, + -0.031278733, + 0.017245788, + 0.00027734818, + 0.005161124, + 0.0048093046, + -0.003923118, + -0.027149836, + 0.006950092, + -0.00615352, + 0.014205537, + 0.0016620146, + 0.0047396044, + 0.0039994563, + -0.015440224, + -0.0055627287, + -0.026273604, + 0.0013276202, + 0.0021009592, + -0.034810204, + 0.0064522345, + 0.00042608313, + 0.02307404, + -0.005957696, + 0.0016869075, + -0.0032775626, + -0.009041094, + -0.01227385, + -0.04349284, + 0.015652644, + 0.013468708, + -0.0023249951, + -0.011171925, + 0.0030352718, + -0.0061203293, + -0.023153698, + 0.046068422, + -0.005582643, + -0.02405648, + 0.005433286, + -0.02814555, + -0.0036874653, + 0.0067841397, + 0.006628144, + 0.029844904, + -0.0044276137, + -0.029127989, + -0.04548427, + 0.022091601, + 0.0038069512, + -0.030269742, + 0.0051578046, + 0.043572497, + -0.0144843375, + -0.02891557, + -0.010461648, + -0.17375894, + 0.029154541, + 0.019648781, + -0.00038335036, + 0.0029572742, + -0.0026469429, + 0.035925403, + -0.012021601, + 0.0015566348, + -0.0033124126, + 0.0010430117, + -0.010620962, + -0.022582822, + 0.00601412, + 0.008364008, + -0.0016586956, + -0.0011102224, + -0.013860356, + 0.022542993, + 0.020564837, + 0.018414093, + -0.008908332, + 0.032951534, + -0.011908754, + 0.010169571, + -0.011198477, + 0.0029108075, + 0.033084296, + 0.0029008503, + -0.0010015236, + -0.019794818, + 0.005844848, + 0.011669782, + 0.0052208668, + 0.010129742, + 0.0037737607, + 0.02880936, + -0.018599961, + -0.015095043, + 0.026578957, + 0.019662056, + 0.006823968, + -0.00045885876, + -0.019396532, + -0.0047993474, + 0.017192682, + 0.039589636, + -0.00874238, + 0.02146762, + -0.007667007, + 0.018785827, + -0.012758431, + -0.010010257, + -0.02052501, + 0.016090758, + 0.0061867107, + -0.0145507185, + 0.008065294, + 0.0104284575, + -0.0022386997, + -0.008324179, + -0.021640211, + 0.01705992, + -0.010541305, + -0.01639611, + -0.0074413116, + -0.034703992, + 0.007016473, + -0.003083398, + 0.0013691084, + -0.005108019, + -0.007886064, + 0.00053270767, + -0.018865485, + 0.025503585, + 0.005101381, + -0.027534844, + 0.015028661, + -0.009286704, + 0.006233177, + 0.00004343289, + 0.036031615, + 0.00957878, + 0.019250493, + 0.0024411618, + 0.0023664832, + -0.0030269742, + -0.007939169, + 0.0058581247, + 0.00587472, + 0.036589216, + -0.035288148, + -0.012997403, + -0.0110989055, + -0.002492607, + 0.008151589, + -0.008085207, + -0.00734174, + -0.0016802694, + 0.008403837, + -0.007793131, + -0.003913161, + -0.025437204, + 0.027123282, + 0.019330151, + -0.008729103, + 0.003943032, + 0.010289057, + 0.029977666, + 0.0014836156, + -0.024282174, + -0.0024361832, + 0.0110325245, + 0.021719867, + 0.012844726, + 0.015002109, + 0.020737428, + -0.013037231, + 0.014802966, + -0.0027332383, + 0.041634172, + -0.00926679, + -0.018759275, + 0.018666342, + 0.005386819, + -0.008822037, + -0.068399, + -0.054804165, + 0.027800368, + 0.04954679, + -0.00437119, + 0.029127989, + 0.03180978, + 0.021321582, + -0.022503164, + 0.010554581, + -0.006823968, + -0.021387963, + -0.021865906, + -0.0074479496, + 0.0037206558, + 0.004132218, + 0.01073381, + -0.0021673401, + -0.0012819833, + 0.041235887, + -0.010202762, + 0.004839176, + 0.0081715025, + -0.030402504, + -0.023764404, + -0.010800191, + -0.018374264, + 0.033641897, + 0.005416691, + -0.0055096243, + -0.0032775626, + -0.018095464, + 0.008563151, + -0.02339267, + -0.013674489, + 0.0023382711, + -0.028411074, + -0.0024063117, + 0.026658615, + -0.012413249, + 0.009333171, + 0.026446195, + -0.009107475, + -0.024560975, + 0.0011085629, + -0.02395027, + 0.0013857037, + 0.01926377, + -0.0020710877, + -0.031278733, + -0.015095043, + 0.0041720467, + -0.012798259, + 0.010162933, + 0.0063128346, + -0.010972782, + 0.045617033, + 0.016874054, + -0.010368714, + -0.0055992384, + -0.0092999805, + 0.0015782086, + -0.013581555, + 0.017843217, + -0.01615714, + 0.0036575939, + -0.027110007, + -0.013621384, + 0.022197811, + 0.0013964906, + -0.007348378, + 0.0145772705, + -0.003996137, + 0.0008364008, + -0.03411984, + 0.013030593, + -0.021454344, + -0.05034336, + 0.021095887, + -0.0055029863, + -0.025623072, + -0.023525432, + 0.007335102, + -0.043413185, + 0.016316453, + 0.016196968, + 0.0093132565, + -0.0110989055, + 0.0154535, + -0.045218747, + 0.0037737607, + 0.01639611, + 0.019887751, + -0.023366116, + -0.024043202, + 0.014258642, + 0.004271618, + -0.006877073, + 0.021387963, + -0.0019781543, + -0.036350243, + -0.009114114, + -0.037359234, + 0.01919739, + 0.011829097, + -0.015665919, + -0.0015591241, + 0.0144843375, + -0.003139822, + -0.024083031, + -0.015307462, + -0.0040990277, + -0.013223098, + 0.0024278855, + -0.008702551, + -0.0033207103, + -0.009804476, + -0.010554581, + 0.031066315, + 0.0044408897, + 0.025370823, + 0.009406189, + 0.025583243, + -0.002066109, + 0.015267633, + 0.008337456, + -0.009426104, + 0.01590489, + -0.011716249, + 0.007713474, + -0.029552827, + -0.013900184, + 0.0050150855, + -0.01650232, + -0.0015757193, + 0.008549875, + -0.020471904, + 0.008397198, + -0.013136802, + 0.021520725, + 0.0060406723, + 0.012858002, + -0.004723009, + -0.029313855, + 0.009240237, + -0.0212552, + -0.028118998, + 0.017803388, + -0.0314646, + 0.012353507, + 0.029632485, + -0.000016128512, + 0.016966987, + 0.009711542, + -0.037253026, + -0.015095043, + 0.013442155, + -0.00905437, + -0.000982439, + -0.0020495139, + 0.008337456, + -0.020644495, + 0.042085562, + -0.000744712, + 0.021135716, + -0.0072886352, + 0.01643594, + 0.013767422, + -0.0044707614, + -0.014763137, + 0.018852208, + -0.03080079, + -0.0049188333, + 0.0058846767, + 0.008330817, + 0.008257798, + 0.024202518, + 0.02307404, + 0.011065715, + 0.00036053188, + -0.00049412367, + 0.036270585, + 0.027043626, + 0.011902116, + -0.027773816, + 0.013289479, + 0.018374264, + -0.0033157317, + 0.0016636741, + 0.0020677685, + -0.012293763, + 0.008184779, + -0.034252603, + 0.010753725, + 0.008675998, + 0.00968499, + -0.003793675, + -0.011218391, + 0.010375353, + -0.0005737809, + 0.019781543, + 0.020591391, + 0.019954132, + -0.00053976063, + -0.0059444197, + -0.022675755, + -0.010003619, + 0.0038467797, + -0.0212552, + -0.033482585, + -0.015572986, + 0.0037737607, + 0.01451089, + 0.0036376796, + 0.007454588, + 0.013979842, + -0.013402327, + 0.014975557, + -0.010435095, + 0.0151747, + -0.030375952, + 0.023166973, + -0.0024760119, + -0.005881358, + 0.019914305, + -0.008596341, + 0.017737007, + -0.0036111271, + 0.012499545, + -0.02647275, + 0.0053901384, + 0.008556513, + 0.019648781, + 0.00874238, + -0.012439802, + -0.028623493, + -0.022330573, + -0.0029340407, + -0.016303178, + 0.007474502, + -0.016555425, + 0.060645696, + 0.0023631642, + -0.012054792, + 0.017604245, + 0.013103612, + 0.026061187, + 0.015533158, + 0.025742557, + 0.00013753316, + -0.013940013, + 0.02880936, + 0.010109829, + -0.0036111271, + -0.012419888, + -0.045457717, + 0.022835068, + -0.014139156, + 0.007819683, + -0.010461648, + -0.012008325, + 0.008895056, + 0.015984548, + 0.024043202, + -0.00059825886, + -0.0036376796, + -0.007939169, + 0.0242689, + -0.022197811, + -0.026313433, + -0.026724996, + 0.010939592, + 0.0023449094, + -0.012074706, + -0.018493751, + 0.017697178, + -0.0052142288, + -0.00360117, + 0.0056058764, + 0.01070062, + 0.0035248317, + 0.023671469, + 0.030880447, + -0.020299314, + -0.0145905465, + 0.018055636, + -0.013727593, + -0.023313012, + 0.013236375, + -0.0020113448 + ] + } + ], + "usage": { + "prompt_tokens": 4, + "total_tokens": 4 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_aml_index.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_aml_index.json new file mode 100644 index 000000000000..f0dbaa14167b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_aml_index.json @@ -0,0 +1,62 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided AML index. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_ml_index", + "parameters": { + "project_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-id}", + "name": "gm-cars", + "version": "5" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..ef9239a6187c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_azure_search_advanced.json @@ -0,0 +1,86 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion based on Azure Cognitive Services vector data and user-assigned managed identity. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "authentication": { + "type": "user_assigned_managed_identity", + "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" + }, + "index_name": "{index name}", + "query_type": "vector", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "in_scope": true, + "top_n_documents": 5, + "strictness": 3, + "role_information": "You are an AI assistant that helps people find information.", + "fields_mapping": { + "content_fields_separator": "\\n", + "content_fields": [ + "content" + ], + "filepath_field": "filepath", + "title_field": "title", + "url_field": "url", + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..1d16c556ce0b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_azure_search_image_vector.json @@ -0,0 +1,67 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion based on Azure Cognitive Services image vector data. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "query_type": "vector", + "fields_mapping": { + "image_vector_fields": [ + "image_vector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..698995a06498 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_azure_search_minimum.json @@ -0,0 +1,61 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion based on Azure Cognitive Services data and system-assigned managed identity. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_cosmos_db.json new file mode 100644 index 000000000000..83b91970e7e2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_cosmos_db.json @@ -0,0 +1,78 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided Azure Cosmos DB. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_cosmos_db", + "parameters": { + "authentication": { + "type": "connection_string", + "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" + }, + "database_name": "vectordb", + "container_name": "azuredocs", + "index_name": "azuredocindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_elasticsearch.json new file mode 100644 index 000000000000..f9e268f83e73 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_elasticsearch.json @@ -0,0 +1,66 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided Elasticsearch. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "elasticsearch", + "parameters": { + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", + "index_name": "{index name}", + "authentication": { + "type": "key_and_key_id", + "key": "{key}", + "key_id": "{key id}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_pinecone.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_pinecone.json new file mode 100644 index 000000000000..5652cd057564 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_extensions_chat_completions_pinecone.json @@ -0,0 +1,78 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided Pinecone resource. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "pinecone", + "parameters": { + "authentication": { + "type": "api_key", + "key": "{api key}" + }, + "environment": "{environment name}", + "index_name": "{index name}", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "title_field": "title", + "url_field": "url", + "filepath_field": "filepath", + "content_fields": [ + "content" + ], + "content_fields_separator": "\n" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_image_generation.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_image_generation.json new file mode 100644 index 000000000000..3c4936e0e14f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/generated_image_generation.json @@ -0,0 +1,31 @@ +{ + "operationId": "GetImageGenerations", + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deploymentId": "", + "body": { + "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.", + "n": 1, + "style": "natural", + "quality": "standard" + } + }, + "responses": { + "200": { + "body": { + "created": 1698342300, + "data": [ + { + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&..." + }, + { + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_01.png?se=2023-10-27T17%3A45%3A09Z&...", + "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat." + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/image_generation.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/image_generation.json new file mode 100644 index 000000000000..939325c5bcfa --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/image_generation.json @@ -0,0 +1,67 @@ +{ + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-10-21", + "deployment-id": "", + "body": { + "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.", + "n": 1, + "style": "natural", + "quality": "standard" + } + }, + "responses": { + "200": { + "body": { + "created": 1698342300, + "data": [ + { + "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.", + "prompt_filter_results": { + "sexual": { + "severity": "safe", + "filtered": false + }, + "violence": { + "severity": "safe", + "filtered": false + }, + "hate": { + "severity": "safe", + "filtered": false + }, + "self_harm": { + "severity": "safe", + "filtered": false + }, + "profanity": { + "detected": false, + "filtered": false + } + }, + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...", + "content_filter_results": { + "sexual": { + "severity": "safe", + "filtered": false + }, + "violence": { + "severity": "safe", + "filtered": false + }, + "hate": { + "severity": "safe", + "filtered": false + }, + "self_harm": { + "severity": "safe", + "filtered": false + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/image_generation.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/image_generation.yaml new file mode 100644 index 000000000000..a6790ece9d69 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/examples/image_generation.yaml @@ -0,0 +1,46 @@ +title: "Creates images given a prompt." +parameters: + endpoint: "{endpoint}" + api-version: "2024-10-21" + deployment-id: "" + body: + prompt: "In the style of WordArt, Microsoft Clippy wearing a cowboy hat." + n: 1 + style: "natural" + quality: "standard" +responses: + '200': + body: + created: 1698342300 + data: + - revised_prompt: "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat." + prompt_filter_results: + sexual: + severity: "safe" + filtered: false + violence: + severity: "safe" + filtered: false + hate: + severity: "safe" + filtered: false + self_harm: + severity: "safe" + filtered: false + profanity: + detected: false + filtered: false + url: "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&..." + content_filter_results: + sexual: + severity: "safe" + filtered: false + violence: + severity: "safe" + filtered: false + hate: + severity: "safe" + filtered: false + self_harm: + severity: "safe" + filtered: false \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/inference.json new file mode 100644 index 000000000000..d44476c260c5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/inference.json @@ -0,0 +1,3627 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Azure OpenAI Service API", + "description": "Azure OpenAI APIs for completions and search", + "version": "2024-10-21" + }, + "servers": [ + { + "url": "https://{endpoint}/openai", + "variables": { + "endpoint": { + "default": "your-resource-name.openai.azure.com" + } + } + } + ], + "security": [ + { + "bearer": [ + "api.read" + ] + }, + { + "apiKey": [] + } + ], + "paths": { + "/deployments/{deployment-id}/completions": { + "post": { + "summary": "Creates a completion for the provided prompt, parameters and chosen model.", + "operationId": "Completions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "davinci", + "description": "Deployment id of the model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-10-21", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createCompletionRequest" + }, + "example": { + "prompt": "Negate the following sentence.The price for bubblegum increased on thursday.\n\n Negated Sentence:", + "max_tokens": 50 + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createCompletionResponse" + }, + "example": { + "model": "davinci", + "object": "text_completion", + "id": "cmpl-4509KAos68kxOqpE2uYGw81j6m7uo", + "created": 1637097562, + "choices": [ + { + "index": 0, + "text": "The price for bubblegum decreased on thursday.", + "logprobs": null, + "finish_reason": "stop" + } + ] + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + }, + "default": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/errorResponse" + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + } + }, + "x-ms-examples": { + "Create a completion.": { + "$ref": "./examples/completions.json" + } + } + } + }, + "/deployments/{deployment-id}/embeddings": { + "post": { + "summary": "Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.", + "operationId": "embeddings_create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "ada-search-index-v1" + }, + "description": "The deployment id of the model which was deployed." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-10-21", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true, + "properties": { + "input": { + "description": "Input text to get embeddings for, encoded as a string. To get embeddings for multiple inputs in a single request, pass an array of strings. Each input must not exceed 2048 tokens in length.\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space, as we have observed inferior results when newlines are present.", + "oneOf": [ + { + "type": "string", + "default": "", + "example": "This is a test.", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 2048, + "items": { + "type": "string", + "minLength": 1, + "example": "This is a test.", + "nullable": false + } + } + ] + }, + "user": { + "description": "A unique identifier representing your end-user, which can help monitoring and detecting abuse.", + "type": "string", + "nullable": false + }, + "input_type": { + "description": "input type of embedding search to use", + "type": "string", + "example": "query" + }, + "encoding_format": { + "description": "The format to return the embeddings in. Can be either `float` or `base64`. Defaults to `float`.", + "type": "string", + "example": "float", + "nullable": true + }, + "dimensions": { + "description": "The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.", + "type": "integer", + "example": 1, + "nullable": true + } + }, + "required": [ + "input" + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "object": { + "type": "string" + }, + "model": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "object": { + "type": "string" + }, + "embedding": { + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "index", + "object", + "embedding" + ] + } + }, + "usage": { + "type": "object", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "total_tokens": { + "type": "integer" + } + }, + "required": [ + "prompt_tokens", + "total_tokens" + ] + } + }, + "required": [ + "object", + "model", + "data", + "usage" + ] + } + } + } + } + }, + "x-ms-examples": { + "Create a embeddings.": { + "$ref": "./examples/embeddings.json" + } + } + } + }, + "/deployments/{deployment-id}/chat/completions": { + "post": { + "summary": "Creates a completion for the chat message", + "operationId": "ChatCompletions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "description": "Deployment id of the model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-10-21", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createChatCompletionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/createChatCompletionResponse" + }, + { + "$ref": "#/components/schemas/createChatCompletionStreamResponse" + } + ] + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + }, + "default": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/errorResponse" + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + } + }, + "x-ms-examples": { + "Create a chat completion.": { + "$ref": "./examples/chat_completions.json" + }, + "Creates a completion based on Azure Search data and system-assigned managed identity.": { + "$ref": "./examples/chat_completions_azure_search_minimum.json" + }, + "Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.": { + "$ref": "./examples/chat_completions_azure_search_advanced.json" + }, + "Creates a completion for the provided Azure Cosmos DB.": { + "$ref": "./examples/chat_completions_cosmos_db.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/transcriptions": { + "post": { + "summary": "Transcribes audio into the input language.", + "operationId": "Transcriptions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "whisper", + "description": "Deployment id of the whisper model." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-10-21", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createTranscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "$ref": "#/components/schemas/audioVerboseResponse" + } + ] + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Transcribed text in the output format (when response_format was one of text, vtt or srt)." + } + } + } + } + }, + "x-ms-examples": { + "Create an audio transcription with json response format.": { + "$ref": "./examples/audio_transcription_object.json" + }, + "Create an audio transcription with text response format.": { + "$ref": "./examples/audio_transcription_text.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/translations": { + "post": { + "summary": "Transcribes and translates input audio into English text.", + "operationId": "Translations_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "whisper", + "description": "Deployment id of the whisper model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-10-21", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createTranslationRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "$ref": "#/components/schemas/audioVerboseResponse" + } + ] + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Transcribed text in the output format (when response_format was one of text, vtt or srt)." + } + } + } + } + }, + "x-ms-examples": { + "Create an audio translation with json response format.": { + "$ref": "./examples/audio_translation_object.json" + }, + "Create an audio translation with text response format.": { + "$ref": "./examples/audio_translation_text.json" + } + } + } + }, + "/deployments/{deployment-id}/images/generations": { + "post": { + "summary": "Generates a batch of images from a text caption on a given DALLE model deployment", + "operationId": "ImageGenerations_Create", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/imageGenerationsRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "dalle-deployment", + "description": "Deployment id of the dalle model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-10-21", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/generateImagesResponse" + } + } + } + }, + "default": { + "description": "An error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dalleErrorResponse" + } + } + } + } + }, + "x-ms-examples": { + "Create an image.": { + "$ref": "./examples/image_generation.json" + } + } + } + } + }, + "components": { + "schemas": { + "errorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/error" + } + } + }, + "errorBase": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "error": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/errorBase" + } + ], + "properties": { + "param": { + "type": "string" + }, + "type": { + "type": "string" + }, + "inner_error": { + "$ref": "#/components/schemas/innerError" + } + } + }, + "innerError": { + "description": "Inner error with additional details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/innerErrorCode" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterPromptResults" + } + } + }, + "innerErrorCode": { + "description": "Error codes for the inner error object.", + "enum": [ + "ResponsibleAIPolicyViolation" + ], + "type": "string", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "ResponsibleAIPolicyViolation", + "description": "The prompt violated one of more content filter rules." + } + ] + } + }, + "dalleErrorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/dalleError" + } + } + }, + "dalleError": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/errorBase" + } + ], + "properties": { + "param": { + "type": "string" + }, + "type": { + "type": "string" + }, + "inner_error": { + "$ref": "#/components/schemas/dalleInnerError" + } + } + }, + "dalleInnerError": { + "description": "Inner error with additional details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/innerErrorCode" + }, + "content_filter_results": { + "$ref": "#/components/schemas/dalleFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The prompt that was used to generate the image, if there was any revision to the prompt." + } + } + }, + "contentFilterResultBase": { + "type": "object", + "properties": { + "filtered": { + "type": "boolean" + } + }, + "required": [ + "filtered" + ] + }, + "contentFilterSeverityResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "severity": { + "type": "string", + "enum": [ + "safe", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "ContentFilterSeverity", + "modelAsString": true, + "values": [ + { + "value": "safe", + "description": "General content or related content in generic or non-harmful contexts." + }, + { + "value": "low", + "description": "Harmful content at a low intensity and risk level." + }, + { + "value": "medium", + "description": "Harmful content at a medium intensity and risk level." + }, + { + "value": "high", + "description": "Harmful content at a high intensity and risk level." + } + ] + } + } + } + } + ], + "required": [ + "severity", + "filtered" + ] + }, + "contentFilterDetectedResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "detected": { + "type": "boolean" + } + } + } + ], + "required": [ + "detected", + "filtered" + ] + }, + "contentFilterDetectedWithCitationResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + { + "properties": { + "citation": { + "type": "object", + "properties": { + "URL": { + "type": "string" + }, + "license": { + "type": "string" + } + } + } + } + } + ], + "required": [ + "detected", + "filtered" + ] + }, + "contentFilterResultsBase": { + "type": "object", + "description": "Information about the content filtering results.", + "properties": { + "sexual": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "violence": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "hate": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "self_harm": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "profanity": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "error": { + "$ref": "#/components/schemas/errorBase" + } + } + }, + "contentFilterPromptResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultsBase" + }, + { + "properties": { + "jailbreak": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + } + ] + }, + "contentFilterChoiceResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultsBase" + }, + { + "properties": { + "protected_material_text": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + }, + { + "properties": { + "protected_material_code": { + "$ref": "#/components/schemas/contentFilterDetectedWithCitationResult" + } + } + } + ] + }, + "promptFilterResult": { + "type": "object", + "description": "Content filtering results for a single prompt in the request.", + "properties": { + "prompt_index": { + "type": "integer" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterPromptResults" + } + } + }, + "promptFilterResults": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/components/schemas/promptFilterResult" + } + }, + "dalleContentFilterResults": { + "type": "object", + "description": "Information about the content filtering results.", + "properties": { + "sexual": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "violence": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "hate": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "self_harm": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + } + } + }, + "dalleFilterResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/dalleContentFilterResults" + }, + { + "properties": { + "profanity": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "jailbreak": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + } + ] + }, + "chatCompletionsRequestCommon": { + "type": "object", + "properties": { + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\nWe generally recommend altering this or `temperature` but not both.", + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true + }, + "stream": { + "description": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message.", + "type": "boolean", + "nullable": true, + "default": false + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens.", + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "array", + "items": { + "type": "string", + "nullable": false + }, + "minItems": 1, + "maxItems": 4, + "description": "Array minimum size of 1 and maximum of 4" + } + ], + "default": null + }, + "max_tokens": { + "description": "The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with o1 series models.", + "type": "integer", + "default": 4096 + }, + "max_completion_tokens": { + "description": "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.", + "type": "integer", + "nullable": true + }, + "presence_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.", + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "frequency_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.", + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "logit_bias": { + "description": "Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.", + "type": "object", + "nullable": true + }, + "user": { + "description": "A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse.", + "type": "string", + "example": "user-1234", + "nullable": false + } + } + }, + "createCompletionRequest": { + "type": "object", + "properties": { + "prompt": { + "description": "The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.\n\nNote that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.\n", + "default": "<|endoftext|>", + "nullable": true, + "oneOf": [ + { + "type": "string", + "default": "", + "example": "This is a test." + }, + { + "type": "array", + "items": { + "type": "string", + "default": "", + "example": "This is a test." + } + } + ] + }, + "best_of": { + "type": "integer", + "default": 1, + "minimum": 0, + "maximum": 20, + "nullable": true, + "description": "Generates `best_of` completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed.\n\nWhen used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n" + }, + "echo": { + "type": "boolean", + "default": false, + "nullable": true, + "description": "Echo back the prompt in addition to the completion\n" + }, + "frequency_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n" + }, + "logit_bias": { + "type": "object", + "x-oaiTypeLabel": "map", + "default": null, + "nullable": true, + "additionalProperties": { + "type": "integer" + }, + "description": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n\nAs an example, you can pass `{\"50256\": -100}` to prevent the <|endoftext|> token from being generated.\n" + }, + "logprobs": { + "type": "integer", + "minimum": 0, + "maximum": 5, + "default": null, + "nullable": true, + "description": "Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response.\n\nThe maximum value for `logprobs` is 5.\n" + }, + "max_tokens": { + "type": "integer", + "minimum": 0, + "default": 16, + "example": 16, + "nullable": true, + "description": "The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n" + }, + "n": { + "type": "integer", + "minimum": 1, + "maximum": 128, + "default": 1, + "example": 1, + "nullable": true, + "description": "How many completions to generate for each prompt.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n" + }, + "presence_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n" + }, + "seed": { + "type": "integer", + "minimum": -9223372036854775808, + "maximum": 9223372036854775807, + "nullable": true, + "description": "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n" + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.\n", + "default": null, + "nullable": true, + "oneOf": [ + { + "type": "string", + "default": "<|endoftext|>", + "example": "\n", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "type": "string", + "example": "[\"\\n\"]" + } + } + ] + }, + "stream": { + "description": "Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n", + "type": "boolean", + "nullable": true, + "default": false + }, + "suffix": { + "description": "The suffix that comes after a completion of inserted text.\n\nThis parameter is only supported for `gpt-3.5-turbo-instruct`.\n", + "default": null, + "nullable": true, + "type": "string", + "example": "test." + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.\n" + }, + "user": { + "type": "string", + "example": "user-1234", + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.\n" + } + }, + "required": [ + "prompt" + ] + }, + "createCompletionResponse": { + "type": "object", + "description": "Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).\n", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the completion." + }, + "choices": { + "type": "array", + "description": "The list of completion choices the model generated for the input prompt.", + "items": { + "type": "object", + "required": [ + "finish_reason", + "index", + "logprobs", + "text" + ], + "properties": { + "finish_reason": { + "type": "string", + "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\nor `content_filter` if content was omitted due to a flag from our content filters.\n", + "enum": [ + "stop", + "length", + "content_filter" + ] + }, + "index": { + "type": "integer" + }, + "logprobs": { + "type": "object", + "nullable": true, + "properties": { + "text_offset": { + "type": "array", + "items": { + "type": "integer" + } + }, + "token_logprobs": { + "type": "array", + "items": { + "type": "number" + } + }, + "tokens": { + "type": "array", + "items": { + "type": "string" + } + }, + "top_logprobs": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "number" + } + } + } + } + }, + "text": { + "type": "string" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterChoiceResults" + } + } + } + }, + "created": { + "type": "integer", + "description": "The Unix timestamp (in seconds) of when the completion was created." + }, + "model": { + "type": "string", + "description": "The model used for completion." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/promptFilterResults" + }, + "system_fingerprint": { + "type": "string", + "description": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" + }, + "object": { + "type": "string", + "description": "The object type, which is always \"text_completion\"", + "enum": [ + "text_completion" + ] + }, + "usage": { + "$ref": "#/components/schemas/completionUsage" + } + }, + "required": [ + "id", + "object", + "created", + "model", + "choices" + ] + }, + "createChatCompletionRequest": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionsRequestCommon" + }, + { + "properties": { + "messages": { + "description": "A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb).", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + } + }, + "data_sources": { + "type": "array", + "description": " The configuration entries for Azure OpenAI chat extensions that use them.\n This additional specification is only compatible with Azure OpenAI.", + "items": { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + } + }, + "frequency_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n" + }, + "logit_bias": { + "type": "object", + "default": null, + "nullable": true, + "additionalProperties": { + "type": "integer" + }, + "description": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n" + }, + "logprobs": { + "description": "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`.", + "type": "boolean", + "default": false, + "nullable": true + }, + "top_logprobs": { + "description": "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used.", + "type": "integer", + "minimum": 0, + "maximum": 20, + "nullable": true + }, + "max_tokens": { + "description": "The maximum number of [tokens](/tokenizer) that can be generated in the chat completion.\n\nThe total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n", + "type": "integer", + "nullable": true + }, + "n": { + "type": "integer", + "minimum": 1, + "maximum": 128, + "default": 1, + "example": 1, + "nullable": true, + "description": "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs." + }, + "presence_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n" + }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls", + "nullable": true + }, + "response_format": { + "description": "An object specifying the format that the model must output. Compatible with [GPT-4o](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4o mini](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4 Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models) and all [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-35) Turbo models newer than `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which guarantees the model will match your supplied JSON schema.\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/ResponseFormatText" + }, + { + "$ref": "#/components/schemas/ResponseFormatJsonObject" + }, + { + "$ref": "#/components/schemas/ResponseFormatJsonSchema" + } + ], + "x-oaiExpandable": true + }, + "seed": { + "type": "integer", + "minimum": -9223372036854775808, + "maximum": 9223372036854775807, + "nullable": true, + "description": "This feature is in Beta.\nIf specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n" + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens.\n", + "default": null, + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "type": "string" + } + } + ] + }, + "stream": { + "description": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n", + "type": "boolean", + "nullable": true, + "default": false + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.\n" + }, + "tools": { + "type": "array", + "description": "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.\n", + "items": { + "$ref": "#/components/schemas/chatCompletionTool" + } + }, + "tool_choice": { + "$ref": "#/components/schemas/chatCompletionToolChoiceOption" + }, + "function_call": { + "deprecated": true, + "description": "Deprecated in favor of `tool_choice`.\n\nControls which (if any) function is called by the model.\n`none` means the model will not call a function and instead generates a message.\n`auto` means the model can pick between generating a message or calling a function.\nSpecifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n\n`none` is the default when no functions are present. `auto` is the default if functions are present.\n", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.\n", + "enum": [ + "none", + "auto" + ] + }, + { + "$ref": "#/components/schemas/chatCompletionFunctionCallOption" + } + ], + "x-oaiExpandable": true + }, + "functions": { + "deprecated": true, + "description": "Deprecated in favor of `tools`.\n\nA list of functions the model may generate JSON inputs for.\n", + "type": "array", + "minItems": 1, + "maxItems": 128, + "items": { + "$ref": "#/components/schemas/chatCompletionFunctions" + } + }, + "user": { + "type": "string", + "example": "user-1234", + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.\n" + } + }, + "required": [ + "messages" + ] + } + ] + }, + "chatCompletionFunctions": { + "type": "object", + "deprecated": true, + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/FunctionParameters" + } + }, + "required": [ + "name" + ] + }, + "chatCompletionFunctionCallOption": { + "type": "object", + "description": "Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + }, + "chatCompletionRequestMessage": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestSystemMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestUserMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestAssistantMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestToolMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestFunctionMessage" + } + ] + }, + "chatCompletionRequestSystemMessage": { + "type": "object", + "title": "System message", + "properties": { + "content": { + "description": "The contents of the system message.", + "oneOf": [ + { + "type": "string", + "description": "The contents of the system message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. For system messages, only type `text` is supported.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestSystemMessageContentPart" + }, + "minItems": 1 + } + ] + }, + "role": { + "type": "string", + "enum": [ + "system" + ], + "description": "The role of the messages author, in this case `system`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + } + }, + "required": [ + "content", + "role" + ] + }, + "chatCompletionRequestUserMessage": { + "type": "object", + "title": "User message", + "properties": { + "content": { + "description": "The contents of the user message.\n", + "oneOf": [ + { + "type": "string", + "description": "The text contents of the message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4o` model.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestUserMessageContentPart" + }, + "minItems": 1 + } + ], + "x-oaiExpandable": true + }, + "role": { + "type": "string", + "enum": [ + "user" + ], + "description": "The role of the messages author, in this case `user`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + } + }, + "required": [ + "content", + "role" + ] + }, + "chatCompletionRequestAssistantMessage": { + "type": "object", + "title": "Assistant message", + "properties": { + "content": { + "nullable": true, + "oneOf": [ + { + "type": "string", + "description": "The contents of the assistant message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestAssistantMessageContentPart" + }, + "minItems": 1 + } + ], + "description": "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.\n" + }, + "refusal": { + "nullable": true, + "type": "string", + "description": "The refusal message by the assistant." + }, + "role": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "The role of the messages author, in this case `assistant`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + }, + "tool_calls": { + "$ref": "#/components/schemas/chatCompletionMessageToolCalls" + }, + "function_call": { + "type": "object", + "deprecated": true, + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "nullable": true, + "properties": { + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + }, + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "arguments", + "name" + ] + } + }, + "required": [ + "role" + ] + }, + "chatCompletionRequestToolMessage": { + "type": "object", + "title": "Tool message", + "properties": { + "role": { + "type": "string", + "enum": [ + "tool" + ], + "description": "The role of the messages author, in this case `tool`." + }, + "content": { + "oneOf": [ + { + "type": "string", + "description": "The contents of the tool message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. For tool messages, only type `text` is supported.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestToolMessageContentPart" + }, + "minItems": 1 + } + ], + "description": "The contents of the tool message." + }, + "tool_call_id": { + "type": "string", + "description": "Tool call that this message is responding to." + } + }, + "required": [ + "role", + "content", + "tool_call_id" + ] + }, + "chatCompletionRequestFunctionMessage": { + "type": "object", + "title": "Function message", + "deprecated": true, + "properties": { + "role": { + "type": "string", + "enum": [ + "function" + ], + "description": "The role of the messages author, in this case `function`." + }, + "content": { + "nullable": true, + "type": "string", + "description": "The contents of the function message." + }, + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "role", + "content", + "name" + ] + }, + "chatCompletionRequestSystemMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + } + ] + }, + "chatCompletionRequestUserMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartImage" + } + ] + }, + "chatCompletionRequestAssistantMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartRefusal" + } + ] + }, + "chatCompletionRequestToolMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + } + ] + }, + "chatCompletionRequestMessageContentPartText": { + "type": "object", + "title": "Text content part", + "properties": { + "type": { + "type": "string", + "enum": [ + "text" + ], + "description": "The type of the content part." + }, + "text": { + "type": "string", + "description": "The text content." + } + }, + "required": [ + "type", + "text" + ] + }, + "chatCompletionRequestMessageContentPartImage": { + "type": "object", + "title": "Image content part", + "properties": { + "type": { + "type": "string", + "enum": [ + "image_url" + ], + "description": "The type of the content part." + }, + "image_url": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "Either a URL of the image or the base64 encoded image data.", + "format": "uri" + }, + "detail": { + "type": "string", + "description": "Specifies the detail level of the image. Learn more in the [Vision guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/gpt-with-vision?tabs=rest%2Csystem-assigned%2Cresource#detail-parameter-settings-in-image-processing-low-high-auto).", + "enum": [ + "auto", + "low", + "high" + ], + "default": "auto" + } + }, + "required": [ + "url" + ] + } + }, + "required": [ + "type", + "image_url" + ] + }, + "chatCompletionRequestMessageContentPartRefusal": { + "type": "object", + "title": "Refusal content part", + "properties": { + "type": { + "type": "string", + "enum": [ + "refusal" + ], + "description": "The type of the content part." + }, + "refusal": { + "type": "string", + "description": "The refusal message generated by the model." + } + }, + "required": [ + "type", + "refusal" + ] + }, + "azureChatExtensionConfiguration": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/azureChatExtensionType" + } + }, + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_search": "#/components/schemas/azureSearchChatExtensionConfiguration", + "azure_cosmos_db": "#/components/schemas/azureCosmosDBChatExtensionConfiguration" + } + } + }, + "azureChatExtensionType": { + "type": "string", + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "enum": [ + "azure_search", + "azure_cosmos_db" + ], + "x-ms-enum": { + "name": "AzureChatExtensionType", + "modelAsString": true, + "values": [ + { + "name": "azureSearch", + "value": "azure_search", + "description": "Represents the use of Azure Search as an Azure OpenAI chat extension." + }, + { + "name": "azureCosmosDB", + "value": "azure_cosmos_db", + "description": "Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension." + } + ] + } + }, + "azureSearchChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureSearchChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_search" + }, + "azureSearchChatExtensionParameters": { + "required": [ + "authentication", + "endpoint", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + } + ] + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "endpoint": { + "type": "string", + "description": "The absolute endpoint path for the Azure Search resource to use.", + "format": "uri" + }, + "index_name": { + "type": "string", + "description": "The name of the index to use as available in the referenced Azure Search resource." + }, + "fields_mapping": { + "$ref": "#/components/schemas/azureSearchIndexFieldMappingOptions" + }, + "query_type": { + "$ref": "#/components/schemas/azureSearchQueryType" + }, + "semantic_configuration": { + "type": "string", + "description": "The additional semantic configuration for the query." + }, + "filter": { + "type": "string", + "description": "Search filter." + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + ] + } + }, + "description": "Parameters for Azure Search when used as an Azure OpenAI chat extension." + }, + "azureSearchIndexFieldMappingOptions": { + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Azure Search resource." + }, + "azureSearchQueryType": { + "type": "string", + "description": "The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "semantic", + "vector", + "vector_simple_hybrid", + "vector_semantic_hybrid" + ], + "x-ms-enum": { + "name": "AzureSearchQueryType", + "modelAsString": true, + "values": [ + { + "name": "simple", + "value": "simple", + "description": "Represents the default, simple query parser." + }, + { + "name": "semantic", + "value": "semantic", + "description": "Represents the semantic query parser for advanced semantic modeling." + }, + { + "name": "vector", + "value": "vector", + "description": "Represents vector search over computed data." + }, + { + "name": "vectorSimpleHybrid", + "value": "vector_simple_hybrid", + "description": "Represents a combination of the simple query strategy with vector data." + }, + { + "name": "vectorSemanticHybrid", + "value": "vector_semantic_hybrid", + "description": "Represents a combination of semantic search and vector data querying." + } + ] + } + }, + "azureCosmosDBChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureCosmosDBChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_cosmos_db" + }, + "azureCosmosDBChatExtensionParameters": { + "required": [ + "authentication", + "container_name", + "database_name", + "embedding_dependency", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "role_information": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "database_name": { + "type": "string", + "description": "The MongoDB vCore database name to use with Azure Cosmos DB." + }, + "container_name": { + "type": "string", + "description": "The name of the Azure Cosmos DB resource container." + }, + "index_name": { + "type": "string", + "description": "The MongoDB vCore index name to use with Azure Cosmos DB." + }, + "fields_mapping": { + "$ref": "#/components/schemas/azureCosmosDBFieldMappingOptions" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + ] + } + }, + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore." + }, + "azureCosmosDBFieldMappingOptions": { + "required": [ + "content_fields", + "vector_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource." + }, + "onYourDataAuthenticationOptions": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/onYourDataAuthenticationType" + } + }, + "description": "The authentication options for Azure OpenAI On Your Data.", + "discriminator": { + "propertyName": "type", + "mapping": { + "api_key": "#/components/schemas/onYourDataApiKeyAuthenticationOptions", + "connection_string": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions", + "system_assigned_managed_identity": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions", + "user_assigned_managed_identity": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + } + } + }, + "onYourDataAuthenticationType": { + "type": "string", + "description": "The authentication types supported with Azure OpenAI On Your Data.", + "enum": [ + "api_key", + "connection_string", + "system_assigned_managed_identity", + "user_assigned_managed_identity" + ], + "x-ms-enum": { + "name": "OnYourDataAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "api_key", + "description": "Authentication via API key." + }, + { + "name": "connectionString", + "value": "connection_string", + "description": "Authentication via connection string." + }, + { + "name": "systemAssignedManagedIdentity", + "value": "system_assigned_managed_identity", + "description": "Authentication via system-assigned managed identity." + }, + { + "name": "userAssignedManagedIdentity", + "value": "user_assigned_managed_identity", + "description": "Authentication via user-assigned managed identity." + } + ] + } + }, + "onYourDataApiKeyAuthenticationOptions": { + "required": [ + "key" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "key": { + "type": "string", + "description": "The API key to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "api_key" + }, + "onYourDataConnectionStringAuthenticationOptions": { + "required": [ + "connection_string" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a connection string.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "connection_string": { + "type": "string", + "description": "The connection string to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "connection_string" + }, + "onYourDataSystemAssignedManagedIdentityAuthenticationOptions": { + "description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "system_assigned_managed_identity" + }, + "onYourDataUserAssignedManagedIdentityAuthenticationOptions": { + "required": [ + "managed_identity_resource_id" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "managed_identity_resource_id": { + "type": "string", + "description": "The resource ID of the user-assigned managed identity to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "user_assigned_managed_identity" + }, + "onYourDataVectorizationSource": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/onYourDataVectorizationSourceType" + } + }, + "description": "An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search.", + "discriminator": { + "propertyName": "type", + "mapping": { + "endpoint": "#/components/schemas/onYourDataEndpointVectorizationSource", + "deployment_name": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + } + }, + "onYourDataVectorizationSourceType": { + "type": "string", + "description": "Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with\nvector search.", + "enum": [ + "endpoint", + "deployment_name" + ], + "x-ms-enum": { + "name": "OnYourDataVectorizationSourceType", + "modelAsString": true, + "values": [ + { + "name": "endpoint", + "value": "endpoint", + "description": "Represents vectorization performed by public service calls to an Azure OpenAI embedding model." + }, + { + "name": "deploymentName", + "value": "deployment_name", + "description": "Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but\nOn Your Data will use this model deployment via an internal call rather than a public one, which enables vector\nsearch even in private networks." + } + ] + } + }, + "onYourDataDeploymentNameVectorizationSource": { + "required": [ + "deployment_name" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non an internal embeddings model deployment name in the same Azure OpenAI resource.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "deployment_name": { + "type": "string", + "description": "Specifies the name of the model deployment to use for vectorization. This model deployment must be in the same Azure OpenAI resource, but On Your Data will use this model deployment via an internal call rather than a public one, which enables vector search even in private networks." + } + } + } + ], + "x-ms-discriminator-value": "deployment_name" + }, + "onYourDataEndpointVectorizationSource": { + "required": [ + "authentication", + "endpoint" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a public Azure OpenAI endpoint call for embeddings.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + "endpoint": { + "type": "string", + "description": "Specifies the endpoint to use for vectorization. This endpoint must be in the same Azure OpenAI resource, but On Your Data will use this endpoint via an internal call rather than a public one, which enables vector search even in private networks.", + "format": "uri" + } + } + } + ], + "x-ms-discriminator-value": "endpoint" + }, + "azureChatExtensionsMessageContext": { + "type": "object", + "properties": { + "citations": { + "type": "array", + "description": "The data source retrieval result, used to generate the assistant message in the response.", + "items": { + "$ref": "#/components/schemas/citation" + }, + "x-ms-identifiers": [] + }, + "intent": { + "type": "string", + "description": "The detected intent from the chat history, used to pass to the next turn to carry over the context." + } + }, + "description": " A representation of the additional context information available when Azure OpenAI chat extensions are involved\n in the generation of a corresponding chat completions response. This context information is only populated when\n using an Azure OpenAI request configured to use a matching extension." + }, + "citation": { + "required": [ + "content" + ], + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the citation." + }, + "title": { + "type": "string", + "description": "The title of the citation." + }, + "url": { + "type": "string", + "description": "The URL of the citation." + }, + "filepath": { + "type": "string", + "description": "The file path of the citation." + }, + "chunk_id": { + "type": "string", + "description": "The chunk ID of the citation." + } + }, + "description": "citation information for a chat completions response message." + }, + "chatCompletionMessageToolCall": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "$ref": "#/components/schemas/toolCallType" + }, + "function": { + "type": "object", + "description": "The function that the model called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + }, + "required": [ + "name", + "arguments" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "toolCallType": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool call, in this case `function`.", + "x-ms-enum": { + "name": "ToolCallType", + "modelAsString": true, + "values": [ + { + "value": "function", + "description": "The tool call type is function." + } + ] + } + }, + "chatCompletionRequestMessageTool": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "nullable": true, + "properties": { + "tool_call_id": { + "type": "string", + "description": "Tool call that this message is responding to." + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "tool_call_id", + "content" + ] + }, + "chatCompletionRequestMessageFunction": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "description": "Deprecated. Message that represents a function.", + "nullable": true, + "properties": { + "role": { + "type": "string", + "enum": [ + "function" + ], + "description": "The role of the messages author, in this case `function`." + }, + "name": { + "type": "string", + "description": "The contents of the message." + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "function_call_id", + "content" + ] + }, + "createChatCompletionResponse": { + "type": "object", + "description": "Represents a chat completion response returned by model, based on the provided input.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the chat completion." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/promptFilterResults" + }, + "choices": { + "type": "array", + "description": "A list of chat completion choices. Can be more than one if `n` is greater than 1.", + "items": { + "type": "object", + "required": [ + "finish_reason", + "index", + "message", + "logprobs" + ], + "properties": { + "finish_reason": { + "type": "string", + "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n", + "enum": [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call" + ] + }, + "index": { + "type": "integer", + "description": "The index of the choice in the list of choices." + }, + "message": { + "$ref": "#/components/schemas/chatCompletionResponseMessage" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterChoiceResults" + }, + "logprobs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + }, + "refusal": { + "description": "A list of message refusal tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content", + "refusal" + ] + } + } + } + }, + "created": { + "type": "integer", + "description": "The Unix timestamp (in seconds) of when the chat completion was created." + }, + "model": { + "type": "string", + "description": "The model used for the chat completion." + }, + "system_fingerprint": { + "type": "string", + "description": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" + }, + "object": { + "type": "string", + "description": "The object type, which is always `chat.completion`.", + "enum": [ + "chat.completion" + ] + }, + "usage": { + "$ref": "#/components/schemas/completionUsage" + } + }, + "required": [ + "choices", + "created", + "id", + "model", + "object" + ] + }, + "createChatCompletionStreamResponse": { + "type": "object", + "description": "Represents a streamed chunk of a chat completion response returned by model, based on the provided input.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the chat completion. Each chunk has the same ID." + }, + "choices": { + "type": "array", + "description": "A list of chat completion choices. Can contain more than one elements if `n` is greater than 1.\n", + "items": { + "type": "object", + "required": [ + "delta", + "finish_reason", + "index" + ], + "properties": { + "delta": { + "$ref": "#/components/schemas/chatCompletionStreamResponseDelta" + }, + "logprobs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + }, + "refusal": { + "description": "A list of message refusal tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content", + "refusal" + ] + }, + "finish_reason": { + "type": "string", + "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n", + "enum": [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call" + ], + "nullable": true + }, + "index": { + "type": "integer", + "description": "The index of the choice in the list of choices." + } + } + } + }, + "created": { + "type": "integer", + "description": "The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp." + }, + "model": { + "type": "string", + "description": "The model to generate the completion." + }, + "system_fingerprint": { + "type": "string", + "description": "This fingerprint represents the backend configuration that the model runs with.\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" + }, + "object": { + "type": "string", + "description": "The object type, which is always `chat.completion.chunk`.", + "enum": [ + "chat.completion.chunk" + ], + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ] + } + }, + "required": [ + "choices", + "created", + "id", + "model", + "object" + ] + }, + "chatCompletionStreamResponseDelta": { + "type": "object", + "description": "A chat completion delta generated by streamed model responses.", + "properties": { + "content": { + "type": "string", + "description": "The contents of the chunk message.", + "nullable": true + }, + "function_call": { + "deprecated": true, + "type": "object", + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "properties": { + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + }, + "name": { + "type": "string", + "description": "The name of the function to call." + } + } + }, + "tool_calls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCallChunk" + } + }, + "role": { + "type": "string", + "enum": [ + "system", + "user", + "assistant", + "tool" + ], + "description": "The role of the author of this message." + }, + "refusal": { + "type": "string", + "description": "The refusal message generated by the model.", + "nullable": true + } + } + }, + "chatCompletionMessageToolCallChunk": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + } + } + }, + "required": [ + "index" + ] + }, + "chatCompletionStreamOptions": { + "description": "Options for streaming response. Only set this when you set `stream: true`.\n", + "type": "object", + "nullable": true, + "default": null, + "properties": { + "include_usage": { + "type": "boolean", + "description": "If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value.\n" + } + } + }, + "chatCompletionChoiceLogProbs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + }, + "refusal": { + "description": "A list of message refusal tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content" + ] + }, + "chatCompletionTokenLogprob": { + "type": "object", + "properties": { + "token": { + "description": "The token.", + "type": "string" + }, + "logprob": { + "description": "The log probability of this token.", + "type": "number" + }, + "bytes": { + "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", + "type": "array", + "items": { + "type": "integer" + }, + "nullable": true + }, + "top_logprobs": { + "description": "List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.", + "type": "array", + "items": { + "type": "object", + "properties": { + "token": { + "description": "The token.", + "type": "string" + }, + "logprob": { + "description": "The log probability of this token.", + "type": "number" + }, + "bytes": { + "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", + "type": "array", + "items": { + "type": "integer" + }, + "nullable": true + } + }, + "required": [ + "token", + "logprob", + "bytes" + ] + } + } + }, + "required": [ + "token", + "logprob", + "bytes", + "top_logprobs" + ] + }, + "chatCompletionResponseMessage": { + "type": "object", + "description": "A chat completion message generated by the model.", + "properties": { + "role": { + "$ref": "#/components/schemas/chatCompletionResponseMessageRole" + }, + "refusal": { + "type": "string", + "description": "The refusal message generated by the model.", + "nullable": true + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + }, + "tool_calls": { + "type": "array", + "description": "The tool calls generated by the model, such as function calls.", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCall" + } + }, + "function_call": { + "$ref": "#/components/schemas/chatCompletionFunctionCall" + }, + "context": { + "$ref": "#/components/schemas/azureChatExtensionsMessageContext" + } + }, + "required": [ + "role", + "content", + "refusal" + ] + }, + "chatCompletionResponseMessageRole": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "The role of the author of the response message." + }, + "chatCompletionToolChoiceOption": { + "description": "Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools. Specifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool. `none` is the default when no tools are present. `auto` is the default if tools are present.", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.", + "enum": [ + "none", + "auto", + "required" + ] + }, + { + "$ref": "#/components/schemas/chatCompletionNamedToolChoice" + } + ] + }, + "chatCompletionNamedToolChoice": { + "type": "object", + "description": "Specifies a tool the model should use. Use to force the model to call a specific function.", + "properties": { + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "type", + "function" + ] + }, + "ParallelToolCalls": { + "type": "boolean", + "description": "Whether to enable parallel function calling during tool use.", + "default": true + }, + "chatCompletionMessageToolCalls": { + "type": "array", + "description": "The tool calls generated by the model, such as function calls.", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCall" + } + }, + "chatCompletionFunctionCall": { + "type": "object", + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + }, + "required": [ + "name", + "arguments" + ] + }, + "completionUsage": { + "type": "object", + "description": "Usage statistics for the completion request.", + "properties": { + "prompt_tokens": { + "type": "integer", + "description": "Number of tokens in the prompt." + }, + "completion_tokens": { + "type": "integer", + "description": "Number of tokens in the generated completion." + }, + "total_tokens": { + "type": "integer", + "description": "Total number of tokens used in the request (prompt + completion)." + }, + "completion_tokens_details": { + "type": "object", + "description": "Breakdown of tokens used in a completion.", + "properties": { + "reasoning_tokens": { + "type": "integer", + "description": "Tokens generated by the model for reasoning." + } + } + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ] + }, + "chatCompletionTool": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "$ref": "#/components/schemas/FunctionObject" + } + }, + "required": [ + "type", + "function" + ] + }, + "FunctionParameters": { + "type": "object", + "description": "The parameters the functions accepts, described as a JSON Schema object. See the guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "additionalProperties": true + }, + "FunctionObject": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/FunctionParameters" + }, + "strict": { + "type": "boolean", + "nullable": true, + "default": false, + "description": "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling)." + } + }, + "required": [ + "name" + ] + }, + "ResponseFormatText": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of response format being defined: `text`", + "enum": [ + "text" + ] + } + }, + "required": [ + "type" + ] + }, + "ResponseFormatJsonObject": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of response format being defined: `json_object`", + "enum": [ + "json_object" + ] + } + }, + "required": [ + "type" + ] + }, + "ResponseFormatJsonSchemaSchema": { + "type": "object", + "description": "The schema for the response format, described as a JSON Schema object.", + "additionalProperties": true + }, + "ResponseFormatJsonSchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of response format being defined: `json_schema`", + "enum": [ + "json_schema" + ] + }, + "json_schema": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of what the response format is for, used by the model to determine how to respond in the format." + }, + "name": { + "type": "string", + "description": "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "schema": { + "$ref": "#/components/schemas/ResponseFormatJsonSchemaSchema" + }, + "strict": { + "type": "boolean", + "nullable": true, + "default": false, + "description": "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`." + } + }, + "required": [ + "type", + "name" + ] + } + }, + "required": [ + "type", + "json_schema" + ] + }, + "chatCompletionChoiceCommon": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "finish_reason": { + "type": "string" + } + } + }, + "createTranslationRequest": { + "type": "object", + "description": "Translation request.", + "properties": { + "file": { + "type": "string", + "description": "The audio file to translate.", + "format": "binary" + }, + "prompt": { + "type": "string", + "description": "An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English." + }, + "response_format": { + "$ref": "#/components/schemas/audioResponseFormat" + }, + "temperature": { + "type": "number", + "default": 0, + "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + } + }, + "required": [ + "file" + ] + }, + "audioResponse": { + "description": "Translation or transcription response when response_format was json", + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "Translated or transcribed text." + } + }, + "required": [ + "text" + ] + }, + "audioVerboseResponse": { + "description": "Translation or transcription response when response_format was verbose_json", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "properties": { + "task": { + "type": "string", + "description": "Type of audio task.", + "enum": [ + "transcribe", + "translate" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "language": { + "type": "string", + "description": "Language." + }, + "duration": { + "type": "number", + "description": "Duration." + }, + "segments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/audioSegment" + } + } + } + } + ], + "required": [ + "text" + ] + }, + "audioResponseFormat": { + "title": "AudioResponseFormat", + "description": "Defines the format of the output.", + "enum": [ + "json", + "text", + "srt", + "verbose_json", + "vtt" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true + } + }, + "createTranscriptionRequest": { + "type": "object", + "description": "Transcription request.", + "properties": { + "file": { + "type": "string", + "description": "The audio file object to transcribe.", + "format": "binary" + }, + "prompt": { + "type": "string", + "description": "An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language." + }, + "response_format": { + "$ref": "#/components/schemas/audioResponseFormat" + }, + "temperature": { + "type": "number", + "default": 0, + "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + }, + "language": { + "type": "string", + "description": "The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency." + } + }, + "required": [ + "file" + ] + }, + "audioSegment": { + "type": "object", + "description": "Transcription or translation segment.", + "properties": { + "id": { + "type": "integer", + "description": "Segment identifier." + }, + "seek": { + "type": "number", + "description": "Offset of the segment." + }, + "start": { + "type": "number", + "description": "Segment start offset." + }, + "end": { + "type": "number", + "description": "Segment end offset." + }, + "text": { + "type": "string", + "description": "Segment text." + }, + "tokens": { + "type": "array", + "items": { + "type": "number", + "nullable": false + }, + "description": "Tokens of the text." + }, + "temperature": { + "type": "number", + "description": "Temperature." + }, + "avg_logprob": { + "type": "number", + "description": "Average log probability." + }, + "compression_ratio": { + "type": "number", + "description": "Compression ratio." + }, + "no_speech_prob": { + "type": "number", + "description": "Probability of 'no speech'." + } + } + }, + "imageQuality": { + "description": "The quality of the image that will be generated.", + "type": "string", + "enum": [ + "standard", + "hd" + ], + "default": "standard", + "x-ms-enum": { + "name": "Quality", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Standard quality creates images with standard quality.", + "name": "Standard" + }, + { + "value": "hd", + "description": "HD quality creates images with finer details and greater consistency across the image.", + "name": "HD" + } + ] + } + }, + "imagesResponseFormat": { + "description": "The format in which the generated images are returned.", + "type": "string", + "enum": [ + "url", + "b64_json" + ], + "default": "url", + "x-ms-enum": { + "name": "ImagesResponseFormat", + "modelAsString": true, + "values": [ + { + "value": "url", + "description": "The URL that provides temporary access to download the generated images.", + "name": "Url" + }, + { + "value": "b64_json", + "description": "The generated images are returned as base64 encoded string.", + "name": "Base64Json" + } + ] + } + }, + "imageSize": { + "description": "The size of the generated images.", + "type": "string", + "enum": [ + "1792x1024", + "1024x1792", + "1024x1024" + ], + "default": "1024x1024", + "x-ms-enum": { + "name": "Size", + "modelAsString": true, + "values": [ + { + "value": "1792x1024", + "description": "The desired size of the generated image is 1792x1024 pixels.", + "name": "Size1792x1024" + }, + { + "value": "1024x1792", + "description": "The desired size of the generated image is 1024x1792 pixels.", + "name": "Size1024x1792" + }, + { + "value": "1024x1024", + "description": "The desired size of the generated image is 1024x1024 pixels.", + "name": "Size1024x1024" + } + ] + } + }, + "imageStyle": { + "description": "The style of the generated images.", + "type": "string", + "enum": [ + "vivid", + "natural" + ], + "default": "vivid", + "x-ms-enum": { + "name": "Style", + "modelAsString": true, + "values": [ + { + "value": "vivid", + "description": "Vivid creates images that are hyper-realistic and dramatic.", + "name": "Vivid" + }, + { + "value": "natural", + "description": "Natural creates images that are more natural and less hyper-realistic.", + "name": "Natural" + } + ] + } + }, + "imageGenerationsRequest": { + "type": "object", + "properties": { + "prompt": { + "description": "A text description of the desired image(s). The maximum length is 4000 characters.", + "type": "string", + "format": "string", + "example": "a corgi in a field", + "minLength": 1 + }, + "n": { + "description": "The number of images to generate.", + "type": "integer", + "minimum": 1, + "maximum": 1, + "default": 1 + }, + "size": { + "$ref": "#/components/schemas/imageSize" + }, + "response_format": { + "$ref": "#/components/schemas/imagesResponseFormat" + }, + "user": { + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.", + "type": "string", + "format": "string", + "example": "user123456" + }, + "quality": { + "$ref": "#/components/schemas/imageQuality" + }, + "style": { + "$ref": "#/components/schemas/imageStyle" + } + }, + "required": [ + "prompt" + ] + }, + "generateImagesResponse": { + "type": "object", + "properties": { + "created": { + "type": "integer", + "format": "unixtime", + "description": "The unix timestamp when the operation was created.", + "example": "1676540381" + }, + "data": { + "type": "array", + "description": "The result data of the operation, if successful", + "items": { + "$ref": "#/components/schemas/imageResult" + } + } + }, + "required": [ + "created", + "data" + ] + }, + "imageResult": { + "type": "object", + "description": "The image url or encoded image if successful, and an error otherwise.", + "properties": { + "url": { + "type": "string", + "description": "The image url.", + "example": "https://www.contoso.com" + }, + "b64_json": { + "type": "string", + "description": "The base64 encoded image" + }, + "content_filter_results": { + "$ref": "#/components/schemas/dalleContentFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The prompt that was used to generate the image, if there was any revision to the prompt." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/dalleFilterResults" + } + } + } + }, + "securitySchemes": { + "bearer": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": {} + } + }, + "x-tokenInfoFunc": "api.middleware.auth.bearer_auth", + "x-scopeValidateFunc": "api.middleware.auth.validate_scopes" + }, + "apiKey": { + "type": "apiKey", + "name": "api-key", + "in": "header" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/inference.yaml new file mode 100644 index 000000000000..edab6fcd22a7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/inference.yaml @@ -0,0 +1,2600 @@ +openapi: 3.0.0 +info: + title: Azure OpenAI Service API + description: Azure OpenAI APIs for completions and search + version: '2024-10-21' +servers: + - url: https://{endpoint}/openai + variables: + endpoint: + default: your-resource-name.openai.azure.com +security: + - bearer: + - api.read + - apiKey: [] +paths: + /deployments/{deployment-id}/completions: + post: + summary: Creates a completion for the provided prompt, parameters and chosen model. + operationId: Completions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: davinci + description: Deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-10-21 + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createCompletionRequest" + example: + prompt: |- + Negate the following sentence.The price for bubblegum increased on thursday. + + Negated Sentence: + max_tokens: 50 + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/createCompletionResponse" + example: + model: davinci + object: text_completion + id: cmpl-4509KAos68kxOqpE2uYGw81j6m7uo + created: 1637097562 + choices: + - index: 0 + text: The price for bubblegum decreased on thursday. + logprobs: null + finish_reason: stop + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + default: + description: Service unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/errorResponse" + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + /deployments/{deployment-id}/embeddings: + post: + summary: Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. + operationId: embeddings_create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: ada-search-index-v1 + description: The deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: '2024-10-21' + description: api version + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: true + properties: + input: + description: |- + Input text to get embeddings for, encoded as a string. To get embeddings for multiple inputs in a single request, pass an array of strings. Each input must not exceed 2048 tokens in length. + Unless you are embedding code, we suggest replacing newlines (\n) in your input with a single space, as we have observed inferior results when newlines are present. + oneOf: + - type: string + default: "" + example: This is a test. + nullable: true + - type: array + minItems: 1 + maxItems: 2048 + items: + type: string + minLength: 1 + example: This is a test. + nullable: false + user: + description: A unique identifier representing your end-user, which can help monitoring and detecting abuse. + type: string + nullable: false + input_type: + description: input type of embedding search to use + type: string + example: query + encoding_format: + description: The format to return the embeddings in. Can be either `float` or `base64`. Defaults to `float`. + type: string + example: base64 + nullable: true + dimensions: + description: The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. + type: integer + example: 1 + nullable: true + required: + - input + responses: + "200": + description: OK + content: + application/json: + schema: + type: object + properties: + object: + type: string + model: + type: string + data: + type: array + items: + type: object + properties: + index: + type: integer + object: + type: string + embedding: + type: array + items: + type: number + required: + - index + - object + - embedding + usage: + type: object + properties: + prompt_tokens: + type: integer + total_tokens: + type: integer + required: + - prompt_tokens + - total_tokens + required: + - object + - model + - data + - usage + x-ms-examples: + Create a embeddings.: + $ref: ./examples/embeddings.yaml + /deployments/{deployment-id}/chat/completions: + post: + summary: Creates a completion for the chat message + operationId: ChatCompletions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + description: Deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: '2024-10-21' + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createChatCompletionRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/createChatCompletionResponse" + - $ref: "#/components/schemas/createChatCompletionStreamResponse" + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + default: + description: Service unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/errorResponse" + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + x-ms-examples: + Create a chat completion.: + $ref: ./examples/chat_completions.yaml + Creates a completion based on Azure Search data and system-assigned managed identity.: + $ref: ./examples/chat_completions_azure_search_minimum.yaml + Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.: + $ref: ./examples/chat_completions_azure_search_advanced.yaml + Creates a completion for the provided Azure Cosmos DB.: + $ref: ./examples/chat_completions_cosmos_db.yaml + /deployments/{deployment-id}/audio/transcriptions: + post: + summary: Transcribes audio into the input language. + operationId: Transcriptions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: whisper + description: Deployment id of the whisper model. + - in: query + name: api-version + required: true + schema: + type: string + example: '2024-10-21' + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/createTranscriptionRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/audioResponse' + - $ref: '#/components/schemas/audioVerboseResponse' + text/plain: + schema: + type: string + description: Transcribed text in the output format (when response_format was one of text, vtt or srt). + x-ms-examples: + Create an audio transcription with json response format.: + $ref: ./examples/audio_transcription_object.yaml + Create an audio transcription with text response format.: + $ref: ./examples/audio_transcription_text.yaml + /deployments/{deployment-id}/audio/translations: + post: + summary: Transcribes and translates input audio into English text. + operationId: Translations_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: whisper + description: Deployment id of the whisper model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: '2024-10-21' + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/createTranslationRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/audioResponse' + - $ref: '#/components/schemas/audioVerboseResponse' + text/plain: + schema: + type: string + description: Transcribed text in the output format (when response_format was one of text, vtt or srt). + x-ms-examples: + Create an audio translation with json response format.: + $ref: ./examples/audio_translation_object.yaml + Create an audio translation with text response format.: + $ref: ./examples/audio_translation_text.yaml + /deployments/{deployment-id}/images/generations: + post: + summary: Generates a batch of images from a text caption on a given DALLE model deployment + operationId: ImageGenerations_Create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/imageGenerationsRequest' + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: dalle-deployment + description: Deployment id of the dalle model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: '2024-10-21' + description: api version + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/generateImagesResponse' + default: + description: An error occurred. + content: + application/json: + schema: + $ref: '#/components/schemas/dalleErrorResponse' + x-ms-examples: + Create an image.: + $ref: ./examples/image_generation.yaml +components: + schemas: + errorResponse: + type: object + properties: + error: + $ref: "#/components/schemas/error" + errorBase: + type: object + properties: + code: + type: string + message: + type: string + error: + type: object + allOf: + - $ref: "#/components/schemas/errorBase" + properties: + param: + type: string + type: + type: string + inner_error: + $ref: "#/components/schemas/innerError" + innerError: + description: Inner error with additional details. + type: object + properties: + code: + $ref: "#/components/schemas/innerErrorCode" + content_filter_results: + $ref: "#/components/schemas/contentFilterPromptResults" + innerErrorCode: + description: Error codes for the inner error object. + enum: + - ResponsibleAIPolicyViolation + type: string + x-ms-enum: + name: InnerErrorCode + modelAsString: true + values: + - value: ResponsibleAIPolicyViolation + description: The prompt violated one of more content filter rules. + dalleErrorResponse: + type: object + properties: + error: + $ref: "#/components/schemas/dalleError" + dalleError: + type: object + allOf: + - $ref: "#/components/schemas/errorBase" + properties: + param: + type: string + type: + type: string + inner_error: + $ref: "#/components/schemas/dalleInnerError" + dalleInnerError: + description: Inner error with additional details. + type: object + properties: + code: + $ref: "#/components/schemas/innerErrorCode" + content_filter_results: + $ref: "#/components/schemas/dalleFilterResults" + revised_prompt: + type: string + description: The prompt that was used to generate the image, if there was any revision to the prompt. + contentFilterResultBase: + type: object + properties: + filtered: + type: boolean + required: + - filtered + contentFilterSeverityResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + severity: + type: string + enum: + - safe + - low + - medium + - high + x-ms-enum: + name: ContentFilterSeverity + modelAsString: true + values: + - value: safe + description: General content or related content in generic or non-harmful contexts. + - value: low + description: Harmful content at a low intensity and risk level. + - value: medium + description: Harmful content at a medium intensity and risk level. + - value: high + description: Harmful content at a high intensity and risk level. + required: + - severity + - filtered + contentFilterDetectedResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + detected: + type: boolean + required: + - detected + - filtered + contentFilterDetectedWithCitationResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterDetectedResult" + - properties: + citation: + type: object + properties: + URL: + type: string + license: + type: string + required: + - detected + - filtered + contentFilterResultsBase: + type: object + description: Information about the content filtering results. + properties: + sexual: + $ref: "#/components/schemas/contentFilterSeverityResult" + violence: + $ref: "#/components/schemas/contentFilterSeverityResult" + hate: + $ref: "#/components/schemas/contentFilterSeverityResult" + self_harm: + $ref: "#/components/schemas/contentFilterSeverityResult" + profanity: + $ref: "#/components/schemas/contentFilterDetectedResult" + error: + $ref: "#/components/schemas/errorBase" + contentFilterPromptResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: "#/components/schemas/contentFilterResultsBase" + - properties: + jailbreak: + $ref: "#/components/schemas/contentFilterDetectedResult" + contentFilterChoiceResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: "#/components/schemas/contentFilterResultsBase" + - properties: + protected_material_text: + $ref: "#/components/schemas/contentFilterDetectedResult" + - properties: + protected_material_code: + $ref: "#/components/schemas/contentFilterDetectedWithCitationResult" + promptFilterResult: + type: object + description: Content filtering results for a single prompt in the request. + properties: + prompt_index: + type: integer + content_filter_results: + $ref: "#/components/schemas/contentFilterPromptResults" + promptFilterResults: + type: array + description: Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders. + items: + $ref: "#/components/schemas/promptFilterResult" + dalleContentFilterResults: + type: object + description: Information about the content filtering results. + properties: + sexual: + $ref: "#/components/schemas/contentFilterSeverityResult" + violence: + $ref: "#/components/schemas/contentFilterSeverityResult" + hate: + $ref: "#/components/schemas/contentFilterSeverityResult" + self_harm: + $ref: "#/components/schemas/contentFilterSeverityResult" + dalleFilterResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: "#/components/schemas/dalleContentFilterResults" + - properties: + profanity: + $ref: "#/components/schemas/contentFilterDetectedResult" + jailbreak: + $ref: "#/components/schemas/contentFilterDetectedResult" + chatCompletionsRequestCommon: + type: object + properties: + temperature: + description: |- + What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + We generally recommend altering this or `top_p` but not both. + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + description: |- + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + We generally recommend altering this or `temperature` but not both. + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + stream: + description: "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message." + type: boolean + nullable: true + default: false + stop: + description: Up to 4 sequences where the API will stop generating further tokens. + oneOf: + - type: string + nullable: true + - type: array + items: + type: string + nullable: false + minItems: 1 + maxItems: 4 + description: Array minimum size of 1 and maximum of 4 + default: null + max_tokens: + description: | + The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). + + This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with o1 series models. + type: integer + default: 4096 + max_completion_tokens: + description: | + An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. + + type: integer + nullable: true + presence_penalty: + description: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + type: number + default: 0 + minimum: -2 + maximum: 2 + frequency_penalty: + description: Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + type: number + default: 0 + minimum: -2 + maximum: 2 + logit_bias: + description: Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + type: object + nullable: true + user: + description: A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse. + type: string + example: user-1234 + nullable: false + createCompletionRequest: + type: object + properties: + prompt: + description: &completions_prompt_description | + The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays. + + Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document. + default: "<|endoftext|>" + nullable: true + oneOf: + - type: string + default: "" + example: "This is a test." + - type: array + items: + type: string + default: "" + example: "This is a test." + best_of: + type: integer + default: 1 + minimum: 0 + maximum: 20 + nullable: true + description: &completions_best_of_description | + Generates `best_of` completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed. + + When used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`. + + **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`. + echo: + type: boolean + default: false + nullable: true + description: &completions_echo_description > + Echo back the prompt in addition to the completion + frequency_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: &completions_frequency_penalty_description | + Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + + logit_bias: &completions_logit_bias + type: object + x-oaiTypeLabel: map + default: null + nullable: true + additionalProperties: + type: integer + description: &completions_logit_bias_description | + Modify the likelihood of specified tokens appearing in the completion. + + Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + + As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token from being generated. + logprobs: &completions_logprobs_configuration + type: integer + minimum: 0 + maximum: 5 + default: null + nullable: true + description: &completions_logprobs_description | + Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response. + + The maximum value for `logprobs` is 5. + max_tokens: + type: integer + minimum: 0 + default: 16 + example: 16 + nullable: true + description: &completions_max_tokens_description | + The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the completion. + + The token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. + n: + type: integer + minimum: 1 + maximum: 128 + default: 1 + example: 1 + nullable: true + description: &completions_completions_description | + How many completions to generate for each prompt. + + **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`. + presence_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: &completions_presence_penalty_description | + Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + seed: &completions_seed_param + type: integer + minimum: -9223372036854775808 + maximum: 9223372036854775807 + nullable: true + description: | + If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. + + Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. + stop: + description: &completions_stop_description > + Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. + default: null + nullable: true + oneOf: + - type: string + default: <|endoftext|> + example: "\n" + nullable: true + - type: array + minItems: 1 + maxItems: 4 + items: + type: string + example: '["\n"]' + stream: + description: > + Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) + as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). + type: boolean + nullable: true + default: false + suffix: + description: | + The suffix that comes after a completion of inserted text. + + This parameter is only supported for `gpt-3.5-turbo-instruct`. + default: null + nullable: true + type: string + example: "test." + stream_options: + $ref: "#/components/schemas/chatCompletionStreamOptions" + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: &completions_temperature_description | + What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + + We generally recommend altering this or `top_p` but not both. + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: &completions_top_p_description | + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + + We generally recommend altering this or `temperature` but not both. + user: &end_user_param_configuration + type: string + example: user-1234 + description: | + A unique identifier representing your end-user, which can help to monitor and detect abuse. + required: + - prompt + + createCompletionResponse: + type: object + description: | + Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint). + properties: + id: + type: string + description: A unique identifier for the completion. + choices: + type: array + description: The list of completion choices the model generated for the input prompt. + items: + type: object + required: + - finish_reason + - index + - logprobs + - text + properties: + finish_reason: + type: string + description: &completion_finish_reason_description | + The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, + `length` if the maximum number of tokens specified in the request was reached, + or `content_filter` if content was omitted due to a flag from our content filters. + enum: ["stop", "length", "content_filter"] + index: + type: integer + logprobs: + type: object + nullable: true + properties: + text_offset: + type: array + items: + type: integer + token_logprobs: + type: array + items: + type: number + tokens: + type: array + items: + type: string + top_logprobs: + type: array + items: + type: object + additionalProperties: + type: number + text: + type: string + content_filter_results: + $ref: "#/components/schemas/contentFilterChoiceResults" + created: + type: integer + description: The Unix timestamp (in seconds) of when the completion was created. + model: + type: string + description: The model used for completion. + prompt_filter_results: + $ref: "#/components/schemas/promptFilterResults" + system_fingerprint: + type: string + description: | + This fingerprint represents the backend configuration that the model runs with. + + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + object: + type: string + description: The object type, which is always "text_completion" + enum: [text_completion] + usage: + $ref: "#/components/schemas/completionUsage" + required: + - id + - object + - created + - model + - choices + + createChatCompletionRequest: + type: object + allOf: + - $ref: "#/components/schemas/chatCompletionsRequestCommon" + - properties: + messages: + description: A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb). + type: array + minItems: 1 + items: + $ref: "#/components/schemas/chatCompletionRequestMessage" + data_sources: + type: array + description: |2- + The configuration entries for Azure OpenAI chat extensions that use them. + This additional specification is only compatible with Azure OpenAI. + items: + $ref: "#/components/schemas/azureChatExtensionConfiguration" + frequency_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: *completions_frequency_penalty_description + logit_bias: + type: object + default: null + nullable: true + additionalProperties: + type: integer + description: | + Modify the likelihood of specified tokens appearing in the completion. + + Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + logprobs: + description: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. + type: boolean + default: false + nullable: true + top_logprobs: + description: An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. + type: integer + minimum: 0 + maximum: 20 + nullable: true + max_tokens: + description: | + The maximum number of [tokens](/tokenizer) that can be generated in the chat completion. + + The total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. + type: integer + nullable: true + n: + type: integer + minimum: 1 + maximum: 128 + default: 1 + example: 1 + nullable: true + description: How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs. + parallel_tool_calls: + $ref: "#/components/schemas/ParallelToolCalls" + presence_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: *completions_presence_penalty_description + response_format: + description: | + An object specifying the format that the model must output. Compatible with [GPT-4o](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4o mini](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4 Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models) and all [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-35) Turbo models newer than `gpt-3.5-turbo-1106`. + + Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which guarantees the model will match your supplied JSON schema. + + Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. + + **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. + oneOf: + - $ref: "#/components/schemas/ResponseFormatText" + - $ref: "#/components/schemas/ResponseFormatJsonObject" + - $ref: "#/components/schemas/ResponseFormatJsonSchema" + x-oaiExpandable: true + seed: + type: integer + minimum: -9223372036854775808 + maximum: 9223372036854775807 + nullable: true + description: | + This feature is in Beta. + If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. + Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. + stop: + description: | + Up to 4 sequences where the API will stop generating further tokens. + default: null + oneOf: + - type: string + nullable: true + - type: array + minItems: 1 + maxItems: 4 + items: + type: string + stream: + description: > + If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) + as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). + type: boolean + nullable: true + default: false + stream_options: + $ref: "#/components/schemas/chatCompletionStreamOptions" + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: *completions_temperature_description + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *completions_top_p_description + tools: + type: array + description: > + A list of tools the model may call. Currently, only functions are supported as a tool. + Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported. + items: + $ref: "#/components/schemas/chatCompletionTool" + tool_choice: + $ref: "#/components/schemas/chatCompletionToolChoiceOption" + function_call: + deprecated: true + description: | + Deprecated in favor of `tool_choice`. + + Controls which (if any) function is called by the model. + `none` means the model will not call a function and instead generates a message. + `auto` means the model can pick between generating a message or calling a function. + Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. + + `none` is the default when no functions are present. `auto` is the default if functions are present. + oneOf: + - type: string + description: > + `none` means the model will not call a function and instead generates a message. + `auto` means the model can pick between generating a message or calling a function. + enum: [none, auto] + - $ref: "#/components/schemas/chatCompletionFunctionCallOption" + x-oaiExpandable: true + functions: + deprecated: true + description: | + Deprecated in favor of `tools`. + + A list of functions the model may generate JSON inputs for. + type: array + minItems: 1 + maxItems: 128 + items: + $ref: "#/components/schemas/chatCompletionFunctions" + user: *end_user_param_configuration + + required: + - messages + + chatCompletionFunctions: + type: object + deprecated: true + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: "#/components/schemas/FunctionParameters" + required: + - name + + chatCompletionFunctionCallOption: + type: object + description: > + Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. + properties: + name: + type: string + description: The name of the function to call. + required: + - name + + + chatCompletionRequestMessage: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestSystemMessage" + - $ref: "#/components/schemas/chatCompletionRequestUserMessage" + - $ref: "#/components/schemas/chatCompletionRequestAssistantMessage" + - $ref: "#/components/schemas/chatCompletionRequestToolMessage" + - $ref: "#/components/schemas/chatCompletionRequestFunctionMessage" + + chatCompletionRequestSystemMessage: + type: object + title: System message + properties: + content: + description: The contents of the system message. + oneOf: + - type: string + description: The contents of the system message. + title: Text content + - type: array + description: An array of content parts with a defined type. For system messages, only type `text` is supported. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestSystemMessageContentPart" + minItems: 1 + role: + type: string + enum: ["system"] + description: The role of the messages author, in this case `system`. + name: + type: string + description: An optional name for the participant. Provides the model information to differentiate between participants of the same role. + required: + - content + - role + + chatCompletionRequestUserMessage: + type: object + title: User message + properties: + content: + description: | + The contents of the user message. + oneOf: + - type: string + description: The text contents of the message. + title: Text content + - type: array + description: An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4o` model. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestUserMessageContentPart" + minItems: 1 + x-oaiExpandable: true + role: + type: string + enum: ["user"] + description: The role of the messages author, in this case `user`. + name: + type: string + description: An optional name for the participant. Provides the model information to differentiate between participants of the same role. + required: + - content + - role + + chatCompletionRequestAssistantMessage: + type: object + title: Assistant message + properties: + content: + nullable: true + oneOf: + - type: string + description: The contents of the assistant message. + title: Text content + - type: array + description: An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestAssistantMessageContentPart" + minItems: 1 + description: | + The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified. + refusal: + nullable: true + type: string + description: The refusal message by the assistant. + role: + type: string + enum: ["assistant"] + description: The role of the messages author, in this case `assistant`. + name: + type: string + description: An optional name for the participant. Provides the model information to differentiate between participants of the same role. + tool_calls: + $ref: "#/components/schemas/chatCompletionMessageToolCalls" + function_call: + type: object + deprecated: true + description: "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model." + nullable: true + properties: + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + name: + type: string + description: The name of the function to call. + required: + - arguments + - name + required: + - role + + chatCompletionRequestToolMessage: + type: object + title: Tool message + properties: + role: + type: string + enum: ["tool"] + description: The role of the messages author, in this case `tool`. + content: + oneOf: + - type: string + description: The contents of the tool message. + title: Text content + - type: array + description: An array of content parts with a defined type. For tool messages, only type `text` is supported. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestToolMessageContentPart" + minItems: 1 + description: The contents of the tool message. + tool_call_id: + type: string + description: Tool call that this message is responding to. + required: + - role + - content + - tool_call_id + + chatCompletionRequestFunctionMessage: + type: object + title: Function message + deprecated: true + properties: + role: + type: string + enum: ["function"] + description: The role of the messages author, in this case `function`. + content: + nullable: true + type: string + description: The contents of the function message. + name: + type: string + description: The name of the function to call. + required: + - role + - content + - name + + chatCompletionRequestSystemMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + + chatCompletionRequestUserMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartImage" + + chatCompletionRequestAssistantMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartRefusal" + + chatCompletionRequestToolMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + + chatCompletionRequestMessageContentPartText: + type: object + title: Text content part + properties: + type: + type: string + enum: ["text"] + description: The type of the content part. + text: + type: string + description: The text content. + required: + - type + - text + + chatCompletionRequestMessageContentPartImage: + type: object + title: Image content part + properties: + type: + type: string + enum: ["image_url"] + description: The type of the content part. + image_url: + type: object + properties: + url: + type: string + description: Either a URL of the image or the base64 encoded image data. + format: uri + detail: + type: string + description: Specifies the detail level of the image. Learn more in the [Vision guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/gpt-with-vision?tabs=rest%2Csystem-assigned%2Cresource#detail-parameter-settings-in-image-processing-low-high-auto). + enum: ["auto", "low", "high"] + default: "auto" + required: + - url + required: + - type + - image_url + + chatCompletionRequestMessageContentPartRefusal: + type: object + title: Refusal content part + properties: + type: + type: string + enum: ["refusal"] + description: The type of the content part. + refusal: + type: string + description: The refusal message generated by the model. + required: + - type + - refusal + azureChatExtensionConfiguration: + required: + - type + type: object + properties: + type: + $ref: "#/components/schemas/azureChatExtensionType" + description: |2- + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + discriminator: + propertyName: type + mapping: + azure_search: "#/components/schemas/azureSearchChatExtensionConfiguration" + azure_cosmos_db: "#/components/schemas/azureCosmosDBChatExtensionConfiguration" + azureChatExtensionType: + type: string + description: |2- + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + enum: + - azure_search + - azure_cosmos_db + x-ms-enum: + name: AzureChatExtensionType + modelAsString: true + values: + - name: azureSearch + value: azure_search + description: Represents the use of Azure Search as an Azure OpenAI chat extension. + - name: azureCosmosDB + value: azure_cosmos_db + description: Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension. + azureSearchChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/azureSearchChatExtensionParameters" + x-ms-discriminator-value: azure_search + azureSearchChatExtensionParameters: + required: + - authentication + - endpoint + - index_name + type: object + properties: + authentication: + oneOf: + - $ref: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + role_information: + type: string + description: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit. + endpoint: + type: string + description: The absolute endpoint path for the Azure Search resource to use. + format: uri + index_name: + type: string + description: The name of the index to use as available in the referenced Azure Search resource. + fields_mapping: + $ref: "#/components/schemas/azureSearchIndexFieldMappingOptions" + query_type: + $ref: "#/components/schemas/azureSearchQueryType" + semantic_configuration: + type: string + description: The additional semantic configuration for the query. + filter: + type: string + description: Search filter. + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + description: Parameters for Azure Search when used as an Azure OpenAI chat extension. + azureSearchIndexFieldMappingOptions: + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Azure Search resource. + azureSearchQueryType: + type: string + description: The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension. + enum: + - simple + - semantic + - vector + - vector_simple_hybrid + - vector_semantic_hybrid + x-ms-enum: + name: AzureSearchQueryType + modelAsString: true + values: + - name: simple + value: simple + description: Represents the default, simple query parser. + - name: semantic + value: semantic + description: Represents the semantic query parser for advanced semantic modeling. + - name: vector + value: vector + description: Represents vector search over computed data. + - name: vectorSimpleHybrid + value: vector_simple_hybrid + description: Represents a combination of the simple query strategy with vector data. + - name: vectorSemanticHybrid + value: vector_semantic_hybrid + description: Represents a combination of semantic search and vector data querying. + azureCosmosDBChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/azureCosmosDBChatExtensionParameters" + x-ms-discriminator-value: azure_cosmos_db + azureCosmosDBChatExtensionParameters: + required: + - authentication + - container_name + - database_name + - embedding_dependency + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: '#/components/schemas/onYourDataConnectionStringAuthenticationOptions' + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + role_information: + type: string + description: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit. + database_name: + type: string + description: The MongoDB vCore database name to use with Azure Cosmos DB. + container_name: + type: string + description: The name of the Azure Cosmos DB resource container. + index_name: + type: string + description: The MongoDB vCore index name to use with Azure Cosmos DB. + fields_mapping: + $ref: "#/components/schemas/azureCosmosDBFieldMappingOptions" + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + description: |- + Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for + MongoDB vCore. + azureCosmosDBFieldMappingOptions: + required: + - content_fields + - vector_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource. + onYourDataAuthenticationOptions: + required: + - type + type: object + properties: + type: + $ref: "#/components/schemas/onYourDataAuthenticationType" + description: The authentication options for Azure OpenAI On Your Data. + discriminator: + propertyName: type + mapping: + api_key: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + connection_string: "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + system_assigned_managed_identity: "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + user_assigned_managed_identity: "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + onYourDataAuthenticationType: + type: string + description: The authentication types supported with Azure OpenAI On Your Data. + enum: + - api_key + - connection_string + - system_assigned_managed_identity + - user_assigned_managed_identity + x-ms-enum: + name: OnYourDataAuthenticationType + modelAsString: true + values: + - name: apiKey + value: api_key + description: Authentication via API key. + - name: connectionString + value: connection_string + description: Authentication via connection string. + - name: systemAssignedManagedIdentity + value: system_assigned_managed_identity + description: Authentication via system-assigned managed identity. + - name: userAssignedManagedIdentity + value: user_assigned_managed_identity + description: Authentication via user-assigned managed identity. + onYourDataApiKeyAuthenticationOptions: + required: + - key + description: The authentication options for Azure OpenAI On Your Data when using an API key. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + key: + type: string + description: The API key to use for authentication. + x-ms-discriminator-value: api_key + onYourDataConnectionStringAuthenticationOptions: + required: + - connection_string + description: The authentication options for Azure OpenAI On Your Data when using a connection string. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + connection_string: + type: string + description: The connection string to use for authentication. + x-ms-discriminator-value: connection_string + onYourDataSystemAssignedManagedIdentityAuthenticationOptions: + description: The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + x-ms-discriminator-value: system_assigned_managed_identity + onYourDataUserAssignedManagedIdentityAuthenticationOptions: + required: + - managed_identity_resource_id + description: The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + managed_identity_resource_id: + type: string + description: The resource ID of the user-assigned managed identity to use for authentication. + x-ms-discriminator-value: user_assigned_managed_identity + onYourDataVectorizationSource: + required: + - type + type: object + properties: + type: + $ref: "#/components/schemas/onYourDataVectorizationSourceType" + description: An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search. + discriminator: + propertyName: type + mapping: + endpoint: "#/components/schemas/onYourDataEndpointVectorizationSource" + deployment_name: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + onYourDataVectorizationSourceType: + type: string + description: |- + Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with + vector search. + enum: + - endpoint + - deployment_name + x-ms-enum: + name: OnYourDataVectorizationSourceType + modelAsString: true + values: + - name: endpoint + value: endpoint + description: Represents vectorization performed by public service calls to an Azure OpenAI embedding model. + - name: deploymentName + value: deployment_name + description: |- + Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but + On Your Data will use this model deployment via an internal call rather than a public one, which enables vector + search even in private networks. + onYourDataDeploymentNameVectorizationSource: + required: + - deployment_name + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on an internal embeddings model deployment name in the same Azure OpenAI resource. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + - properties: + deployment_name: + type: string + description: Specifies the name of the model deployment to use for vectorization. This model deployment must be in the same Azure OpenAI resource, but On Your Data will use this model deployment via an internal call rather than a public one, which enables vector search even in private networks. + x-ms-discriminator-value: deployment_name + onYourDataEndpointVectorizationSource: + required: + - authentication + - endpoint + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on a public Azure OpenAI endpoint call for embeddings. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + - properties: + authentication: + $ref: '#/components/schemas/onYourDataApiKeyAuthenticationOptions' + endpoint: + type: string + description: Specifies the endpoint to use for vectorization. This endpoint must be in the same Azure OpenAI resource, but On Your Data will use this endpoint via an internal call rather than a public one, which enables vector search even in private networks. + format: uri + x-ms-discriminator-value: endpoint + azureChatExtensionsMessageContext: + type: object + properties: + citations: + type: array + description: The data source retrieval result, used to generate the assistant message in the response. + items: + $ref: "#/components/schemas/citation" + x-ms-identifiers: [] + intent: + type: string + description: The detected intent from the chat history, used to pass to the next turn to carry over the context. + description: |2- + A representation of the additional context information available when Azure OpenAI chat extensions are involved + in the generation of a corresponding chat completions response. This context information is only populated when + using an Azure OpenAI request configured to use a matching extension. + citation: + required: + - content + type: object + properties: + content: + type: string + description: The content of the citation. + title: + type: string + description: The title of the citation. + url: + type: string + description: The URL of the citation. + filepath: + type: string + description: The file path of the citation. + chunk_id: + type: string + description: The chunk ID of the citation. + description: citation information for a chat completions response message. + chatCompletionMessageToolCall: + type: object + properties: + id: + type: string + description: The ID of the tool call. + type: + $ref: "#/components/schemas/toolCallType" + function: + type: object + description: The function that the model called. + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - name + - arguments + required: + - id + - type + - function + toolCallType: + type: string + enum: + - function + description: The type of the tool call, in this case `function`. + x-ms-enum: + name: ToolCallType + modelAsString: true + values: + - value: function + description: The tool call type is function. + chatCompletionRequestMessageTool: + allOf: + - $ref: "#/components/schemas/chatCompletionRequestMessage" + - type: object + nullable: true + properties: + tool_call_id: + type: string + description: Tool call that this message is responding to. + content: + type: string + description: The contents of the message. + nullable: true + required: + - tool_call_id + - content + chatCompletionRequestMessageFunction: + allOf: + - $ref: "#/components/schemas/chatCompletionRequestMessage" + - type: object + description: Deprecated. Message that represents a function. + nullable: true + properties: + role: + type: string + enum: + - function + description: The role of the messages author, in this case `function`. + name: + type: string + description: The contents of the message. + content: + type: string + description: The contents of the message. + nullable: true + required: + - function_call_id + - content + createChatCompletionResponse: + type: object + description: Represents a chat completion response returned by model, based on the provided input. + properties: + id: + type: string + description: A unique identifier for the chat completion. + prompt_filter_results: + $ref: "#/components/schemas/promptFilterResults" + choices: + type: array + description: A list of chat completion choices. Can be more than one if `n` is greater than 1. + items: + type: object + required: + - finish_reason + - index + - message + - logprobs + properties: + finish_reason: + type: string + description: &chat_completion_finish_reason_description | + The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, + `length` if the maximum number of tokens specified in the request was reached, + `content_filter` if content was omitted due to a flag from our content filters, + `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. + enum: + [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call", + ] + index: + type: integer + description: The index of the choice in the list of choices. + message: + $ref: "#/components/schemas/chatCompletionResponseMessage" + content_filter_results: + $ref: "#/components/schemas/contentFilterChoiceResults" + logprobs: &chat_completion_response_logprobs + description: Log probability information for the choice. + type: object + nullable: true + properties: + content: + description: A list of message content tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + refusal: + description: A list of message refusal tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + required: + - content + - refusal + created: + type: integer + description: The Unix timestamp (in seconds) of when the chat completion was created. + model: + type: string + description: The model used for the chat completion. + system_fingerprint: + type: string + description: | + This fingerprint represents the backend configuration that the model runs with. + + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + object: + type: string + description: The object type, which is always `chat.completion`. + enum: [chat.completion] + usage: + $ref: "#/components/schemas/completionUsage" + required: + - choices + - created + - id + - model + - object + + createChatCompletionStreamResponse: + type: object + description: Represents a streamed chunk of a chat completion response returned by model, based on the provided input. + properties: + id: + type: string + description: A unique identifier for the chat completion. Each chunk has the same ID. + choices: + type: array + description: | + A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. + items: + type: object + required: + - delta + - finish_reason + - index + properties: + delta: + $ref: "#/components/schemas/chatCompletionStreamResponseDelta" + logprobs: *chat_completion_response_logprobs + finish_reason: + type: string + description: *chat_completion_finish_reason_description + enum: + [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call", + ] + nullable: true + index: + type: integer + description: The index of the choice in the list of choices. + created: + type: integer + description: The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp. + model: + type: string + description: The model to generate the completion. + system_fingerprint: + type: string + description: | + This fingerprint represents the backend configuration that the model runs with. + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + object: + type: string + description: The object type, which is always `chat.completion.chunk`. + enum: [chat.completion.chunk] + required: + - prompt_tokens + - completion_tokens + - total_tokens + required: + - choices + - created + - id + - model + - object + + chatCompletionStreamResponseDelta: + type: object + description: A chat completion delta generated by streamed model responses. + properties: + content: + type: string + description: The contents of the chunk message. + nullable: true + function_call: + deprecated: true + type: object + description: "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model." + properties: + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + name: + type: string + description: The name of the function to call. + tool_calls: + type: array + items: + $ref: "#/components/schemas/chatCompletionMessageToolCallChunk" + role: + type: string + enum: ["system", "user", "assistant", "tool"] + description: The role of the author of this message. + refusal: + type: string + description: The refusal message generated by the model. + nullable: true + + chatCompletionMessageToolCallChunk: + type: object + properties: + index: + type: integer + id: + type: string + description: The ID of the tool call. + type: + type: string + enum: ["function"] + description: The type of the tool. Currently, only `function` is supported. + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - index + + chatCompletionStreamOptions: + description: | + Options for streaming response. Only set this when you set `stream: true`. + type: object + nullable: true + default: null + properties: + include_usage: + type: boolean + description: | + If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value. + + chatCompletionChoiceLogProbs: + description: Log probability information for the choice. + type: object + nullable: true + properties: + content: + description: A list of message content tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + refusal: + description: A list of message refusal tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + required: + - content + chatCompletionTokenLogprob: + type: object + properties: + token: + description: The token. + type: string + logprob: + description: The log probability of this token. + type: number + bytes: + description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. + type: array + items: + type: integer + nullable: true + top_logprobs: + description: List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. + type: array + items: + type: object + properties: + token: + description: The token. + type: string + logprob: + description: The log probability of this token. + type: number + bytes: + description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. + type: array + items: + type: integer + nullable: true + required: + - token + - logprob + - bytes + required: + - token + - logprob + - bytes + - top_logprobs + + chatCompletionResponseMessage: + type: object + description: A chat completion message generated by the model. + properties: + role: + $ref: "#/components/schemas/chatCompletionResponseMessageRole" + refusal: + type: string + description: The refusal message generated by the model. + nullable: true + content: + type: string + description: The contents of the message. + nullable: true + tool_calls: + type: array + description: The tool calls generated by the model, such as function calls. + items: + $ref: "#/components/schemas/chatCompletionMessageToolCall" + function_call: + $ref: "#/components/schemas/chatCompletionFunctionCall" + context: + $ref: "#/components/schemas/azureChatExtensionsMessageContext" + required: + - role + - content + - refusal + chatCompletionResponseMessageRole: + type: string + enum: + - assistant + description: The role of the author of the response message. + chatCompletionToolChoiceOption: + description: | + Controls which (if any) tool is called by the model. + `none` means the model will not call any tool and instead generates a message. + `auto` means the model can pick between generating a message or calling one or more tools. + `required` means the model must call one or more tools. + Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. + `none` is the default when no tools are present. `auto` is the default if tools are present. + oneOf: + - type: string + description: > + `none` means the model will not call any tool and instead generates a message. + `auto` means the model can pick between generating a message or calling one or more tools. + `required` means the model must call one or more tools. + enum: + - none + - auto + - required + - $ref: "#/components/schemas/chatCompletionNamedToolChoice" + chatCompletionNamedToolChoice: + type: object + description: Specifies a tool the model should use. Use to force the model to call a specific function. + properties: + type: + type: string + enum: + - "function" + description: The type of the tool. Currently, only `function` is supported. + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + required: + - name + required: + - type + - function + + ParallelToolCalls: + description: Whether to enable parallel function calling during tool use. + type: boolean + default: true + + chatCompletionMessageToolCalls: + type: array + description: The tool calls generated by the model, such as function calls. + items: + $ref: "#/components/schemas/chatCompletionMessageToolCall" + + chatCompletionFunctionCall: + type: object + description: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - name + - arguments + completionUsage: + type: object + description: Usage statistics for the completion request. + properties: + prompt_tokens: + type: integer + description: Number of tokens in the prompt. + completion_tokens: + type: integer + description: Number of tokens in the generated completion. + total_tokens: + type: integer + description: Total number of tokens used in the request (prompt + completion). + completion_tokens_details: + type: object + description: Breakdown of tokens used in a completion. + properties: + reasoning_tokens: + type: integer + description: Tokens generated by the model for reasoning. + required: + - prompt_tokens + - completion_tokens + - total_tokens + chatCompletionTool: + type: object + properties: + type: + type: string + enum: ["function"] + description: The type of the tool. Currently, only `function` is supported. + function: + $ref: "#/components/schemas/FunctionObject" + required: + - type + - function + + FunctionParameters: + type: object + description: "The parameters the functions accepts, described as a JSON Schema object. See the guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list." + additionalProperties: true + + FunctionObject: + type: object + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: "#/components/schemas/FunctionParameters" + strict: + type: boolean + nullable: true + default: false + description: Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling). + required: + - name + + ResponseFormatText: + type: object + properties: + type: + type: string + description: "The type of response format being defined: `text`" + enum: ["text"] + required: + - type + + ResponseFormatJsonObject: + type: object + properties: + type: + type: string + description: "The type of response format being defined: `json_object`" + enum: ["json_object"] + required: + - type + + ResponseFormatJsonSchemaSchema: + type: object + description: "The schema for the response format, described as a JSON Schema object." + additionalProperties: true + + ResponseFormatJsonSchema: + type: object + properties: + type: + type: string + description: "The type of response format being defined: `json_schema`" + enum: ["json_schema"] + json_schema: + type: object + properties: + description: + type: string + description: A description of what the response format is for, used by the model to determine how to respond in the format. + name: + type: string + description: The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + schema: + $ref: "#/components/schemas/ResponseFormatJsonSchemaSchema" + strict: + type: boolean + nullable: true + default: false + description: Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. + required: + - type + - name + required: + - type + - json_schema + + chatCompletionChoiceCommon: + type: object + properties: + index: + type: integer + finish_reason: + type: string + createTranslationRequest: + type: object + description: Translation request. + properties: + file: + type: string + description: The audio file to translate. + format: binary + prompt: + type: string + description: An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English. + response_format: + $ref: "#/components/schemas/audioResponseFormat" + temperature: + type: number + default: 0 + description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + required: + - file + audioResponse: + description: Translation or transcription response when response_format was json + type: object + properties: + text: + type: string + description: Translated or transcribed text. + required: + - text + audioVerboseResponse: + description: Translation or transcription response when response_format was verbose_json + type: object + allOf: + - $ref: "#/components/schemas/audioResponse" + - properties: + task: + type: string + description: Type of audio task. + enum: + - transcribe + - translate + x-ms-enum: + modelAsString: true + language: + type: string + description: Language. + duration: + type: number + description: Duration. + segments: + type: array + items: + $ref: "#/components/schemas/audioSegment" + required: + - text + audioResponseFormat: + title: AudioResponseFormat + description: Defines the format of the output. + enum: + - json + - text + - srt + - verbose_json + - vtt + type: string + x-ms-enum: + modelAsString: true + createTranscriptionRequest: + type: object + description: Transcription request. + properties: + file: + type: string + description: The audio file object to transcribe. + format: binary + prompt: + type: string + description: An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. + response_format: + $ref: "#/components/schemas/audioResponseFormat" + temperature: + type: number + default: 0 + description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + language: + type: string + description: The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency. + required: + - file + audioSegment: + type: object + description: Transcription or translation segment. + properties: + id: + type: integer + description: Segment identifier. + seek: + type: number + description: Offset of the segment. + start: + type: number + description: Segment start offset. + end: + type: number + description: Segment end offset. + text: + type: string + description: Segment text. + tokens: + type: array + items: + type: number + nullable: false + description: Tokens of the text. + temperature: + type: number + description: Temperature. + avg_logprob: + type: number + description: Average log probability. + compression_ratio: + type: number + description: Compression ratio. + no_speech_prob: + type: number + description: Probability of 'no speech'. + imageQuality: + description: The quality of the image that will be generated. + type: string + enum: + - standard + - hd + default: standard + x-ms-enum: + name: Quality + modelAsString: true + values: + - value: standard + description: Standard quality creates images with standard quality. + name: Standard + - value: hd + description: HD quality creates images with finer details and greater consistency across the image. + name: HD + imagesResponseFormat: + description: The format in which the generated images are returned. + type: string + enum: + - url + - b64_json + default: url + x-ms-enum: + name: ImagesResponseFormat + modelAsString: true + values: + - value: url + description: The URL that provides temporary access to download the generated images. + name: Url + - value: b64_json + description: The generated images are returned as base64 encoded string. + name: Base64Json + imageSize: + description: The size of the generated images. + type: string + enum: + - 1792x1024 + - 1024x1792 + - 1024x1024 + default: 1024x1024 + x-ms-enum: + name: Size + modelAsString: true + values: + - value: 1792x1024 + description: The desired size of the generated image is 1792x1024 pixels. + name: Size1792x1024 + - value: 1024x1792 + description: The desired size of the generated image is 1024x1792 pixels. + name: Size1024x1792 + - value: 1024x1024 + description: The desired size of the generated image is 1024x1024 pixels. + name: Size1024x1024 + imageStyle: + description: The style of the generated images. + type: string + enum: + - vivid + - natural + default: vivid + x-ms-enum: + name: Style + modelAsString: true + values: + - value: vivid + description: Vivid creates images that are hyper-realistic and dramatic. + name: Vivid + - value: natural + description: Natural creates images that are more natural and less hyper-realistic. + name: Natural + imageGenerationsRequest: + type: object + properties: + prompt: + description: A text description of the desired image(s). The maximum length is 4000 characters. + type: string + format: string + example: a corgi in a field + minLength: 1 + "n": + description: The number of images to generate. + type: integer + minimum: 1 + maximum: 1 + default: 1 + size: + $ref: "#/components/schemas/imageSize" + response_format: + $ref: "#/components/schemas/imagesResponseFormat" + user: + description: A unique identifier representing your end-user, which can help to monitor and detect abuse. + type: string + format: string + example: user123456 + quality: + $ref: "#/components/schemas/imageQuality" + style: + $ref: "#/components/schemas/imageStyle" + required: + - prompt + generateImagesResponse: + type: object + properties: + created: + type: integer + format: unixtime + description: The unix timestamp when the operation was created. + example: "1676540381" + data: + type: array + description: The result data of the operation, if successful + items: + $ref: "#/components/schemas/imageResult" + required: + - created + - data + imageResult: + type: object + description: The image url or encoded image if successful, and an error otherwise. + properties: + url: + type: string + description: The image url. + example: https://www.contoso.com + b64_json: + type: string + description: The base64 encoded image + content_filter_results: + $ref: "#/components/schemas/dalleContentFilterResults" + revised_prompt: + type: string + description: The prompt that was used to generate the image, if there was any revision to the prompt. + prompt_filter_results: + $ref: "#/components/schemas/dalleFilterResults" + securitySchemes: + bearer: + type: oauth2 + flows: + implicit: + authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize + scopes: {} + x-tokenInfoFunc: api.middleware.auth.bearer_auth + x-scopeValidateFunc: api.middleware.auth.validate_scopes + apiKey: + type: apiKey + name: api-key + in: header diff --git a/specification/connectedcache/ConnectedCache.Management/cacheNodespreviewResource.tsp b/specification/connectedcache/ConnectedCache.Management/cacheNodespreviewResource.tsp new file mode 100644 index 000000000000..0b28f8c2971e --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/cacheNodespreviewResource.tsp @@ -0,0 +1,40 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "./models.tsp"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; + +namespace Microsoft.ConnectedCache; + +model CacheNodePreviewResource is TrackedResource { + @doc("Name of the Customer resource") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9\\_\\-]*") + @key("customerResourceName") + @segment("cacheNodes") + @path + name: string; +} + +@armResourceOperations +interface CacheNodesOperations { + @doc("Retrieves the properties of a cacheNodes") + get is ArmResourceRead; + @doc("Creates a cacheNodes with the specified create parameters") + createorUpdate is ArmResourceCreateOrReplaceAsync; + @doc("Deletes an existing cache Node") + delete is ArmResourceDeleteSync; + @doc("updates an existing Cache Node") + update is ArmCustomPatchSync< + CacheNodePreviewResource, + ConnectedCachePatchResource + >; + @doc("Retrieves the properties of all ConnectedCache") + listByResourceGroup is ArmResourceListByParent; + @doc("Retrieves the properties of all ConnectedCaches") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/connectedcache/ConnectedCache.Management/enterpriseCustomerspreviewResource.tsp b/specification/connectedcache/ConnectedCache.Management/enterpriseCustomerspreviewResource.tsp new file mode 100644 index 000000000000..0e96309cc356 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/enterpriseCustomerspreviewResource.tsp @@ -0,0 +1,41 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; + +namespace Microsoft.ConnectedCache; + +@doc("ConnectedCache Resource. Represents the high level Nodes needed to provision CacheNode and customer resources used in private preview") +model EnterprisePreviewResource is TrackedResource { + @doc("Name of the Customer resource") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9\\_\\-]*") + @key("customerResourceName") + @segment("enterpriseCustomers") + @path + name: string; +} + +@armResourceOperations +interface EnterpriseCustomerOperations { + @doc("Retrieves the properties of a Enterprise customer") + get is ArmResourceRead; + @doc("Creates a cacheNodes with the specified create parameters") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + @doc("updates an existing enterpriseCustomers") + update is ArmCustomPatchSync< + EnterprisePreviewResource, + ConnectedCachePatchResource + >; + @doc("Deletes an existing customer Enterprise resource") + delete is ArmResourceDeleteSync; + @doc("Retrieves the properties of all ConnectedCache enterpriseCustomers") + listByResourceGroup is ArmResourceListByParent; + @doc("Retrieves the properties of all ConnectedCaches") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/connectedcache/ConnectedCache.Management/enterpriseMccCacheNodes.tsp b/specification/connectedcache/ConnectedCache.Management/enterpriseMccCacheNodes.tsp new file mode 100644 index 000000000000..b16ea1d63000 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/enterpriseMccCacheNodes.tsp @@ -0,0 +1,53 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./enterpriseMccCustomers.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; + +namespace Microsoft.ConnectedCache; + +@doc("Represents the high level Nodes needed to provision cache node resources") +@parentResource(EnterpriseMccCustomerResource) +model EnterpriseMccCacheNodeResource is TrackedResource { + @doc("Name of the ConnectedCache resource") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9\\_\\-]*") + @key("cacheNodeResourceName") + @segment("enterpriseMccCacheNodes") + @path + name: string; +} + +@armResourceOperations +interface EnterpriseMccCacheNodesOperations { + @doc("This api gets ispCacheNode resource information") + get is ArmResourceRead; + @doc("This api creates an ispCacheNode with the specified create parameters") + createOrUpdate is ArmResourceCreateOrUpdateAsync; + @doc("This api updates an existing ispCacheNode resource") + update is ArmCustomPatchSync< + EnterpriseMccCacheNodeResource, + ConnectedCachePatchResource + >; + @doc("This api deletes an existing ispCacheNode resource") + delete is ArmResourceDeleteWithoutOkAsync; + @doc("This api retrieves information about all ispCacheNode resources under the given subscription and resource group") + listByEnterpriseMccCustomerResource is ArmResourceListByParent; + @doc("This api gets secrets of the ispCacheNode resource install details") + getCacheNodeInstallDetails is ArmResourceActionSync< + EnterpriseMccCacheNodeResource, + void, + MccCacheNodeInstallDetails + >; +} + +@@visibility(Azure.ResourceManager.TrackedResource.properties, + "create", + "update", + "read" +); diff --git a/specification/connectedcache/ConnectedCache.Management/enterpriseMccCustomers.tsp b/specification/connectedcache/ConnectedCache.Management/enterpriseMccCustomers.tsp new file mode 100644 index 000000000000..9a33ee2a2961 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/enterpriseMccCustomers.tsp @@ -0,0 +1,41 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; + +namespace Microsoft.ConnectedCache; + +@doc("Represents the high level Nodes needed to provision customer resources") +model EnterpriseMccCustomerResource is TrackedResource { + @doc("Name of the Customer resource") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9\\_\\-]*") + @key("customerResourceName") + @segment("enterpriseMccCustomers") + @path + name: string; +} + +@armResourceOperations +interface EnterpriseMccCustomers { + @doc("Gets the enterprise mcc customer resource information using this get call") + get is ArmResourceRead; + @doc("This api creates an enterprise mcc customer with the specified create parameters") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + @doc("This api updates an existing enterprise mcc customer resource") + update is ArmCustomPatchSync< + EnterpriseMccCustomerResource, + ConnectedCachePatchResource + >; + @doc("This api deletes an existing enterprise mcc customer resource") + delete is ArmResourceDeleteWithoutOkAsync; + @doc("This api gets the information about all enterprise mcc customer resources under the given subscription and resource group") + listByResourceGroup is ArmResourceListByParent; + @doc("This api gets information about all enterpriseMccCustomer resources under the given subscription") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_CreateorUpdate_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_CreateorUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..20f7d4479167 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_CreateorUpdate_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "CacheNodesOperations_CreateorUpdate", + "operationId": "CacheNodesOperations_CreateorUpdate", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "lwrsyhvfpcfrwrim", + "resource": { + "location": "westus", + "properties": { + "statusCode": "movtzupooyhdqk", + "statusText": "bjnsrpzaofjntleoesjwammgbi", + "statusDetails": "quuziibkwtgf", + "error": {} + }, + "tags": { + "key8256": "oreqiywrjkmate" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "movtzupooyhdqk", + "statusText": "bjnsrpzaofjntleoesjwammgbi", + "statusDetails": "quuziibkwtgf", + "status": "vxwmuwtqimapfw", + "error": { + "code": "dzxbdigdjbdbdclvxkxmfutgcbjf", + "message": "ifabxmzinicoximnsjkmhdpdgkw", + "details": [] + } + }, + "tags": { + "key8256": "oreqiywrjkmate" + }, + "systemData": { + "createdBy": "yqwxlhphavoggkcwg", + "createdByType": "User", + "createdAt": "2024-01-31T00:19:33.838Z", + "lastModifiedBy": "knekx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-31T00:19:33.838Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "movtzupooyhdqk", + "statusText": "bjnsrpzaofjntleoesjwammgbi", + "statusDetails": "quuziibkwtgf", + "status": "vxwmuwtqimapfw", + "error": { + "code": "dzxbdigdjbdbdclvxkxmfutgcbjf", + "message": "ifabxmzinicoximnsjkmhdpdgkw", + "details": [] + } + }, + "tags": { + "key8256": "oreqiywrjkmate" + }, + "systemData": { + "createdBy": "yqwxlhphavoggkcwg", + "createdByType": "User", + "createdAt": "2024-01-31T00:19:33.838Z", + "lastModifiedBy": "knekx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-31T00:19:33.838Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_Delete_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..38ee5bb25e0d --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "CacheNodesOperations_Delete", + "operationId": "CacheNodesOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "otvtvhmovthjwzjzbsqkbnmpcmmeianpqxmmaspvdczmrenquxigrtuarmlcmvsnaclhcbw" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_Get_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..38f8f3fa5f1f --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "CacheNodesOperations_Get", + "operationId": "CacheNodesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "nqoxkgorhuzbhjwcegymzqbeydzjupemekt" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "movtzupooyhdqk", + "statusText": "bjnsrpzaofjntleoesjwammgbi", + "statusDetails": "quuziibkwtgf", + "status": "vxwmuwtqimapfw", + "error": { + "code": "dzxbdigdjbdbdclvxkxmfutgcbjf", + "message": "ifabxmzinicoximnsjkmhdpdgkw", + "details": [] + } + }, + "tags": { + "key8256": "oreqiywrjkmate" + }, + "systemData": { + "createdBy": "yqwxlhphavoggkcwg", + "createdByType": "User", + "createdAt": "2024-01-31T00:19:33.838Z", + "lastModifiedBy": "knekx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-31T00:19:33.838Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_ListByResourceGroup_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..0c810c9aead4 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "CacheNodes Private Preview(Legacy) Get Operation List by Resource group - generated by [MaximumSet] rule", + "operationId": "CacheNodesOperations_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4711": "zfrkvxymuupxgxrkkmbm" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest1", + "name": "MCCTPTest1", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "gtqfmwgkfp", + "statusText": "ztbgggsdeihkputd", + "statusDetails": "odhpdelbuqrfkiaolqrrzpdaokctz", + "status": "mobullauhrxnpyocr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key8585": "jgoeqypqcf" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_ListBySubscription_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..38869c7627a8 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "title": "CacheNodes Private Preview(Legacy) resource List by Subscription - generated by [MaximumSet] rule", + "operationId": "CacheNodesOperations_ListBySubscription", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4711": "zfrkvxymuupxgxrkkmbm" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest1", + "name": "MCCTPTest1", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "gtqfmwgkfp", + "statusText": "ztbgggsdeihkputd", + "statusDetails": "odhpdelbuqrfkiaolqrrzpdaokctz", + "status": "mobullauhrxnpyocr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key8585": "jgoeqypqcf" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_Update_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..2eeb25d5728f --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/CacheNodesOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "CacheNodes Private Preview(Legacy) Update Operation - generated by [MaximumSet] rule", + "operationId": "CacheNodesOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "wlrwpdbcv", + "properties": { + "tags": { + "key5032": "esiuyjbpcwkpqriqiqztxuocv" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "movtzupooyhdqk", + "statusText": "bjnsrpzaofjntleoesjwammgbi", + "statusDetails": "quuziibkwtgf", + "status": "vxwmuwtqimapfw", + "error": { + "code": "dzxbdigdjbdbdclvxkxmfutgcbjf", + "message": "ifabxmzinicoximnsjkmhdpdgkw", + "details": [] + } + }, + "tags": { + "key8256": "oreqiywrjkmate" + }, + "systemData": { + "createdBy": "yqwxlhphavoggkcwg", + "createdByType": "User", + "createdAt": "2024-01-31T00:19:33.838Z", + "lastModifiedBy": "knekx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-31T00:19:33.838Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_CreateOrUpdate_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..2863d0970d96 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "EnterpriseCustomerOperations_CreateOrUpdate", + "operationId": "EnterpriseCustomerOperations_CreateOrUpdate", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "l", + "resource": { + "properties": { + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "error": {} + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "zdzhhkjyogrqxwihkifnmeyhwpujbr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/enterpriseCustomers", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/enterpriseCustomers", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_Delete_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..b976232493c5 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "EnterpriseCustomerOperations_Delete", + "operationId": "EnterpriseCustomerOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "jeubxmhiaihcusgnahblvvckbdcetacvqgwbohlrqucodtlwuyefpejskvamgrdnwgucziodcfpjhqy" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_Get_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..80f8f49bc403 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "EnterpriseCustomerOperations_Get", + "operationId": "EnterpriseCustomerOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MCCTPTest2" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/enterpriseCustomers", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_ListByResourceGroup_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..609a175091bc --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "EnterpriseCustomerOperations_ListByResourceGroup", + "operationId": "EnterpriseCustomerOperations_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/enterpriseCustomers", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_ListBySubscription_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..7ab27fb6502f --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "EnterpriseCustomerOperations_ListBySubscription", + "operationId": "EnterpriseCustomerOperations_ListBySubscription", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/enterpriseCustomers", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_Update_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..dfe8a55b1e8f --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseCustomerOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "EnterpriseCustomerOperations_Update", + "operationId": "EnterpriseCustomerOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MCCTPTest2", + "properties": { + "tags": { + "key1653": "nzjczrhclhkndesgy" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/enterpriseCustomers", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..128155bd48e9 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,296 @@ +{ + "title": "Creates an enterpriseMccCacheNode resource - generated by [MaximumSet] rule", + "operationId": "EnterpriseMccCacheNodesOperations_CreateOrUpdate", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "nhdkvstdrrtsxxuz", + "cacheNodeResourceName": "fgduqdovidpemlnmhelomffuafdrbgaasqznvrdkbvspfzsnrhncdtqquhijhdpwyzwleukqldpceyxqhqlftqrr", + "resource": { + "location": "westus", + "properties": { + "cacheNode": { + "fullyQualifiedResourceId": "yeinlleavzbehelhsucb", + "customerName": "zsklcocjfjhkcpmzyefzkwamdzc", + "ipAddress": "gbfkdhloyphnpnhemwrcrxlk", + "customerIndex": "vafvezmelfgmjsrccjukrhppljvipg", + "cacheNodeId": "fmrjefyddfn", + "cacheNodeName": "qppvqxliajjfoalzjbgmxggr", + "customerAsn": 25, + "isEnabled": true, + "maxAllowableEgressInMbps": 27, + "isEnterpriseManaged": true, + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "shouldMigrate": true, + "cidrSelectionType": 11 + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "lgljxmyyoakw", + "additionalCacheNodeProperties": { + "cacheNodePropertiesDetailsIssuesList": [ + "ennbzfpuszgalzpawmwicaofqcwcj" + ], + "driveConfiguration": [ + { + "physicalPath": "pcbkezoofhamkycot", + "sizeInGb": 14, + "cacheNumber": 11, + "nginxMapping": "cirlpkpuxg" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "fjbggfvumrn" + }, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "ihkzxlzvpcywtzrogupqozkdud", + "optionalProperty1": "ph", + "optionalProperty2": "soqqgpgcbhb", + "optionalProperty3": "fpnycrbagptsujiotnjfuhlm", + "optionalProperty4": "gesqugrxvhxlxxyvatgrautxwlmxsf", + "optionalProperty5": "zknjgzpaqtvdqjydd" + }, + "error": {} + }, + "tags": { + "key259": "qbkixjuyjkoj" + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DOTest/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "yeinlleavzbehelhsucb", + "customerId": "xjjgcknmsakfawcmwbdufdxktysp", + "customerName": "zsklcocjfjhkcpmzyefzkwamdzc", + "ipAddress": "gbfkdhloyphnpnhemwrcrxlk", + "customerIndex": "vafvezmelfgmjsrccjukrhppljvipg", + "cacheNodeId": "fmrjefyddfn", + "cacheNodeName": "qppvqxliajjfoalzjbgmxggr", + "customerAsn": 25, + "isEnabled": true, + "maxAllowableEgressInMbps": 27, + "maxAllowableProbability": 12, + "xCid": "ooyrhuockukmsrqsevwaaqglhf", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "tvmivvnpisuboggoqgbobugld", + "clientTenantId": "iwrpakllacxvtqygpaimlpxvqrjz", + "category": "utfjefejkrpxcmrgygzawa", + "releaseVersion": 29, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 4, + "containerConfigurations": "dyvefvbvrtsmdrdmiuphzh", + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.774Z", + "bgpReviewStateText": "khtriksrqrjieouoz", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "bc", + "bgpNumberOfTimesUpdated": 23, + "bgpNumberOfRecords": 25, + "bgpCidrBlocksCount": 28, + "bgpAddressSpace": 30, + "shouldMigrate": true, + "bgpFileBytesTruncated": 26, + "cidrSelectionType": 11, + "isFrozen": true, + "reviewState": 2, + "reviewStateText": "xubwhyrdtramrmoldbxqwauyusymqu", + "reviewFeedback": "zowuztcnybt", + "configurationState": "Configured", + "configurationStateText": "okbofqwtzcsju", + "addressSpace": 1, + "workerConnections": 19, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.774Z", + "containerResyncTrigger": 23, + "imageUri": "wkowdrixfxvjmdcsy" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "lgljxmyyoakw", + "additionalCacheNodeProperties": { + "cacheNodePropertiesDetailsIssuesList": [ + "ennbzfpuszgalzpawmwicaofqcwcj" + ], + "aggregatedStatusDetails": "nztcstlyjhmllbnrrluhzusmoa", + "aggregatedStatusText": "ofiedyvzpbijnfghnrrigqaws", + "aggregatedStatusCode": 25, + "productVersion": "hfbuukpxoerpkziym", + "isProvisioned": true, + "cacheNodeStateDetailedText": "onckp", + "cacheNodeStateShortText": "yxkwlubqlzhkmemzjzlxksho", + "cacheNodeState": 30, + "driveConfiguration": [ + { + "physicalPath": "pcbkezoofhamkycot", + "sizeInGb": 14, + "cacheNumber": 11, + "nginxMapping": "cirlpkpuxg" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "fjbggfvumrn" + }, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "ihkzxlzvpcywtzrogupqozkdud", + "optionalProperty1": "ph", + "optionalProperty2": "soqqgpgcbhb", + "optionalProperty3": "fpnycrbagptsujiotnjfuhlm", + "optionalProperty4": "gesqugrxvhxlxxyvatgrautxwlmxsf", + "optionalProperty5": "zknjgzpaqtvdqjydd" + }, + "status": "utgrdjsw", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key259": "qbkixjuyjkoj" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DOTest/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "yeinlleavzbehelhsucb", + "customerId": "xjjgcknmsakfawcmwbdufdxktysp", + "customerName": "zsklcocjfjhkcpmzyefzkwamdzc", + "ipAddress": "gbfkdhloyphnpnhemwrcrxlk", + "customerIndex": "vafvezmelfgmjsrccjukrhppljvipg", + "cacheNodeId": "fmrjefyddfn", + "cacheNodeName": "qppvqxliajjfoalzjbgmxggr", + "customerAsn": 25, + "isEnabled": true, + "maxAllowableEgressInMbps": 27, + "maxAllowableProbability": 12, + "xCid": "ooyrhuockukmsrqsevwaaqglhf", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "tvmivvnpisuboggoqgbobugld", + "clientTenantId": "iwrpakllacxvtqygpaimlpxvqrjz", + "category": "utfjefejkrpxcmrgygzawa", + "releaseVersion": 29, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 4, + "containerConfigurations": "dyvefvbvrtsmdrdmiuphzh", + "cidrCsv": [ + "kaynxstxqsoreorwh" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.774Z", + "bgpReviewStateText": "khtriksrqrjieouoz", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "bc", + "bgpNumberOfTimesUpdated": 23, + "bgpNumberOfRecords": 25, + "bgpCidrBlocksCount": 28, + "bgpAddressSpace": 30, + "shouldMigrate": true, + "bgpFileBytesTruncated": 26, + "cidrSelectionType": 11, + "isFrozen": true, + "reviewState": 2, + "reviewStateText": "xubwhyrdtramrmoldbxqwauyusymqu", + "reviewFeedback": "zowuztcnybt", + "configurationState": "Configured", + "configurationStateText": "okbofqwtzcsju", + "addressSpace": 1, + "workerConnections": 19, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.774Z", + "containerResyncTrigger": 23, + "imageUri": "wkowdrixfxvjmdcsy" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "lgljxmyyoakw", + "additionalCacheNodeProperties": { + "cacheNodePropertiesDetailsIssuesList": [ + "ennbzfpuszgalzpawmwicaofqcwcj" + ], + "aggregatedStatusDetails": "nztcstlyjhmllbnrrluhzusmoa", + "aggregatedStatusText": "ofiedyvzpbijnfghnrrigqaws", + "aggregatedStatusCode": 25, + "productVersion": "hfbuukpxoerpkziym", + "isProvisioned": true, + "cacheNodeStateDetailedText": "onckp", + "cacheNodeStateShortText": "yxkwlubqlzhkmemzjzlxksho", + "cacheNodeState": 30, + "driveConfiguration": [ + { + "physicalPath": "pcbkezoofhamkycot", + "sizeInGb": 14, + "cacheNumber": 11, + "nginxMapping": "cirlpkpuxg" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "fjbggfvumrn" + }, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "ihkzxlzvpcywtzrogupqozkdud", + "optionalProperty1": "ph", + "optionalProperty2": "soqqgpgcbhb", + "optionalProperty3": "fpnycrbagptsujiotnjfuhlm", + "optionalProperty4": "gesqugrxvhxlxxyvatgrautxwlmxsf", + "optionalProperty5": "zknjgzpaqtvdqjydd" + }, + "status": "utgrdjsw", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key259": "qbkixjuyjkoj" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_Delete_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..0b27cadd91c0 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "EnterpriseMccCacheNodesOperations Delete Operation - generated by [MaximumSet] rule", + "operationId": "EnterpriseMccCacheNodesOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "hsincngmssuzeyispnufqwinpopadvhsbsemisguxgovwdjwviqexocelijvuyr", + "cacheNodeResourceName": "vwtrhdoxvkrunpliwcao" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json new file mode 100644 index 000000000000..458c99d5a293 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "Gets required properties for enterprise Mcc CacheNode resource install key details - generated by [MaximumSet] rule", + "operationId": "EnterpriseMccCacheNodesOperations_GetCacheNodeInstallDetails", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "fzwxcjmdpxxzayecabqqlh", + "cacheNodeResourceName": "ccexmqqttritxvtctivraso" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "properties": { + "customerId": "eqklliuswn", + "cacheNodeId": "zirahqqohbaju", + "primaryAccountKey": "mzfvziehrsbxidhj", + "secondaryAccountKey": "dq", + "registrationKey": "tnwkmorctwsgajewcoutombm" + }, + "tags": { + "key5811": "betoafcoprgfcuscoew" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_Get_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9bf1015a6954 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,126 @@ +{ + "title": "Gets enterpriseMccCacheNode resource information of an enterprise mcc customer parent resource - generated by [MaximumSet] rule", + "operationId": "EnterpriseMccCacheNodesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "cygqjgtcetihsajgyqwwrbclssqsvhgltrboemcqqtpoxdbhykqxblaihmrumyhbsx", + "cacheNodeResourceName": "fqxfadsultwjfzdwlqkvneakfsbyhratytmssmiukpbnus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DOTest/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "yeinlleavzbehelhsucb", + "customerId": "xjjgcknmsakfawcmwbdufdxktysp", + "customerName": "zsklcocjfjhkcpmzyefzkwamdzc", + "ipAddress": "gbfkdhloyphnpnhemwrcrxlk", + "customerIndex": "vafvezmelfgmjsrccjukrhppljvipg", + "cacheNodeId": "fmrjefyddfn", + "cacheNodeName": "qppvqxliajjfoalzjbgmxggr", + "customerAsn": 25, + "isEnabled": true, + "maxAllowableEgressInMbps": 27, + "maxAllowableProbability": 12, + "xCid": "ooyrhuockukmsrqsevwaaqglhf", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "tvmivvnpisuboggoqgbobugld", + "clientTenantId": "iwrpakllacxvtqygpaimlpxvqrjz", + "category": "utfjefejkrpxcmrgygzawa", + "releaseVersion": 29, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 4, + "containerConfigurations": "dyvefvbvrtsmdrdmiuphzh", + "cidrCsv": [ + "kaynxstxqsoreorwh" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.774Z", + "bgpReviewStateText": "khtriksrqrjieouoz", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "bc", + "bgpNumberOfTimesUpdated": 23, + "bgpNumberOfRecords": 25, + "bgpCidrBlocksCount": 28, + "bgpAddressSpace": 30, + "shouldMigrate": true, + "bgpFileBytesTruncated": 26, + "cidrSelectionType": 11, + "isFrozen": true, + "reviewState": 2, + "reviewStateText": "xubwhyrdtramrmoldbxqwauyusymqu", + "reviewFeedback": "zowuztcnybt", + "configurationState": "Configured", + "configurationStateText": "okbofqwtzcsju", + "addressSpace": 1, + "workerConnections": 19, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.774Z", + "containerResyncTrigger": 23, + "imageUri": "wkowdrixfxvjmdcsy" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "lgljxmyyoakw", + "additionalCacheNodeProperties": { + "cacheNodePropertiesDetailsIssuesList": [ + "ennbzfpuszgalzpawmwicaofqcwcj" + ], + "aggregatedStatusDetails": "nztcstlyjhmllbnrrluhzusmoa", + "aggregatedStatusText": "ofiedyvzpbijnfghnrrigqaws", + "aggregatedStatusCode": 25, + "productVersion": "hfbuukpxoerpkziym", + "isProvisioned": true, + "cacheNodeStateDetailedText": "onckp", + "cacheNodeStateShortText": "yxkwlubqlzhkmemzjzlxksho", + "cacheNodeState": 30, + "driveConfiguration": [ + { + "physicalPath": "pcbkezoofhamkycot", + "sizeInGb": 14, + "cacheNumber": 11, + "nginxMapping": "cirlpkpuxg" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "fjbggfvumrn" + }, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "ihkzxlzvpcywtzrogupqozkdud", + "optionalProperty1": "ph", + "optionalProperty2": "soqqgpgcbhb", + "optionalProperty3": "fpnycrbagptsujiotnjfuhlm", + "optionalProperty4": "gesqugrxvhxlxxyvatgrautxwlmxsf", + "optionalProperty5": "zknjgzpaqtvdqjydd" + }, + "status": "utgrdjsw", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key259": "qbkixjuyjkoj" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..0dbcaec9dac1 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource_MaximumSet_Gen.json @@ -0,0 +1,130 @@ +{ + "title": "EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource", + "operationId": "EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "syjjjzk" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "yeinlleavzbehelhsucb", + "customerId": "xjjgcknmsakfawcmwbdufdxktysp", + "customerName": "zsklcocjfjhkcpmzyefzkwamdzc", + "ipAddress": "gbfkdhloyphnpnhemwrcrxlk", + "customerIndex": "vafvezmelfgmjsrccjukrhppljvipg", + "cacheNodeId": "fmrjefyddfn", + "cacheNodeName": "qppvqxliajjfoalzjbgmxggr", + "customerAsn": 25, + "isEnabled": true, + "maxAllowableEgressInMbps": 27, + "maxAllowableProbability": 12, + "xCid": "ooyrhuockukmsrqsevwaaqglhf", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "tvmivvnpisuboggoqgbobugld", + "clientTenantId": "iwrpakllacxvtqygpaimlpxvqrjz", + "category": "utfjefejkrpxcmrgygzawa", + "releaseVersion": 29, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 4, + "containerConfigurations": "dyvefvbvrtsmdrdmiuphzh", + "cidrCsv": [ + "kaynxstxqsoreorwh" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.774Z", + "bgpReviewStateText": "khtriksrqrjieouoz", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "bc", + "bgpNumberOfTimesUpdated": 23, + "bgpNumberOfRecords": 25, + "bgpCidrBlocksCount": 28, + "bgpAddressSpace": 30, + "shouldMigrate": true, + "bgpFileBytesTruncated": 26, + "cidrSelectionType": 11, + "isFrozen": true, + "reviewState": 2, + "reviewStateText": "xubwhyrdtramrmoldbxqwauyusymqu", + "reviewFeedback": "zowuztcnybt", + "configurationState": "Configured", + "configurationStateText": "okbofqwtzcsju", + "addressSpace": 1, + "workerConnections": 19, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.774Z", + "containerResyncTrigger": 23, + "imageUri": "wkowdrixfxvjmdcsy" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "lgljxmyyoakw", + "additionalCacheNodeProperties": { + "cacheNodePropertiesDetailsIssuesList": [ + "ennbzfpuszgalzpawmwicaofqcwcj" + ], + "aggregatedStatusDetails": "nztcstlyjhmllbnrrluhzusmoa", + "aggregatedStatusText": "ofiedyvzpbijnfghnrrigqaws", + "aggregatedStatusCode": 25, + "productVersion": "hfbuukpxoerpkziym", + "isProvisioned": true, + "cacheNodeStateDetailedText": "onckp", + "cacheNodeStateShortText": "yxkwlubqlzhkmemzjzlxksho", + "cacheNodeState": 30, + "driveConfiguration": [ + { + "physicalPath": "pcbkezoofhamkycot", + "sizeInGb": 14, + "cacheNumber": 11, + "nginxMapping": "cirlpkpuxg" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "fjbggfvumrn" + }, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "ihkzxlzvpcywtzrogupqozkdud", + "optionalProperty1": "ph", + "optionalProperty2": "soqqgpgcbhb", + "optionalProperty3": "fpnycrbagptsujiotnjfuhlm", + "optionalProperty4": "gesqugrxvhxlxxyvatgrautxwlmxsf", + "optionalProperty5": "zknjgzpaqtvdqjydd" + }, + "status": "utgrdjsw", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key259": "qbkixjuyjkoj" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_Update_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..005f964caec3 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCacheNodesOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,130 @@ +{ + "title": "EnterpriseMccCacheNodesOperations Update - generated by [MaximumSet] rule", + "operationId": "EnterpriseMccCacheNodesOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "qanjqtvrxzjkljdysdjvdiqcxkttskpdzykzuefhbhz", + "cacheNodeResourceName": "kllmlvazrcxmfjfozulzqnsgvspgwmhogcafvauchunlgfr", + "properties": { + "tags": { + "key1653": "nzjczrhclhkndesgy" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "yeinlleavzbehelhsucb", + "customerId": "xjjgcknmsakfawcmwbdufdxktysp", + "customerName": "zsklcocjfjhkcpmzyefzkwamdzc", + "ipAddress": "gbfkdhloyphnpnhemwrcrxlk", + "customerIndex": "vafvezmelfgmjsrccjukrhppljvipg", + "cacheNodeId": "fmrjefyddfn", + "cacheNodeName": "qppvqxliajjfoalzjbgmxggr", + "customerAsn": 25, + "isEnabled": true, + "maxAllowableEgressInMbps": 27, + "maxAllowableProbability": 12, + "xCid": "ooyrhuockukmsrqsevwaaqglhf", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "tvmivvnpisuboggoqgbobugld", + "clientTenantId": "iwrpakllacxvtqygpaimlpxvqrjz", + "category": "utfjefejkrpxcmrgygzawa", + "releaseVersion": 29, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 4, + "containerConfigurations": "dyvefvbvrtsmdrdmiuphzh", + "cidrCsv": [ + "kaynxstxqsoreorwh" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.774Z", + "bgpReviewStateText": "khtriksrqrjieouoz", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "bc", + "bgpNumberOfTimesUpdated": 23, + "bgpNumberOfRecords": 25, + "bgpCidrBlocksCount": 28, + "bgpAddressSpace": 30, + "shouldMigrate": true, + "bgpFileBytesTruncated": 26, + "cidrSelectionType": 11, + "isFrozen": true, + "reviewState": 2, + "reviewStateText": "xubwhyrdtramrmoldbxqwauyusymqu", + "reviewFeedback": "zowuztcnybt", + "configurationState": "Configured", + "configurationStateText": "okbofqwtzcsju", + "addressSpace": 1, + "workerConnections": 19, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.774Z", + "containerResyncTrigger": 23, + "imageUri": "wkowdrixfxvjmdcsy" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "lgljxmyyoakw", + "additionalCacheNodeProperties": { + "cacheNodePropertiesDetailsIssuesList": [ + "ennbzfpuszgalzpawmwicaofqcwcj" + ], + "aggregatedStatusDetails": "nztcstlyjhmllbnrrluhzusmoa", + "aggregatedStatusText": "ofiedyvzpbijnfghnrrigqaws", + "aggregatedStatusCode": 25, + "productVersion": "hfbuukpxoerpkziym", + "isProvisioned": true, + "cacheNodeStateDetailedText": "onckp", + "cacheNodeStateShortText": "yxkwlubqlzhkmemzjzlxksho", + "cacheNodeState": 30, + "driveConfiguration": [ + { + "physicalPath": "pcbkezoofhamkycot", + "sizeInGb": 14, + "cacheNumber": 11, + "nginxMapping": "cirlpkpuxg" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "fjbggfvumrn" + }, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "ihkzxlzvpcywtzrogupqozkdud", + "optionalProperty1": "ph", + "optionalProperty2": "soqqgpgcbhb", + "optionalProperty3": "fpnycrbagptsujiotnjfuhlm", + "optionalProperty4": "gesqugrxvhxlxxyvatgrautxwlmxsf", + "optionalProperty5": "zknjgzpaqtvdqjydd" + }, + "status": "utgrdjsw", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob" + } + }, + "tags": { + "key259": "qbkixjuyjkoj" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_CreateOrUpdate_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..41d421189b6f --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,220 @@ +{ + "title": "EnterpriseMccCustomers_CreateOrUpdate", + "operationId": "EnterpriseMccCustomers_CreateOrUpdate", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest1", + "resource": { + "properties": { + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "clientTenantId": "fproidkpgvpdnac", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true, + "verifySignupPhrase": "tprjvttkgmrqlsyicnidhm" + }, + "additionalCustomerProperties": { + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "error": {} + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers", + "location": "westus", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode2", + "name": "MccRPTest2", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "location": "westus", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_Delete_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..bd7d3d82e66c --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "EnterpriseMccCustomers_Delete", + "operationId": "EnterpriseMccCustomers_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "zktb" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_Get_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..89de109742f3 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_Get_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "title": "EnterpriseMccCustomers_Get", + "operationId": "EnterpriseMccCustomers_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "pvilvqkofbjbykupeewgvzlmjao" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers", + "location": "westus", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_ListByResourceGroup_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..e20505f9b477 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,99 @@ +{ + "title": "EnterpriseMccCustomers_ListByResourceGroup", + "operationId": "EnterpriseMccCustomers_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers", + "location": "westus", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/ae" + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_ListBySubscription_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..16668799f060 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "EnterpriseMccCustomers_ListBySubscription", + "operationId": "EnterpriseMccCustomers_ListBySubscription", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers", + "location": "westus", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/ae" + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_Update_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..1471deab8567 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/EnterpriseMccCustomers_Update_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "title": "EnterpriseMccCustomers_Update", + "operationId": "EnterpriseMccCustomers_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest1", + "properties": { + "tags": { + "key1878": "warz" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr" + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..3f525b15ea57 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,284 @@ +{ + "title": "IspCacheNodesOperations_CreateOrUpdate", + "operationId": "IspCacheNodesOperations_CreateOrUpdate", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "zpqzbmanlljgmkrthtydrtneavhlnlqkdmviq", + "cacheNodeResourceName": "cabakm", + "resource": { + "location": "westus", + "properties": { + "cacheNode": { + "fullyQualifiedResourceId": "hskxkpbiqbrbjiwdzrxndru", + "customerName": "xwyqk", + "ipAddress": "voctagljcwqgcpnionqdcbjk", + "customerIndex": "qtoiglqaswivmkjhzogburcxtszmek", + "cacheNodeId": "xjzffjftwcgsehanoxsl", + "cacheNodeName": "mfjxb", + "customerAsn": 4, + "isEnabled": true, + "maxAllowableEgressInMbps": 29, + "isEnterpriseManaged": true, + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "shouldMigrate": true, + "cidrSelectionType": 4 + }, + "additionalCacheNodeProperties": { + "driveConfiguration": [ + { + "physicalPath": "/mcc", + "sizeInGb": 500, + "cacheNumber": 1, + "nginxMapping": "lijygenjq" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "pafcimhoog" + }, + "cacheNodePropertiesDetailsIssuesList": [ + "ex" + ], + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "qhux", + "optionalProperty1": "hvpmt", + "optionalProperty2": "talanelmsgxvksrzoeeontqkjzbpv", + "optionalProperty3": "bxkoxq", + "optionalProperty4": "pqlkcekupusoc", + "optionalProperty5": "nyvvmrjigqdufzjdvazdca" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "djruqvptzxak", + "error": {} + }, + "tags": { + "key4171": "qtjlszkawsdujzpgohsbw" + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DOTest/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "hskxkpbiqbrbjiwdzrxndru", + "customerId": "ceyfqoygknpmmjojlhuklqybfl", + "customerName": "xwyqk", + "ipAddress": "voctagljcwqgcpnionqdcbjk", + "customerIndex": "qtoiglqaswivmkjhzogburcxtszmek", + "cacheNodeId": "xjzffjftwcgsehanoxsl", + "cacheNodeName": "mfjxb", + "customerAsn": 4, + "isEnabled": true, + "maxAllowableEgressInMbps": 29, + "maxAllowableProbability": 16, + "xCid": "kwnwgdbeflazz", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "oeyevqzlpbsimi", + "clientTenantId": "ds", + "category": "rixlfzbl", + "releaseVersion": 30, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 11, + "containerConfigurations": "waygqqgfzvnvlbufilldsqavwlshzt", + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.777Z", + "bgpReviewStateText": "xduneialocyri", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "us", + "bgpNumberOfTimesUpdated": 2, + "bgpNumberOfRecords": 21, + "bgpCidrBlocksCount": 5, + "bgpAddressSpace": 6, + "shouldMigrate": true, + "bgpFileBytesTruncated": 13, + "cidrSelectionType": 4, + "isFrozen": true, + "reviewState": 19, + "reviewStateText": "mrnragzmnscovixohmif", + "reviewFeedback": "wrcfimvx", + "configurationState": "Configured", + "configurationStateText": "arugukqjcxmkbgfambg", + "addressSpace": 11, + "workerConnections": 18, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.777Z", + "containerResyncTrigger": 13, + "imageUri": "ezbwyfaainatxtlplyoailzxlhxy" + }, + "additionalCacheNodeProperties": { + "driveConfiguration": [ + { + "physicalPath": "/mcc", + "sizeInGb": 500, + "cacheNumber": 1, + "nginxMapping": "lijygenjq" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "pafcimhoog" + }, + "cacheNodePropertiesDetailsIssuesList": [ + "ex" + ], + "aggregatedStatusDetails": "emougql", + "aggregatedStatusText": "xcasvndgkob", + "aggregatedStatusCode": 22, + "productVersion": "oxhqgwlhgnuf", + "isProvisioned": true, + "cacheNodeStateDetailedText": "ufvomikgfnmnj", + "cacheNodeStateShortText": "orfpuvrevhrxsaasddazigglq", + "cacheNodeState": 9, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "qhux", + "optionalProperty1": "hvpmt", + "optionalProperty2": "talanelmsgxvksrzoeeontqkjzbpv", + "optionalProperty3": "bxkoxq", + "optionalProperty4": "pqlkcekupusoc", + "optionalProperty5": "nyvvmrjigqdufzjdvazdca" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "djruqvptzxak", + "status": "tnyrntqvazk" + }, + "tags": { + "key4171": "qtjlszkawsdujzpgohsbw" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DOTest/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "hskxkpbiqbrbjiwdzrxndru", + "customerId": "ceyfqoygknpmmjojlhuklqybfl", + "customerName": "xwyqk", + "ipAddress": "voctagljcwqgcpnionqdcbjk", + "customerIndex": "qtoiglqaswivmkjhzogburcxtszmek", + "cacheNodeId": "xjzffjftwcgsehanoxsl", + "cacheNodeName": "mfjxb", + "customerAsn": 4, + "isEnabled": true, + "maxAllowableEgressInMbps": 29, + "maxAllowableProbability": 16, + "xCid": "kwnwgdbeflazz", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "oeyevqzlpbsimi", + "clientTenantId": "ds", + "category": "rixlfzbl", + "releaseVersion": 30, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 11, + "containerConfigurations": "waygqqgfzvnvlbufilldsqavwlshzt", + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.777Z", + "bgpReviewStateText": "xduneialocyri", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "us", + "bgpNumberOfTimesUpdated": 2, + "bgpNumberOfRecords": 21, + "bgpCidrBlocksCount": 5, + "bgpAddressSpace": 6, + "shouldMigrate": true, + "bgpFileBytesTruncated": 13, + "cidrSelectionType": 4, + "reviewState": 19, + "reviewStateText": "mrnragzmnscovixohmif", + "reviewFeedback": "wrcfimvx", + "configurationState": "Configured", + "configurationStateText": "arugukqjcxmkbgfambg", + "isFrozen": true, + "workerConnections": 18, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.777Z", + "containerResyncTrigger": 13 + }, + "additionalCacheNodeProperties": { + "driveConfiguration": [ + { + "physicalPath": "/mcc", + "sizeInGb": 500, + "cacheNumber": 1, + "nginxMapping": "lijygenjq" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "pafcimhoog" + }, + "cacheNodePropertiesDetailsIssuesList": [ + "ex" + ], + "aggregatedStatusDetails": "emougql", + "aggregatedStatusText": "xcasvndgkob", + "aggregatedStatusCode": 22, + "productVersion": "oxhqgwlhgnuf", + "isProvisioned": true, + "cacheNodeStateDetailedText": "ufvomikgfnmnj", + "cacheNodeStateShortText": "orfpuvrevhrxsaasddazigglq", + "cacheNodeState": 9, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "qhux", + "optionalProperty1": "hvpmt", + "optionalProperty2": "talanelmsgxvksrzoeeontqkjzbpv", + "optionalProperty3": "bxkoxq", + "optionalProperty4": "pqlkcekupusoc", + "optionalProperty5": "nyvvmrjigqdufzjdvazdca" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "djruqvptzxak", + "status": "tnyrntqvazk" + }, + "tags": { + "key4171": "qtjlszkawsdujzpgohsbw" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_Delete_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..3959eb42ad8b --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "IspCacheNodes delete Operation - generated by [MaximumSet] rule", + "operationId": "IspCacheNodesOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "lvpcosvbfxtpzscakewx", + "cacheNodeResourceName": "wsiruvexelltpbouqxvsogqpxdizcwqwfowybncvjunlakjwcpgmqbdbgzjrsmxlkczxnsxfonhnqqa" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_GetBgpCidrs_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_GetBgpCidrs_MaximumSet_Gen.json new file mode 100644 index 000000000000..559b0beaafb1 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_GetBgpCidrs_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "IspCacheNodes resource BgpCidrs details - generated by [MaximumSet] rule", + "operationId": "IspCacheNodesOperations_GetBgpCidrs", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest1", + "cacheNodeResourceName": "MCCCachenode1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "location": "westus", + "properties": { + "bgpCidrs": [ + "10.1.0.1/23", + "10.1.0.1/32" + ] + }, + "tags": { + "key5911": "qllqoxckxvnyhdegqubvqtfediery" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json new file mode 100644 index 000000000000..3dde7870de38 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "ispCacheNode resource get install details - generated by [MaximumSet] rule", + "operationId": "IspCacheNodesOperations_GetCacheNodeInstallDetails", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest1", + "cacheNodeResourceName": "MCCCachenode1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "location": "westus", + "properties": { + "customerId": "eqklliuswn", + "cacheNodeId": "zirahqqohbaju", + "primaryAccountKey": "mzfvziehrsbxidhj", + "secondaryAccountKey": "dq", + "registrationKey": "tnwkmorctwsgajewcoutombm" + }, + "tags": { + "key5811": "betoafcoprgfcuscoew" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_Get_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..41c2bc8cbaf2 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,126 @@ +{ + "title": "IspCacheNodes Get resource - generated by [MaximumSet] rule", + "operationId": "IspCacheNodesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "sgtqjsitdrskmgyrrkntszwrrjjkretscpjgaezraucvcwececlelcsorfunrnvxyxcsrg", + "cacheNodeResourceName": "lbsziwmudcjnwnwy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "hskxkpbiqbrbjiwdzrxndru", + "customerId": "ceyfqoygknpmmjojlhuklqybfl", + "customerName": "xwyqk", + "ipAddress": "voctagljcwqgcpnionqdcbjk", + "customerIndex": "qtoiglqaswivmkjhzogburcxtszmek", + "cacheNodeId": "xjzffjftwcgsehanoxsl", + "cacheNodeName": "mfjxb", + "customerAsn": 4, + "isEnabled": true, + "maxAllowableEgressInMbps": 29, + "maxAllowableProbability": 16, + "xCid": "kwnwgdbeflazz", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "oeyevqzlpbsimi", + "clientTenantId": "ds", + "category": "rixlfzbl", + "releaseVersion": 30, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 11, + "containerConfigurations": "waygqqgfzvnvlbufilldsqavwlshzt", + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.777Z", + "bgpReviewStateText": "xduneialocyri", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "us", + "bgpNumberOfTimesUpdated": 2, + "bgpNumberOfRecords": 21, + "bgpCidrBlocksCount": 5, + "bgpAddressSpace": 6, + "shouldMigrate": true, + "bgpFileBytesTruncated": 13, + "cidrSelectionType": 4, + "isFrozen": true, + "reviewState": 19, + "reviewStateText": "mrnragzmnscovixohmif", + "reviewFeedback": "wrcfimvx", + "configurationState": "Configured", + "configurationStateText": "arugukqjcxmkbgfambg", + "addressSpace": 11, + "workerConnections": 18, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.777Z", + "containerResyncTrigger": 13, + "imageUri": "ezbwyfaainatxtlplyoailzxlhxy" + }, + "additionalCacheNodeProperties": { + "driveConfiguration": [ + { + "physicalPath": "/mcc", + "sizeInGb": 500, + "cacheNumber": 1, + "nginxMapping": "lijygenjq" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "pafcimhoog" + }, + "cacheNodePropertiesDetailsIssuesList": [ + "ex" + ], + "aggregatedStatusDetails": "emougql", + "aggregatedStatusText": "xcasvndgkob", + "aggregatedStatusCode": 22, + "productVersion": "oxhqgwlhgnuf", + "isProvisioned": true, + "cacheNodeStateDetailedText": "ufvomikgfnmnj", + "cacheNodeStateShortText": "orfpuvrevhrxsaasddazigglq", + "cacheNodeState": 9, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "qhux", + "optionalProperty1": "hvpmt", + "optionalProperty2": "talanelmsgxvksrzoeeontqkjzbpv", + "optionalProperty3": "bxkoxq", + "optionalProperty4": "pqlkcekupusoc", + "optionalProperty5": "nyvvmrjigqdufzjdvazdca" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "djruqvptzxak", + "status": "tnyrntqvazk", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4171": "qtjlszkawsdujzpgohsbw" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_ListByIspCustomerResource_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_ListByIspCustomerResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..707d84da6991 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_ListByIspCustomerResource_MaximumSet_Gen.json @@ -0,0 +1,130 @@ +{ + "title": "IspCacheNodesOperations_ListByIspCustomerResource", + "operationId": "IspCacheNodesOperations_ListByIspCustomerResource", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "hskxkpbiqbrbjiwdzrxndru", + "customerId": "ceyfqoygknpmmjojlhuklqybfl", + "customerName": "xwyqk", + "ipAddress": "voctagljcwqgcpnionqdcbjk", + "customerIndex": "qtoiglqaswivmkjhzogburcxtszmek", + "cacheNodeId": "xjzffjftwcgsehanoxsl", + "cacheNodeName": "mfjxb", + "customerAsn": 4, + "isEnabled": true, + "maxAllowableEgressInMbps": 29, + "maxAllowableProbability": 16, + "xCid": "kwnwgdbeflazz", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "oeyevqzlpbsimi", + "clientTenantId": "ds", + "category": "rixlfzbl", + "releaseVersion": 30, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 11, + "containerConfigurations": "waygqqgfzvnvlbufilldsqavwlshzt", + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.777Z", + "bgpReviewStateText": "xduneialocyri", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "us", + "bgpNumberOfTimesUpdated": 2, + "bgpNumberOfRecords": 21, + "bgpCidrBlocksCount": 5, + "bgpAddressSpace": 6, + "shouldMigrate": true, + "bgpFileBytesTruncated": 13, + "cidrSelectionType": 4, + "isFrozen": true, + "reviewState": 19, + "reviewStateText": "mrnragzmnscovixohmif", + "reviewFeedback": "wrcfimvx", + "configurationState": "Configured", + "configurationStateText": "arugukqjcxmkbgfambg", + "addressSpace": 11, + "workerConnections": 18, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.777Z", + "containerResyncTrigger": 13, + "imageUri": "ezbwyfaainatxtlplyoailzxlhxy" + }, + "additionalCacheNodeProperties": { + "driveConfiguration": [ + { + "physicalPath": "/mcc", + "sizeInGb": 500, + "cacheNumber": 1, + "nginxMapping": "lijygenjq" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "pafcimhoog" + }, + "cacheNodePropertiesDetailsIssuesList": [ + "ex" + ], + "aggregatedStatusDetails": "emougql", + "aggregatedStatusText": "xcasvndgkob", + "aggregatedStatusCode": 22, + "productVersion": "oxhqgwlhgnuf", + "isProvisioned": true, + "cacheNodeStateDetailedText": "ufvomikgfnmnj", + "cacheNodeStateShortText": "orfpuvrevhrxsaasddazigglq", + "cacheNodeState": 9, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "qhux", + "optionalProperty1": "hvpmt", + "optionalProperty2": "talanelmsgxvksrzoeeontqkjzbpv", + "optionalProperty3": "bxkoxq", + "optionalProperty4": "pqlkcekupusoc", + "optionalProperty5": "nyvvmrjigqdufzjdvazdca" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "djruqvptzxak", + "status": "tnyrntqvazk", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4171": "qtjlszkawsdujzpgohsbw" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_Update_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..85cb4b9d4054 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCacheNodesOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,131 @@ +{ + "title": "IspCacheNodesOperations_Update", + "operationId": "IspCacheNodesOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest1", + "cacheNodeResourceName": "MCCCachenode1", + "properties": { + "tags": { + "key1653": "nzjczrhclhkndesgy" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "hskxkpbiqbrbjiwdzrxndru", + "customerId": "ceyfqoygknpmmjojlhuklqybfl", + "customerName": "xwyqk", + "ipAddress": "voctagljcwqgcpnionqdcbjk", + "customerIndex": "qtoiglqaswivmkjhzogburcxtszmek", + "cacheNodeId": "xjzffjftwcgsehanoxsl", + "cacheNodeName": "mfjxb", + "customerAsn": 4, + "isEnabled": true, + "maxAllowableEgressInMbps": 29, + "maxAllowableProbability": 16, + "xCid": "kwnwgdbeflazz", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "oeyevqzlpbsimi", + "clientTenantId": "ds", + "category": "rixlfzbl", + "releaseVersion": 30, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 11, + "containerConfigurations": "waygqqgfzvnvlbufilldsqavwlshzt", + "cidrCsv": [ + "127.0.0.1/20" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.777Z", + "bgpReviewStateText": "xduneialocyri", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "us", + "bgpNumberOfTimesUpdated": 2, + "bgpNumberOfRecords": 21, + "bgpCidrBlocksCount": 5, + "bgpAddressSpace": 6, + "shouldMigrate": true, + "bgpFileBytesTruncated": 13, + "cidrSelectionType": 4, + "isFrozen": true, + "reviewState": 19, + "reviewStateText": "mrnragzmnscovixohmif", + "reviewFeedback": "wrcfimvx", + "configurationState": "Configured", + "configurationStateText": "arugukqjcxmkbgfambg", + "addressSpace": 11, + "workerConnections": 18, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.777Z", + "containerResyncTrigger": 13, + "imageUri": "ezbwyfaainatxtlplyoailzxlhxy" + }, + "additionalCacheNodeProperties": { + "driveConfiguration": [ + { + "physicalPath": "/mcc", + "sizeInGb": 500, + "cacheNumber": 1, + "nginxMapping": "lijygenjq" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "pafcimhoog" + }, + "cacheNodePropertiesDetailsIssuesList": [ + "ex" + ], + "aggregatedStatusDetails": "emougql", + "aggregatedStatusText": "xcasvndgkob", + "aggregatedStatusCode": 22, + "productVersion": "oxhqgwlhgnuf", + "isProvisioned": true, + "cacheNodeStateDetailedText": "ufvomikgfnmnj", + "cacheNodeStateShortText": "orfpuvrevhrxsaasddazigglq", + "cacheNodeState": 9, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "qhux", + "optionalProperty1": "hvpmt", + "optionalProperty2": "talanelmsgxvksrzoeeontqkjzbpv", + "optionalProperty3": "bxkoxq", + "optionalProperty4": "pqlkcekupusoc", + "optionalProperty5": "nyvvmrjigqdufzjdvazdca" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "djruqvptzxak", + "status": "tnyrntqvazk", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4171": "qtjlszkawsdujzpgohsbw" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_CreateOrUpdate_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..a5183a6bde6b --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,220 @@ +{ + "title": "ispCustomer CreateOrUpdate - generated by [MaximumSet] rule", + "operationId": "IspCustomers_CreateOrUpdate", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest2", + "resource": { + "location": "westus", + "properties": { + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "clientTenantId": "fproidkpgvpdnac", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true, + "verifySignupPhrase": "tprjvttkgmrqlsyicnidhm" + }, + "additionalCustomerProperties": { + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "error": {} + }, + "tags": { + "key1878": "warz" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key1878": "warz" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key1878": "warz" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_Delete_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2e43eaf23a71 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "IspCustomers Delete - generated by [MaximumSet] rule", + "operationId": "IspCustomers_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "hdontfoythjsaeyjhrakckgimgchxwzttbcnvntpvdsgeumxpgnjurptd" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_Get_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..7868924de6ca --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_Get_MaximumSet_Gen.json @@ -0,0 +1,94 @@ +{ + "title": "IspCustomers Get - generated by [MaximumSet] rule", + "operationId": "IspCustomers_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "cmcjfueweicolcjkwmsuvcj" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key1878": "warz" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_ListByResourceGroup_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..bcaf7a667d9f --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,180 @@ +{ + "title": "IspCustomers resource List by Resource group - generated by [MaximumSet] rule", + "operationId": "IspCustomers_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key1878": "warz" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1", + "name": "MCCTPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "oytrfgfhk", + "statusText": "pqitblihwfrq", + "statusDetails": "kvxqjbldcwqgslerajc", + "status": "stwi", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key2096": "uzoqqgqnnaiagdqilrjiezogx" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/ao" + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_ListBySubscription_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..1da8aeb7c6db --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,179 @@ +{ + "title": "ispCustomer List by Subscription - generated by [MaximumSet] rule", + "operationId": "IspCustomers_ListBySubscription", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key1878": "warz" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1", + "name": "MCCTPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "oytrfgfhk", + "statusText": "pqitblihwfrq", + "statusDetails": "kvxqjbldcwqgslerajc", + "status": "stwi", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key2096": "uzoqqgqnnaiagdqilrjiezogx" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/ao" + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_Update_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..2896e29eb578 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/IspCustomers_Update_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "title": "ispCustomer Update details - generated by [MaximumSet] rule", + "operationId": "IspCustomers_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest2", + "properties": { + "tags": { + "key1653": "nzjczrhclhkndesgy" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr" + }, + "tags": { + "key1878": "warz" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/Operations_List_MaximumSet_Gen.json b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..3ae8071fca68 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/examples/2023-05-01-preview/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "List the operations for the provider - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "operationName", + "display": { + "provider": "providerName", + "resource": "resourceName", + "operation": "operationName", + "description": "zkcugoxocugvzcsedehxwbxiuvrb" + }, + "isDataAction": true, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/ConnectedCache.Management/ispCacheNodes.tsp b/specification/connectedcache/ConnectedCache.Management/ispCacheNodes.tsp new file mode 100644 index 000000000000..bdffd8fba71d --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/ispCacheNodes.tsp @@ -0,0 +1,53 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ispCustomers.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; + +namespace Microsoft.ConnectedCache; + +@doc("Represents the high level Nodes needed to provision cache node resources") +@parentResource(IspCustomerResource) +model IspCacheNodeResource is TrackedResource { + @doc("Name of the ConnectedCache resource") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9\\_\\-]*") + @key("cacheNodeResourceName") + @segment("ispCacheNodes") + @path + name: string; +} + +@armResourceOperations +interface IspCacheNodesOperations { + @doc("This api gets ispCacheNode resource information") + get is ArmResourceRead; + @doc("This api creates an ispCacheNode with the specified create parameters") + createOrUpdate is ArmResourceCreateOrUpdateAsync; + @doc("This api updates an existing ispCacheNode resource") + update is ArmCustomPatchSync< + IspCacheNodeResource, + ConnectedCachePatchResource + >; + @doc("This api deletes an existing ispCacheNode resource") + delete is ArmResourceDeleteWithoutOkAsync; + @doc("This api retrieves information about all ispCacheNode resources under the given subscription and resource group") + listByIspCustomerResource is ArmResourceListByParent; + @doc("This api gets ispCacheNode resource information") + getBgpCidrs is ArmResourceActionSync< + IspCacheNodeResource, + void, + MccCacheNodeBgpCidrDetails + >; + @doc("This api gets secrets of the ispCacheNode resource install details") + getCacheNodeInstallDetails is ArmResourceActionSync< + IspCacheNodeResource, + void, + MccCacheNodeInstallDetails + >; +} diff --git a/specification/connectedcache/ConnectedCache.Management/ispCustomers.tsp b/specification/connectedcache/ConnectedCache.Management/ispCustomers.tsp new file mode 100644 index 000000000000..1d804a1296d9 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/ispCustomers.tsp @@ -0,0 +1,40 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; + +namespace Microsoft.ConnectedCache; +@doc("Represents the high level Nodes needed to provision isp customer resources") +model IspCustomerResource is TrackedResource { + @doc("Name of the Customer resource") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9\\_\\-]*") + @key("customerResourceName") + @segment("ispCustomers") + @path + name: string; +} + +@armResourceOperations +interface IspCustomers { + @doc("Gets the ispCustomer resource information using this get call") + get is ArmResourceRead; + @doc("This api creates an ispCustomer with the specified create parameters") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + @doc("This api updates an existing ispCustomer resource") + update is ArmCustomPatchSync< + IspCustomerResource, + ConnectedCachePatchResource + >; + @doc("This api deletes an existing ispCustomer resource") + delete is ArmResourceDeleteWithoutOkAsync; + @doc("This api gets the information about all ispCustomer resources under the given subscription and resource group") + listByResourceGroup is ArmResourceListByParent; + @doc("This api gets information about all ispCustomer resources under the given subscription") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/connectedcache/ConnectedCache.Management/main.tsp b/specification/connectedcache/ConnectedCache.Management/main.tsp new file mode 100644 index 000000000000..21af9a3deb45 --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/main.tsp @@ -0,0 +1,33 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; +import "./enterpriseCustomerspreviewResource.tsp"; +import "./cacheNodespreviewResource.tsp"; +import "./ispCustomers.tsp"; +import "./ispCacheNodes.tsp"; +import "./enterpriseMccCustomers.tsp"; +import "./enterpriseMccCacheNodes.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; +@armProviderNamespace +@service({ + title: "ConnectedCache", +}) +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +@doc("Microsoft Connected Cache Rest Api version 2023-05-01-preview") +namespace Microsoft.ConnectedCache; + +@doc("The available API versions.") +enum Versions { + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("Microsoft Connected Cache Rest Api version 2023-05-01-preview") + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2023_05_01_preview: "2023-05-01-preview", +} diff --git a/specification/connectedcache/ConnectedCache.Management/models.tsp b/specification/connectedcache/ConnectedCache.Management/models.tsp new file mode 100644 index 000000000000..99b41ada5a1e --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/models.tsp @@ -0,0 +1,779 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Http; +namespace Microsoft.ConnectedCache; + +interface Operations extends Azure.ResourceManager.Operations {} + +@doc("provisioning state of the resource") +union ProvisioningState { + string, + Azure.ResourceManager.ResourceProvisioningState, + + /** unknown state of the provisioning state */ + Unknown: "Unknown", + + /** Accepted state of the provisioning state during the Async Operations */ + Accepted: "Accepted", + + /** Upgrading state of the provisioning state */ + Upgrading: "Upgrading", + + /** Deleting state of the provisioning state */ + Deleting: "Deleting", +} + +@doc("Operating System of the cache node") +union OsType { + string, + + /** cache node installs on windows operating system */ + Windows: "Windows", + + /** cache node installs on Linux Operating system */ + Linux: "Linux", + + /** cache node installs on Azure Eflow */ + Eflow: "Eflow", +} + +@doc("Cache node resource Bgp review state as integer") +union BgpReviewStateEnum { + string, + + /** bgp not configured */ + NotConfigured: "NotConfigured", + + /** bgp is in review state */ + InReview: "InReview", + + /** bgp is in Approved state */ + Approved: "Approved", + + /** bgp is setup need an attention for more troubleshoot */ + AttentionRequired: "AttentionRequired", +} + +@doc("Cache node configuration setup state") +union ConfigurationState { + string, + + /** connected cache setup configured */ + Configured: "Configured", + + /** connected cache setup not configured */ + NotConfigured_Ip: "NotConfigured_Ip", +} + +@doc("Proxy details enum") +union ProxyRequired { + string, + + /** Proxy is not required in setup */ + None: "None", + + /** proxy is required in setup */ + Required: "Required", +} + +@doc("Customer resource transit states") +union CustomerTransitState { + string, + + /** do not have transit */ + NoTransit: "NoTransit", + + /** transit provider and have own subscribers */ + CombinedTransit: "CombinedTransit", + + /** pure transit provider or network service provider */ + TransitOnly: "TransitOnly", +} + +@doc("Auto update Ring type") +union autoUpdateRingType { + string, + + /** customer selection of preview update install mcc on their physical vm */ + Preview: "Preview", + + /** customer selection of slow update to install mcc on their physical vm */ + Slow: "Slow", + + /** customer selection of fast / auto update to install mcc on their physical vm */ + Fast: "Fast", +} + +@doc("Update Cycle type") +union CycleType { + string, + + /** customer selection of preview update install mcc on their physical vm */ + Preview: "Preview", + + /** customer selection of slow update to install mcc on their physical vm */ + Slow: "Slow", + + /** customer selection of fast / auto update to install mcc on their physical vm */ + Fast: "Fast", +} + +@doc("Model representing Cache Node for ConnectedCache resource") +model CacheNodeOldResponse { + @doc("The provisioned state of the resource") + @visibility("read") + provisioningState?: ProvisioningState; + + @doc("statusCode used to get code details of Mcc response object") + statusCode?: string; + + @doc("statusText used to get status details in string format of Mcc response object") + statusText?: string; + + @doc("statusDetails used to get inner details of Mcc response object") + statusDetails?: string; + + @doc("status of the HTTP error code") + @visibility("read") + status?: string; + + @doc("The error details") + error?: Azure.ResourceManager.Foundations.ErrorDetail; +} + +@doc("Mcc PATCH operation properties.") +model ConnectedCachePatchResource { + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Existing api" + @doc("Resource tags.") + @visibility("read", "update") + tags?: Record; +} + +@doc("Model representing customer for connectedCache resource") +model CustomerProperty { + @doc("The provisioned state of the resource") + @visibility("read") + provisioningState?: ProvisioningState; + + @doc("Mcc customer resource (customer entity).") + customer?: CustomerEntity; + + @doc("Mcc customer resource additional properties.") + additionalCustomerProperties?: AdditionalCustomerProperties; + + @doc("Mcc response status code.") + @visibility("read") + statusCode?: string; + + @doc("Mcc response status text as string for retrieving status details.") + @visibility("read") + statusText?: string; + + @doc("Mcc response status details for retrieving response inner details.") + @visibility("read") + statusDetails?: string; + + @doc("HTTP error status code.") + @visibility("read") + status?: string; + + @doc("Mcc response error details.") + @visibility("read") + error?: Azure.ResourceManager.Foundations.ErrorDetail; +} + +@doc("Model representing Customer resource for ConnectedCache resource") +model CustomerEntity { + @doc("Customer resource Azure fully qualified resource Id.") + fullyQualifiedResourceId?: string; + + @doc("Customer resource Guid Id.") + @visibility("read") + customerId?: string; + + @doc("Customer resource name.") + customerName?: string; + + @doc("Customer resource contact email.") + contactEmail?: string; + + @doc("Customer resource contact phone.") + contactPhone?: string; + + @doc("Customer resource contact full name.") + contactName?: string; + + @doc("Customer resource entitlement flag as boolean.") + isEntitled?: boolean; + + @doc("Customer resource Mcc release version.") + releaseVersion?: int32; + + @doc("Customer resource create async operation Id.") + @visibility("read") + createAsyncOperationId?: string; + + @doc("Customer resource deletion async operation Id.") + @visibility("read") + deleteAsyncOperationId?: string; + + @doc("Customer resource client tenant Id of subscription.") + clientTenantId?: string; + + @doc("Customer resource sync attempts.") + @visibility("read") + synchWithAzureAttemptsCount?: int32; + + @doc("Customer resource last Azure sync timestamp.") + @visibility("read") + lastSyncWithAzureTimestamp?: utcDateTime; + + @doc("Customer resource flag for enterprise management as boolean.") + isEnterpriseManaged?: boolean; + + @doc("Customer resource flag for migration.") + shouldMigrate?: boolean; + + @doc("Customer resource flag for resending signup code as boolean.") + resendSignupCode?: boolean; + + @doc("Customer resource flag for requiring verification of signup code as boolean.") + verifySignupCode?: boolean; + + @doc("Customer resource phrase for verifying signup.") + @visibility("create", "update") + @secret + verifySignupPhrase?: string; +} + +@doc("Model representing customer for connected cache resource") +model AdditionalCustomerProperties { + @doc("Customer resource last PeeringDB update timestamp.") + @visibility("read") + peeringDbLastUpdateTime?: utcDateTime; + + @doc("Customer resource cache efficiency.") + @visibility("read") + customerPropertiesOverviewCacheEfficiency?: float32; + + @doc("Customer resource average egress in Mbps.") + @visibility("read") + customerPropertiesOverviewAverageEgressMbps?: float32; + + @doc("Customer resource average cache miss throughput in Mbps.") + @visibility("read") + customerPropertiesOverviewAverageMissMbps?: float32; + + @doc("Customer resource maximum egress in Mbps.") + @visibility("read") + customerPropertiesOverviewEgressMbpsMax?: float32; + + @doc("Customer resource peak egress timestamp.") + @visibility("read") + customerPropertiesOverviewEgressMbpsMaxDateTime?: utcDateTime; + + @doc("Customer resource maximum cache miss throughput in Mbps.") + @visibility("read") + customerPropertiesOverviewMissMbpsMax?: float32; + + @doc("Customer resource peak cache miss throughput timestamp.") + @visibility("read") + customerPropertiesOverviewMissMbpsMaxDateTime?: utcDateTime; + + @doc("Customer resource total healthy cache nodes.") + @visibility("read") + customerPropertiesOverviewCacheNodesHealthyCount?: int32; + + @doc("Customer resource total unhealthy cache nodes.") + @visibility("read") + customerPropertiesOverviewCacheNodesUnhealthyCount?: int32; + + @doc("Customer resource signup status as boolean.") + @visibility("read") + signupStatus?: boolean; + + @doc("Customer resource signup status as integer code.") + @visibility("read") + signupStatusCode?: int32; + + @doc("Customer resource signup status as string text.") + @visibility("read") + signupStatusText?: string; + + @doc("Customer resource signup phase status code as integer.") + @visibility("read") + signupPhaseStatusCode?: int32; + + @doc("Customer resource signup phase status as string text.") + @visibility("read") + signupPhaseStatusText?: string; + + @doc("Customer resource last PeeringDB update timestamp.") + @visibility("read") + peeringDbLastUpdateDate?: utcDateTime; + + @doc("Customer resource owner organization name.") + @visibility("read") + customerOrgName?: string; + + @doc("Customer resource contact email.") + customerEmail?: string; + + @doc("Customer resource transit Asn (autonomous system number).") + customerTransitAsn?: string; + + @doc("Customer resource transit state.") + customerTransitState?: CustomerTransitState; + + @doc("Customer resource Asn (autonomous system number).") + customerAsn?: string; + + @doc("Customer resource estimated Asn peering peak in Gbps.") + @visibility("read") + customerAsnEstimatedEgressPeekGbps?: float32; + + @doc("Customer resource entitlement Sku Id.") + customerEntitlementSkuId?: string; + + @doc("Customer resource entitlement Sku Guid.") + customerEntitlementSkuGuid?: string; + + @doc("Customer resource entitlement Sku name.") + customerEntitlementSkuName?: string; + + @doc("Customer resource entitlement expiration date string.") + customerEntitlementExpiration?: utcDateTime; + + @doc("Optional property #1 of Mcc response object.") + optionalProperty1?: string; + + @doc("Optional property #2 of Mcc response object.") + optionalProperty2?: string; + + @doc("Optional property #3 of Mcc response object.") + optionalProperty3?: string; + + @doc("Optional property #4 of Mcc response object.") + optionalProperty4?: string; + + @doc("Optional property #5 of Mcc response object.") + optionalProperty5?: string; +} + +@doc("Model representing an Mcc cache node connectedCache resource") +model CacheNodeProperty { + @doc("The provisioned state of the resource") + @visibility("read") + provisioningState?: ProvisioningState; + + @doc("Mcc cache node resource (cache node entity).") + cacheNode?: CacheNodeEntity; + + @doc("Mcc cache node resource additional properties.") + additionalCacheNodeProperties?: AdditionalCacheNodeProperties; + + @doc("Mcc response status code.") + statusCode?: string; + + @doc("Mcc response status text as string for retrieving status details.") + statusText?: string; + + @doc("Mcc response status details for retrieving response inner details.") + statusDetails?: string; + + @doc("HTTP error status code.") + @visibility("read") + status?: string; + + @doc("Mcc response error details.") + error?: Azure.ResourceManager.Foundations.ErrorDetail; +} + +@doc("Model representing Cache Node for ConnectedCache resource") +model CacheNodeEntity { + @doc("Cache node resource Azure fully qualified resource Id.") + fullyQualifiedResourceId?: string; + + @doc("Cache node resource customer resource GUID Id.") + @visibility("read") + customerId?: string; + + @doc("Cache node resource customer resource name.") + customerName?: string; + + @doc("Cache node resource Ip address.") + ipAddress?: string; + + @doc("Cache node resource customer index as string.") + customerIndex?: string; + + @doc("Cache node resource identifier of the cache node") + cacheNodeId?: string; + + @doc("Cache node resource name.") + cacheNodeName?: string; + + @doc("Cache node resource customer resource Asn (autonomous system number)") + customerAsn?: int32; + + @doc("Cache node resource flag for indicating if cache node is enabled.") + isEnabled?: boolean; + + @doc("Cache node resource maximum allowed egress in Mbps.") + maxAllowableEgressInMbps?: int32; + + @doc("Cache node resource maximum allowed probability of egress.") + @visibility("read") + maxAllowableProbability?: float32; + + @doc("Cache node resource Azure XCid.") + @visibility("read") + xCid?: string; + + @doc("Cache node resource flag for determining if managed by enterprise as boolean.") + isEnterpriseManaged?: boolean; + + @doc("Cache node resource create async operation Id.") + @visibility("read") + createAsyncOperationId?: string; + + @doc("Cache node resource deletion async operation Id.") + @visibility("read") + deleteAsyncOperationId?: string; + + @doc("Cache node resource customer resource client tenant Id of subscription.") + @visibility("read") + clientTenantId?: string; + + @doc("Cache node resource category.") + @visibility("read") + category?: string; + + @doc("Cache node resource release version.") + @visibility("read") + releaseVersion?: int32; + + @doc("Cache node resource last sync timestamp.") + @visibility("read") + lastSyncWithAzureTimestamp?: utcDateTime; + + @doc("Cache node resource last backend updated timestamp.") + @visibility("read") + lastUpdatedTimestamp?: utcDateTime; + + @doc("Cache node resource attempts to sync with Azure.") + @visibility("read") + synchWithAzureAttemptsCount?: int32; + + @doc("Cache node resource container configuration details.") + @visibility("read") + containerConfigurations?: string; + + @doc("Cache node resource comma separated values of Cidrs.") + cidrCsv?: string[]; + + @doc("Cache node resource last Cidr Csv update timestamp") + @visibility("read") + cidrCsvLastUpdateTime?: utcDateTime; + + @doc("Cache node resource last Bgp Cidr Csv update timestamp") + @visibility("read") + bgpCidrCsvLastUpdateTime?: utcDateTime; + + @doc("Cache node resource last Bgp report timestamp.") + @visibility("read") + bgpLastReportedTime?: utcDateTime; + + @doc("Cache node resource Bgp review state string text in detail.") + @visibility("read") + bgpReviewStateText?: string; + + @doc("Cache node resource Bgp review state string text.") + @visibility("read") + bgpReviewState?: BgpReviewStateEnum; + + @doc("Cache node resource Bgp review feedback text.") + @visibility("read") + bgpReviewFeedback?: string; + + @doc("Cache node resource Bgp update count.") + @visibility("read") + bgpNumberOfTimesUpdated?: int32; + + @doc("Cache node resource Bgp record count.") + @visibility("read") + bgpNumberOfRecords?: int32; + + @doc("Cache node resource Bgp block count.") + @visibility("read") + bgpCidrBlocksCount?: int32; + + @doc("Cache node resource total addressable space defined by Bgp and Cidr Csv blocks.") + @visibility("read") + bgpAddressSpace?: int32; + + @doc("Cache node resource flag for determining if customer will be migrated.") + shouldMigrate?: boolean; + + @doc("Cache node resource bytes truncated from Bgp output file.") + @visibility("read") + bgpFileBytesTruncated?: int32; + + @doc("Cache node resource current Cidr range precedence selection type.") + cidrSelectionType?: int32; + + @doc("Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI).") + @visibility("read") + isFrozen?: boolean; + + @doc("Cache node resource review process state as integer") + @visibility("read") + reviewState?: int32; + + @doc("Cache node resource review state text.") + @visibility("read") + reviewStateText?: string; + + @doc("Cache node resource review feedback text.") + @visibility("read") + reviewFeedback?: string; + + @doc("Cache node resource configuration state.") + @visibility("read") + configurationState?: ConfigurationState; + + @doc("Cache node resource configuration state text.") + @visibility("read") + configurationStateText?: string; + + @doc("Cache node resource total addressable space defined by the Cidr Csv block.") + @visibility("read") + addressSpace?: int32; + + @doc("Cache node resource Mcc container deployment worker connection count.") + @visibility("read") + workerConnections?: int32; + + @doc("Cache node resource last updated Mcc container deployment worker connection count timestamp.") + @visibility("read") + workerConnectionsLastUpdatedDateTime?: utcDateTime; + + @doc("Cache node resource Mcc container configuration details re-sync trigger.") + @visibility("read") + containerResyncTrigger?: int32; + + @doc("Cache node resource Mcc Container Id Uri.") + @visibility("read") + imageUri?: string; + + @doc("FQDN(fully qualified domain name) value of the mcc cache node") + fullyQualifiedDomainName?: string; + + @doc("Auto Update Ring Type which is slow or fast etc.") + autoUpdateRingType?: autoUpdateRingType; + + @doc("Customer requested week of month for mcc install of auto update cycle") + @minValue(1) + @maxValue(5) + autoUpdateRequestedWeek?: int32; + + @doc("Customer requested day of week for mcc install of auto update cycle") + @minValue(1) + @maxValue(7) + autoUpdateRequestedDay?: int32; + + @doc("Customer requested time of the day for mcc install of auto update cycle, should be hh:mm") + @pattern("^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$") + autoUpdateRequestedTime?: string; +} + +@doc("Model representing cache node for connected cache resource") +model AdditionalCacheNodeProperties { + @doc("issues list to return the issues as part of the additional cache node properties") + cacheNodePropertiesDetailsIssuesList?: string[]; + + @doc("Cache node resource aggregated status details.") + @visibility("read") + aggregatedStatusDetails?: string; + + @doc("Cache node resource aggregated status text.") + @visibility("read") + aggregatedStatusText?: string; + + @doc("Cache node resource aggregated status code.") + @visibility("read") + aggregatedStatusCode?: int32; + + @doc("Cache node resource Mcc product version.") + @visibility("read") + productVersion?: string; + + @doc("Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab.") + @visibility("read") + isProvisioned?: boolean; + + @doc("Cache node resource detailed state text.") + @visibility("read") + cacheNodeStateDetailedText?: string; + + @doc("Cache node resource short state text.") + @visibility("read") + cacheNodeStateShortText?: string; + + @doc("Cache node resource state as integer.") + @visibility("read") + cacheNodeState?: int32; + + #suppress "@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers" "" + @doc("Cache node resource drive configurations.") + driveConfiguration?: CacheNodeDriveConfiguration[]; + + @doc("Cache node resource Bgp configuration.") + bgpConfiguration?: BgpConfiguration; + + @doc("proxyUrl configuration of the cache node") + proxyUrlConfiguration?: ProxyUrlConfiguration; + + @doc("Cache node resource Mcc proxy Url") + proxyUrl?: string; + + @doc("Cache node resource requires a proxy") + isProxyRequired?: ProxyRequired; + + @doc("Operating system of the cache node") + osType?: OsType; + + @doc("Update Cycle Type") + updateCycleType?: CycleType; + + @doc("Auto update or fast update version") + autoUpdateVersion?: string; + + @doc("Update related information details") + updateInfoDetails?: string; + + @doc("customer requested date time for mcc install of update cycle") + updateRequestedDateTime?: utcDateTime; + + @doc("Auto update version that is the Next available version to update on mcc cache node") + @visibility("read") + autoUpdateNextAvailableVersion?: string; + + @doc("Auto update last applied date time of mcc install") + @visibility("read") + autoUpdateNextAvailableDateTime?: utcDateTime; + + @doc("Auto update version that is the applied to update on mcc cache node") + @visibility("read") + autoUpdateAppliedVersion?: string; + + @doc("Auto Update status details from the backend after applying the new version details") + @visibility("read") + autoUpdateLastAppliedDetails?: string; + + @doc("Last applied auto update state for mcc install of auto update cycle") + @visibility("read") + autoUpdateLastAppliedState?: string; + + @doc("Auto update last applied date time of mcc install") + @visibility("read") + autoUpdateLastAppliedDateTime?: utcDateTime; + + @doc("Auto update last triggered date time of mcc install") + @visibility("read") + autoUpdateLastTriggeredDateTime?: utcDateTime; + + @doc("Optional property #1 of Mcc response object") + optionalProperty1?: string; + + @doc("Optional property #2 of Mcc response object") + optionalProperty2?: string; + + @doc("Optional property #3 of Mcc response object") + optionalProperty3?: string; + + @doc("Optional property #4 of Mcc response object") + optionalProperty4?: string; + + @doc("Optional property #5 of Mcc response object") + optionalProperty5?: string; +} + +@doc("Drive configuration for cache node") +model CacheNodeDriveConfiguration { + @doc("physical path location of the folder used for caching content") + physicalPath?: string; + + @doc("physical size of the drive used for caching content") + sizeInGb?: int32; + + @doc("corresponding nginx cache number. Valid cache numbers are 1 - 20") + @minValue(1) + @maxValue(20) + cacheNumber?: int32; + + @doc("full binding for corresponding nginx cache drive") + nginxMapping?: string; +} + +@doc("Bgp configuration of cache node") +model BgpConfiguration { + @doc("Asn to ip address mapping") + asnToIpAddressMapping?: string; +} + +@doc("ProxyUrl configuration of cache node") +model ProxyUrlConfiguration { + @doc("Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80") + proxyUrl?: string; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "optional properties" +@doc("Represents all Cidr details of the Bgp request for a specific cache node resource") +model MccCacheNodeBgpCidrDetails + extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Mcc cache node resource Bgp Cidr properties.") + properties?: BgpCidrsConfiguration; +} + +@doc("Mcc cache node Bgp Cidr details.") +model BgpCidrsConfiguration { + @doc("Mcc cache node Bgp Cidr details.") + @visibility("read") + bgpCidrs?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "optional properties" +@doc("Mcc cache node resource all install details.") +model MccCacheNodeInstallDetails + extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Mcc cache node resource install script details.") + properties?: CacheNodeInstallProperties; +} + +@doc("Mcc cache node resource install script properties.") +model CacheNodeInstallProperties { + @doc("Mcc customer resource Id.") + customerId?: string; + + @doc("Mcc cache node resource Id.") + cacheNodeId?: string; + + @doc("Mcc primary account key. Internal to Mcc.") + @visibility("read") + @secret + primaryAccountKey?: string; + + @doc("Mcc secondary account key. Internal to Mcc.") + @visibility("read") + @secret + secondaryAccountKey?: string; + + @doc("Mcc Iot Central temporary device registration key, used once.") + @visibility("read") + @secret + registrationKey?: string; +} diff --git a/specification/connectedcache/ConnectedCache.Management/tspconfig.yaml b/specification/connectedcache/ConnectedCache.Management/tspconfig.yaml new file mode 100644 index 000000000000..444f6e55407f --- /dev/null +++ b/specification/connectedcache/ConnectedCache.Management/tspconfig.yaml @@ -0,0 +1,11 @@ +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ConnectedCache.json" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/ConnectedCache.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/ConnectedCache.json new file mode 100644 index 000000000000..6f710225acff --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/ConnectedCache.json @@ -0,0 +1,3679 @@ +{ + "swagger": "2.0", + "info": { + "title": "ConnectedCache", + "version": "2023-05-01-preview", + "description": "Microsoft Connected Cache Rest Api version 2023-05-01-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "EnterpriseCustomerOperations" + }, + { + "name": "CacheNodesOperations" + }, + { + "name": "IspCustomers" + }, + { + "name": "IspCacheNodesOperations" + }, + { + "name": "EnterpriseMccCustomers" + }, + { + "name": "EnterpriseMccCacheNodesOperations" + } + ], + "paths": { + "/providers/Microsoft.ConnectedCache/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List the operations for the provider - generated by [MaximumSet] rule": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ConnectedCache/cacheNodes": { + "get": { + "operationId": "CacheNodesOperations_ListBySubscription", + "tags": [ + "CacheNodesOperations" + ], + "description": "Retrieves the properties of all ConnectedCaches", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CacheNodePreviewResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CacheNodes Private Preview(Legacy) resource List by Subscription - generated by [MaximumSet] rule": { + "$ref": "./examples/CacheNodesOperations_ListBySubscription_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ConnectedCache/enterpriseCustomers": { + "get": { + "operationId": "EnterpriseCustomerOperations_ListBySubscription", + "tags": [ + "EnterpriseCustomerOperations" + ], + "description": "Retrieves the properties of all ConnectedCaches", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnterprisePreviewResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseCustomerOperations_ListBySubscription": { + "$ref": "./examples/EnterpriseCustomerOperations_ListBySubscription_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers": { + "get": { + "operationId": "EnterpriseMccCustomers_ListBySubscription", + "tags": [ + "EnterpriseMccCustomers" + ], + "description": "This api gets information about all enterpriseMccCustomer resources under the given subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnterpriseMccCustomerResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseMccCustomers_ListBySubscription": { + "$ref": "./examples/EnterpriseMccCustomers_ListBySubscription_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ConnectedCache/ispCustomers": { + "get": { + "operationId": "IspCustomers_ListBySubscription", + "tags": [ + "IspCustomers" + ], + "description": "This api gets information about all ispCustomer resources under the given subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IspCustomerResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ispCustomer List by Subscription - generated by [MaximumSet] rule": { + "$ref": "./examples/IspCustomers_ListBySubscription_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/cacheNodes": { + "get": { + "operationId": "CacheNodesOperations_ListByResourceGroup", + "tags": [ + "CacheNodesOperations" + ], + "description": "Retrieves the properties of all ConnectedCache", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CacheNodePreviewResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CacheNodes Private Preview(Legacy) Get Operation List by Resource group - generated by [MaximumSet] rule": { + "$ref": "./examples/CacheNodesOperations_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/cacheNodes/{customerResourceName}": { + "get": { + "operationId": "CacheNodesOperations_Get", + "tags": [ + "CacheNodesOperations" + ], + "description": "Retrieves the properties of a cacheNodes", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CacheNodePreviewResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CacheNodesOperations_Get": { + "$ref": "./examples/CacheNodesOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "CacheNodesOperations_CreateorUpdate", + "tags": [ + "CacheNodesOperations" + ], + "description": "Creates a cacheNodes with the specified create parameters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CacheNodePreviewResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CacheNodePreviewResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/CacheNodePreviewResource" + } + }, + "201": { + "description": "Resource 'CacheNodePreviewResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/CacheNodePreviewResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CacheNodesOperations_CreateorUpdate": { + "$ref": "./examples/CacheNodesOperations_CreateorUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CacheNodesOperations_Update", + "tags": [ + "CacheNodesOperations" + ], + "description": "updates an existing Cache Node", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedCachePatchResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CacheNodePreviewResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CacheNodes Private Preview(Legacy) Update Operation - generated by [MaximumSet] rule": { + "$ref": "./examples/CacheNodesOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "CacheNodesOperations_Delete", + "tags": [ + "CacheNodesOperations" + ], + "description": "Deletes an existing cache Node", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CacheNodesOperations_Delete": { + "$ref": "./examples/CacheNodesOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseCustomers": { + "get": { + "operationId": "EnterpriseCustomerOperations_ListByResourceGroup", + "tags": [ + "EnterpriseCustomerOperations" + ], + "description": "Retrieves the properties of all ConnectedCache enterpriseCustomers", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnterprisePreviewResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseCustomerOperations_ListByResourceGroup": { + "$ref": "./examples/EnterpriseCustomerOperations_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseCustomers/{customerResourceName}": { + "get": { + "operationId": "EnterpriseCustomerOperations_Get", + "tags": [ + "EnterpriseCustomerOperations" + ], + "description": "Retrieves the properties of a Enterprise customer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnterprisePreviewResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseCustomerOperations_Get": { + "$ref": "./examples/EnterpriseCustomerOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "EnterpriseCustomerOperations_CreateOrUpdate", + "tags": [ + "EnterpriseCustomerOperations" + ], + "description": "Creates a cacheNodes with the specified create parameters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EnterprisePreviewResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EnterprisePreviewResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EnterprisePreviewResource" + } + }, + "201": { + "description": "Resource 'EnterprisePreviewResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EnterprisePreviewResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseCustomerOperations_CreateOrUpdate": { + "$ref": "./examples/EnterpriseCustomerOperations_CreateOrUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EnterpriseCustomerOperations_Update", + "tags": [ + "EnterpriseCustomerOperations" + ], + "description": "updates an existing enterpriseCustomers", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedCachePatchResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnterprisePreviewResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseCustomerOperations_Update": { + "$ref": "./examples/EnterpriseCustomerOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "EnterpriseCustomerOperations_Delete", + "tags": [ + "EnterpriseCustomerOperations" + ], + "description": "Deletes an existing customer Enterprise resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseCustomerOperations_Delete": { + "$ref": "./examples/EnterpriseCustomerOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers": { + "get": { + "operationId": "EnterpriseMccCustomers_ListByResourceGroup", + "tags": [ + "EnterpriseMccCustomers" + ], + "description": "This api gets the information about all enterprise mcc customer resources under the given subscription and resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnterpriseMccCustomerResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseMccCustomers_ListByResourceGroup": { + "$ref": "./examples/EnterpriseMccCustomers_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}": { + "get": { + "operationId": "EnterpriseMccCustomers_Get", + "tags": [ + "EnterpriseMccCustomers" + ], + "description": "Gets the enterprise mcc customer resource information using this get call", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnterpriseMccCustomerResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseMccCustomers_Get": { + "$ref": "./examples/EnterpriseMccCustomers_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "EnterpriseMccCustomers_CreateOrUpdate", + "tags": [ + "EnterpriseMccCustomers" + ], + "description": "This api creates an enterprise mcc customer with the specified create parameters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EnterpriseMccCustomerResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EnterpriseMccCustomerResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EnterpriseMccCustomerResource" + } + }, + "201": { + "description": "Resource 'EnterpriseMccCustomerResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EnterpriseMccCustomerResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseMccCustomers_CreateOrUpdate": { + "$ref": "./examples/EnterpriseMccCustomers_CreateOrUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EnterpriseMccCustomers_Update", + "tags": [ + "EnterpriseMccCustomers" + ], + "description": "This api updates an existing enterprise mcc customer resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedCachePatchResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnterpriseMccCustomerResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseMccCustomers_Update": { + "$ref": "./examples/EnterpriseMccCustomers_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "EnterpriseMccCustomers_Delete", + "tags": [ + "EnterpriseMccCustomers" + ], + "description": "This api deletes an existing enterprise mcc customer resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseMccCustomers_Delete": { + "$ref": "./examples/EnterpriseMccCustomers_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}/enterpriseMccCacheNodes": { + "get": { + "operationId": "EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource", + "tags": [ + "EnterpriseMccCacheNodesOperations" + ], + "description": "This api retrieves information about all ispCacheNode resources under the given subscription and resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnterpriseMccCacheNodeResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource": { + "$ref": "./examples/EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}/enterpriseMccCacheNodes/{cacheNodeResourceName}": { + "get": { + "operationId": "EnterpriseMccCacheNodesOperations_Get", + "tags": [ + "EnterpriseMccCacheNodesOperations" + ], + "description": "This api gets ispCacheNode resource information", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "cacheNodeResourceName", + "in": "path", + "description": "Name of the ConnectedCache resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnterpriseMccCacheNodeResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets enterpriseMccCacheNode resource information of an enterprise mcc customer parent resource - generated by [MaximumSet] rule": { + "$ref": "./examples/EnterpriseMccCacheNodesOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "EnterpriseMccCacheNodesOperations_CreateOrUpdate", + "tags": [ + "EnterpriseMccCacheNodesOperations" + ], + "description": "This api creates an ispCacheNode with the specified create parameters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "cacheNodeResourceName", + "in": "path", + "description": "Name of the ConnectedCache resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EnterpriseMccCacheNodeResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EnterpriseMccCacheNodeResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/EnterpriseMccCacheNodeResource" + } + }, + "201": { + "description": "Resource 'EnterpriseMccCacheNodeResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/EnterpriseMccCacheNodeResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates an enterpriseMccCacheNode resource - generated by [MaximumSet] rule": { + "$ref": "./examples/EnterpriseMccCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EnterpriseMccCacheNodesOperations_Update", + "tags": [ + "EnterpriseMccCacheNodesOperations" + ], + "description": "This api updates an existing ispCacheNode resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "cacheNodeResourceName", + "in": "path", + "description": "Name of the ConnectedCache resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedCachePatchResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnterpriseMccCacheNodeResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseMccCacheNodesOperations Update - generated by [MaximumSet] rule": { + "$ref": "./examples/EnterpriseMccCacheNodesOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "EnterpriseMccCacheNodesOperations_Delete", + "tags": [ + "EnterpriseMccCacheNodesOperations" + ], + "description": "This api deletes an existing ispCacheNode resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "cacheNodeResourceName", + "in": "path", + "description": "Name of the ConnectedCache resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseMccCacheNodesOperations Delete Operation - generated by [MaximumSet] rule": { + "$ref": "./examples/EnterpriseMccCacheNodesOperations_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}/enterpriseMccCacheNodes/{cacheNodeResourceName}/getCacheNodeInstallDetails": { + "post": { + "operationId": "EnterpriseMccCacheNodesOperations_GetCacheNodeInstallDetails", + "tags": [ + "EnterpriseMccCacheNodesOperations" + ], + "description": "This api gets secrets of the ispCacheNode resource install details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "cacheNodeResourceName", + "in": "path", + "description": "Name of the ConnectedCache resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MccCacheNodeInstallDetails" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets required properties for enterprise Mcc CacheNode resource install key details - generated by [MaximumSet] rule": { + "$ref": "./examples/EnterpriseMccCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers": { + "get": { + "operationId": "IspCustomers_ListByResourceGroup", + "tags": [ + "IspCustomers" + ], + "description": "This api gets the information about all ispCustomer resources under the given subscription and resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IspCustomerResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IspCustomers resource List by Resource group - generated by [MaximumSet] rule": { + "$ref": "./examples/IspCustomers_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}": { + "get": { + "operationId": "IspCustomers_Get", + "tags": [ + "IspCustomers" + ], + "description": "Gets the ispCustomer resource information using this get call", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IspCustomerResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IspCustomers Get - generated by [MaximumSet] rule": { + "$ref": "./examples/IspCustomers_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "IspCustomers_CreateOrUpdate", + "tags": [ + "IspCustomers" + ], + "description": "This api creates an ispCustomer with the specified create parameters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IspCustomerResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IspCustomerResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/IspCustomerResource" + } + }, + "201": { + "description": "Resource 'IspCustomerResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/IspCustomerResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ispCustomer CreateOrUpdate - generated by [MaximumSet] rule": { + "$ref": "./examples/IspCustomers_CreateOrUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IspCustomers_Update", + "tags": [ + "IspCustomers" + ], + "description": "This api updates an existing ispCustomer resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedCachePatchResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IspCustomerResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ispCustomer Update details - generated by [MaximumSet] rule": { + "$ref": "./examples/IspCustomers_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "IspCustomers_Delete", + "tags": [ + "IspCustomers" + ], + "description": "This api deletes an existing ispCustomer resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IspCustomers Delete - generated by [MaximumSet] rule": { + "$ref": "./examples/IspCustomers_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes": { + "get": { + "operationId": "IspCacheNodesOperations_ListByIspCustomerResource", + "tags": [ + "IspCacheNodesOperations" + ], + "description": "This api retrieves information about all ispCacheNode resources under the given subscription and resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IspCacheNodeResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IspCacheNodesOperations_ListByIspCustomerResource": { + "$ref": "./examples/IspCacheNodesOperations_ListByIspCustomerResource_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes/{cacheNodeResourceName}": { + "get": { + "operationId": "IspCacheNodesOperations_Get", + "tags": [ + "IspCacheNodesOperations" + ], + "description": "This api gets ispCacheNode resource information", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "cacheNodeResourceName", + "in": "path", + "description": "Name of the ConnectedCache resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IspCacheNodeResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IspCacheNodes Get resource - generated by [MaximumSet] rule": { + "$ref": "./examples/IspCacheNodesOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "IspCacheNodesOperations_CreateOrUpdate", + "tags": [ + "IspCacheNodesOperations" + ], + "description": "This api creates an ispCacheNode with the specified create parameters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "cacheNodeResourceName", + "in": "path", + "description": "Name of the ConnectedCache resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IspCacheNodeResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IspCacheNodeResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/IspCacheNodeResource" + } + }, + "201": { + "description": "Resource 'IspCacheNodeResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/IspCacheNodeResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IspCacheNodesOperations_CreateOrUpdate": { + "$ref": "./examples/IspCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IspCacheNodesOperations_Update", + "tags": [ + "IspCacheNodesOperations" + ], + "description": "This api updates an existing ispCacheNode resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "cacheNodeResourceName", + "in": "path", + "description": "Name of the ConnectedCache resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedCachePatchResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IspCacheNodeResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IspCacheNodesOperations_Update": { + "$ref": "./examples/IspCacheNodesOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "IspCacheNodesOperations_Delete", + "tags": [ + "IspCacheNodesOperations" + ], + "description": "This api deletes an existing ispCacheNode resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "cacheNodeResourceName", + "in": "path", + "description": "Name of the ConnectedCache resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IspCacheNodes delete Operation - generated by [MaximumSet] rule": { + "$ref": "./examples/IspCacheNodesOperations_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes/{cacheNodeResourceName}/getBgpCidrs": { + "post": { + "operationId": "IspCacheNodesOperations_GetBgpCidrs", + "tags": [ + "IspCacheNodesOperations" + ], + "description": "This api gets ispCacheNode resource information", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "cacheNodeResourceName", + "in": "path", + "description": "Name of the ConnectedCache resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MccCacheNodeBgpCidrDetails" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IspCacheNodes resource BgpCidrs details - generated by [MaximumSet] rule": { + "$ref": "./examples/IspCacheNodesOperations_GetBgpCidrs_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes/{cacheNodeResourceName}/getCacheNodeInstallDetails": { + "post": { + "operationId": "IspCacheNodesOperations_GetCacheNodeInstallDetails", + "tags": [ + "IspCacheNodesOperations" + ], + "description": "This api gets secrets of the ispCacheNode resource install details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "customerResourceName", + "in": "path", + "description": "Name of the Customer resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + }, + { + "name": "cacheNodeResourceName", + "in": "path", + "description": "Name of the ConnectedCache resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9\\_\\-]*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MccCacheNodeInstallDetails" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ispCacheNode resource get install details - generated by [MaximumSet] rule": { + "$ref": "./examples/IspCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AdditionalCacheNodeProperties": { + "type": "object", + "description": "Model representing cache node for connected cache resource", + "properties": { + "cacheNodePropertiesDetailsIssuesList": { + "type": "array", + "description": "issues list to return the issues as part of the additional cache node properties", + "items": { + "type": "string" + } + }, + "aggregatedStatusDetails": { + "type": "string", + "description": "Cache node resource aggregated status details.", + "readOnly": true + }, + "aggregatedStatusText": { + "type": "string", + "description": "Cache node resource aggregated status text.", + "readOnly": true + }, + "aggregatedStatusCode": { + "type": "integer", + "format": "int32", + "description": "Cache node resource aggregated status code.", + "readOnly": true + }, + "productVersion": { + "type": "string", + "description": "Cache node resource Mcc product version.", + "readOnly": true + }, + "isProvisioned": { + "type": "boolean", + "description": "Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab.", + "readOnly": true + }, + "cacheNodeStateDetailedText": { + "type": "string", + "description": "Cache node resource detailed state text.", + "readOnly": true + }, + "cacheNodeStateShortText": { + "type": "string", + "description": "Cache node resource short state text.", + "readOnly": true + }, + "cacheNodeState": { + "type": "integer", + "format": "int32", + "description": "Cache node resource state as integer.", + "readOnly": true + }, + "driveConfiguration": { + "type": "array", + "description": "Cache node resource drive configurations.", + "items": { + "$ref": "#/definitions/CacheNodeDriveConfiguration" + }, + "x-ms-identifiers": [] + }, + "bgpConfiguration": { + "$ref": "#/definitions/BgpConfiguration", + "description": "Cache node resource Bgp configuration." + }, + "proxyUrlConfiguration": { + "$ref": "#/definitions/ProxyUrlConfiguration", + "description": "proxyUrl configuration of the cache node" + }, + "proxyUrl": { + "type": "string", + "description": "Cache node resource Mcc proxy Url" + }, + "isProxyRequired": { + "$ref": "#/definitions/ProxyRequired", + "description": "Cache node resource requires a proxy" + }, + "osType": { + "$ref": "#/definitions/OsType", + "description": "Operating system of the cache node" + }, + "updateCycleType": { + "$ref": "#/definitions/CycleType", + "description": "Update Cycle Type" + }, + "autoUpdateVersion": { + "type": "string", + "description": "Auto update or fast update version" + }, + "updateInfoDetails": { + "type": "string", + "description": "Update related information details" + }, + "updateRequestedDateTime": { + "type": "string", + "format": "date-time", + "description": "customer requested date time for mcc install of update cycle" + }, + "autoUpdateNextAvailableVersion": { + "type": "string", + "description": "Auto update version that is the Next available version to update on mcc cache node", + "readOnly": true + }, + "autoUpdateNextAvailableDateTime": { + "type": "string", + "format": "date-time", + "description": "Auto update last applied date time of mcc install", + "readOnly": true + }, + "autoUpdateAppliedVersion": { + "type": "string", + "description": "Auto update version that is the applied to update on mcc cache node", + "readOnly": true + }, + "autoUpdateLastAppliedDetails": { + "type": "string", + "description": "Auto Update status details from the backend after applying the new version details", + "readOnly": true + }, + "autoUpdateLastAppliedState": { + "type": "string", + "description": "Last applied auto update state for mcc install of auto update cycle", + "readOnly": true + }, + "autoUpdateLastAppliedDateTime": { + "type": "string", + "format": "date-time", + "description": "Auto update last applied date time of mcc install", + "readOnly": true + }, + "autoUpdateLastTriggeredDateTime": { + "type": "string", + "format": "date-time", + "description": "Auto update last triggered date time of mcc install", + "readOnly": true + }, + "optionalProperty1": { + "type": "string", + "description": "Optional property #1 of Mcc response object" + }, + "optionalProperty2": { + "type": "string", + "description": "Optional property #2 of Mcc response object" + }, + "optionalProperty3": { + "type": "string", + "description": "Optional property #3 of Mcc response object" + }, + "optionalProperty4": { + "type": "string", + "description": "Optional property #4 of Mcc response object" + }, + "optionalProperty5": { + "type": "string", + "description": "Optional property #5 of Mcc response object" + } + } + }, + "AdditionalCustomerProperties": { + "type": "object", + "description": "Model representing customer for connected cache resource", + "properties": { + "peeringDbLastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "Customer resource last PeeringDB update timestamp.", + "readOnly": true + }, + "customerPropertiesOverviewCacheEfficiency": { + "type": "number", + "format": "float", + "description": "Customer resource cache efficiency.", + "readOnly": true + }, + "customerPropertiesOverviewAverageEgressMbps": { + "type": "number", + "format": "float", + "description": "Customer resource average egress in Mbps.", + "readOnly": true + }, + "customerPropertiesOverviewAverageMissMbps": { + "type": "number", + "format": "float", + "description": "Customer resource average cache miss throughput in Mbps.", + "readOnly": true + }, + "customerPropertiesOverviewEgressMbpsMax": { + "type": "number", + "format": "float", + "description": "Customer resource maximum egress in Mbps.", + "readOnly": true + }, + "customerPropertiesOverviewEgressMbpsMaxDateTime": { + "type": "string", + "format": "date-time", + "description": "Customer resource peak egress timestamp.", + "readOnly": true + }, + "customerPropertiesOverviewMissMbpsMax": { + "type": "number", + "format": "float", + "description": "Customer resource maximum cache miss throughput in Mbps.", + "readOnly": true + }, + "customerPropertiesOverviewMissMbpsMaxDateTime": { + "type": "string", + "format": "date-time", + "description": "Customer resource peak cache miss throughput timestamp.", + "readOnly": true + }, + "customerPropertiesOverviewCacheNodesHealthyCount": { + "type": "integer", + "format": "int32", + "description": "Customer resource total healthy cache nodes.", + "readOnly": true + }, + "customerPropertiesOverviewCacheNodesUnhealthyCount": { + "type": "integer", + "format": "int32", + "description": "Customer resource total unhealthy cache nodes.", + "readOnly": true + }, + "signupStatus": { + "type": "boolean", + "description": "Customer resource signup status as boolean.", + "readOnly": true + }, + "signupStatusCode": { + "type": "integer", + "format": "int32", + "description": "Customer resource signup status as integer code.", + "readOnly": true + }, + "signupStatusText": { + "type": "string", + "description": "Customer resource signup status as string text.", + "readOnly": true + }, + "signupPhaseStatusCode": { + "type": "integer", + "format": "int32", + "description": "Customer resource signup phase status code as integer.", + "readOnly": true + }, + "signupPhaseStatusText": { + "type": "string", + "description": "Customer resource signup phase status as string text.", + "readOnly": true + }, + "peeringDbLastUpdateDate": { + "type": "string", + "format": "date-time", + "description": "Customer resource last PeeringDB update timestamp.", + "readOnly": true + }, + "customerOrgName": { + "type": "string", + "description": "Customer resource owner organization name.", + "readOnly": true + }, + "customerEmail": { + "type": "string", + "description": "Customer resource contact email." + }, + "customerTransitAsn": { + "type": "string", + "description": "Customer resource transit Asn (autonomous system number)." + }, + "customerTransitState": { + "$ref": "#/definitions/CustomerTransitState", + "description": "Customer resource transit state." + }, + "customerAsn": { + "type": "string", + "description": "Customer resource Asn (autonomous system number)." + }, + "customerAsnEstimatedEgressPeekGbps": { + "type": "number", + "format": "float", + "description": "Customer resource estimated Asn peering peak in Gbps.", + "readOnly": true + }, + "customerEntitlementSkuId": { + "type": "string", + "description": "Customer resource entitlement Sku Id." + }, + "customerEntitlementSkuGuid": { + "type": "string", + "description": "Customer resource entitlement Sku Guid." + }, + "customerEntitlementSkuName": { + "type": "string", + "description": "Customer resource entitlement Sku name." + }, + "customerEntitlementExpiration": { + "type": "string", + "format": "date-time", + "description": "Customer resource entitlement expiration date string." + }, + "optionalProperty1": { + "type": "string", + "description": "Optional property #1 of Mcc response object." + }, + "optionalProperty2": { + "type": "string", + "description": "Optional property #2 of Mcc response object." + }, + "optionalProperty3": { + "type": "string", + "description": "Optional property #3 of Mcc response object." + }, + "optionalProperty4": { + "type": "string", + "description": "Optional property #4 of Mcc response object." + }, + "optionalProperty5": { + "type": "string", + "description": "Optional property #5 of Mcc response object." + } + } + }, + "BgpCidrsConfiguration": { + "type": "object", + "description": "Mcc cache node Bgp Cidr details.", + "properties": { + "bgpCidrs": { + "type": "array", + "description": "Mcc cache node Bgp Cidr details.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "BgpConfiguration": { + "type": "object", + "description": "Bgp configuration of cache node", + "properties": { + "asnToIpAddressMapping": { + "type": "string", + "description": "Asn to ip address mapping" + } + } + }, + "BgpReviewStateEnum": { + "type": "string", + "description": "Cache node resource Bgp review state as integer", + "enum": [ + "NotConfigured", + "InReview", + "Approved", + "AttentionRequired" + ], + "x-ms-enum": { + "name": "BgpReviewStateEnum", + "modelAsString": true, + "values": [ + { + "name": "NotConfigured", + "value": "NotConfigured", + "description": "bgp not configured" + }, + { + "name": "InReview", + "value": "InReview", + "description": "bgp is in review state" + }, + { + "name": "Approved", + "value": "Approved", + "description": "bgp is in Approved state" + }, + { + "name": "AttentionRequired", + "value": "AttentionRequired", + "description": "bgp is setup need an attention for more troubleshoot" + } + ] + } + }, + "CacheNodeDriveConfiguration": { + "type": "object", + "description": "Drive configuration for cache node", + "properties": { + "physicalPath": { + "type": "string", + "description": "physical path location of the folder used for caching content" + }, + "sizeInGb": { + "type": "integer", + "format": "int32", + "description": "physical size of the drive used for caching content" + }, + "cacheNumber": { + "type": "integer", + "format": "int32", + "description": "corresponding nginx cache number. Valid cache numbers are 1 - 20", + "minimum": 1, + "maximum": 20 + }, + "nginxMapping": { + "type": "string", + "description": "full binding for corresponding nginx cache drive" + } + } + }, + "CacheNodeEntity": { + "type": "object", + "description": "Model representing Cache Node for ConnectedCache resource", + "properties": { + "fullyQualifiedResourceId": { + "type": "string", + "description": "Cache node resource Azure fully qualified resource Id." + }, + "customerId": { + "type": "string", + "description": "Cache node resource customer resource GUID Id.", + "readOnly": true + }, + "customerName": { + "type": "string", + "description": "Cache node resource customer resource name." + }, + "ipAddress": { + "type": "string", + "description": "Cache node resource Ip address." + }, + "customerIndex": { + "type": "string", + "description": "Cache node resource customer index as string." + }, + "cacheNodeId": { + "type": "string", + "description": "Cache node resource identifier of the cache node" + }, + "cacheNodeName": { + "type": "string", + "description": "Cache node resource name." + }, + "customerAsn": { + "type": "integer", + "format": "int32", + "description": "Cache node resource customer resource Asn (autonomous system number)" + }, + "isEnabled": { + "type": "boolean", + "description": "Cache node resource flag for indicating if cache node is enabled." + }, + "maxAllowableEgressInMbps": { + "type": "integer", + "format": "int32", + "description": "Cache node resource maximum allowed egress in Mbps." + }, + "maxAllowableProbability": { + "type": "number", + "format": "float", + "description": "Cache node resource maximum allowed probability of egress.", + "readOnly": true + }, + "xCid": { + "type": "string", + "description": "Cache node resource Azure XCid.", + "readOnly": true + }, + "isEnterpriseManaged": { + "type": "boolean", + "description": "Cache node resource flag for determining if managed by enterprise as boolean." + }, + "createAsyncOperationId": { + "type": "string", + "description": "Cache node resource create async operation Id.", + "readOnly": true + }, + "deleteAsyncOperationId": { + "type": "string", + "description": "Cache node resource deletion async operation Id.", + "readOnly": true + }, + "clientTenantId": { + "type": "string", + "description": "Cache node resource customer resource client tenant Id of subscription.", + "readOnly": true + }, + "category": { + "type": "string", + "description": "Cache node resource category.", + "readOnly": true + }, + "releaseVersion": { + "type": "integer", + "format": "int32", + "description": "Cache node resource release version.", + "readOnly": true + }, + "lastSyncWithAzureTimestamp": { + "type": "string", + "format": "date-time", + "description": "Cache node resource last sync timestamp.", + "readOnly": true + }, + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Cache node resource last backend updated timestamp.", + "readOnly": true + }, + "synchWithAzureAttemptsCount": { + "type": "integer", + "format": "int32", + "description": "Cache node resource attempts to sync with Azure.", + "readOnly": true + }, + "containerConfigurations": { + "type": "string", + "description": "Cache node resource container configuration details.", + "readOnly": true + }, + "cidrCsv": { + "type": "array", + "description": "Cache node resource comma separated values of Cidrs.", + "items": { + "type": "string" + } + }, + "cidrCsvLastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "Cache node resource last Cidr Csv update timestamp", + "readOnly": true + }, + "bgpCidrCsvLastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "Cache node resource last Bgp Cidr Csv update timestamp", + "readOnly": true + }, + "bgpLastReportedTime": { + "type": "string", + "format": "date-time", + "description": "Cache node resource last Bgp report timestamp.", + "readOnly": true + }, + "bgpReviewStateText": { + "type": "string", + "description": "Cache node resource Bgp review state string text in detail.", + "readOnly": true + }, + "bgpReviewState": { + "$ref": "#/definitions/BgpReviewStateEnum", + "description": "Cache node resource Bgp review state string text.", + "readOnly": true + }, + "bgpReviewFeedback": { + "type": "string", + "description": "Cache node resource Bgp review feedback text.", + "readOnly": true + }, + "bgpNumberOfTimesUpdated": { + "type": "integer", + "format": "int32", + "description": "Cache node resource Bgp update count.", + "readOnly": true + }, + "bgpNumberOfRecords": { + "type": "integer", + "format": "int32", + "description": "Cache node resource Bgp record count.", + "readOnly": true + }, + "bgpCidrBlocksCount": { + "type": "integer", + "format": "int32", + "description": "Cache node resource Bgp block count.", + "readOnly": true + }, + "bgpAddressSpace": { + "type": "integer", + "format": "int32", + "description": "Cache node resource total addressable space defined by Bgp and Cidr Csv blocks.", + "readOnly": true + }, + "shouldMigrate": { + "type": "boolean", + "description": "Cache node resource flag for determining if customer will be migrated." + }, + "bgpFileBytesTruncated": { + "type": "integer", + "format": "int32", + "description": "Cache node resource bytes truncated from Bgp output file.", + "readOnly": true + }, + "cidrSelectionType": { + "type": "integer", + "format": "int32", + "description": "Cache node resource current Cidr range precedence selection type." + }, + "isFrozen": { + "type": "boolean", + "description": "Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI).", + "readOnly": true + }, + "reviewState": { + "type": "integer", + "format": "int32", + "description": "Cache node resource review process state as integer", + "readOnly": true + }, + "reviewStateText": { + "type": "string", + "description": "Cache node resource review state text.", + "readOnly": true + }, + "reviewFeedback": { + "type": "string", + "description": "Cache node resource review feedback text.", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Cache node resource configuration state.", + "readOnly": true + }, + "configurationStateText": { + "type": "string", + "description": "Cache node resource configuration state text.", + "readOnly": true + }, + "addressSpace": { + "type": "integer", + "format": "int32", + "description": "Cache node resource total addressable space defined by the Cidr Csv block.", + "readOnly": true + }, + "workerConnections": { + "type": "integer", + "format": "int32", + "description": "Cache node resource Mcc container deployment worker connection count.", + "readOnly": true + }, + "workerConnectionsLastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "Cache node resource last updated Mcc container deployment worker connection count timestamp.", + "readOnly": true + }, + "containerResyncTrigger": { + "type": "integer", + "format": "int32", + "description": "Cache node resource Mcc container configuration details re-sync trigger.", + "readOnly": true + }, + "imageUri": { + "type": "string", + "description": "Cache node resource Mcc Container Id Uri.", + "readOnly": true + }, + "fullyQualifiedDomainName": { + "type": "string", + "description": "FQDN(fully qualified domain name) value of the mcc cache node" + }, + "autoUpdateRingType": { + "$ref": "#/definitions/autoUpdateRingType", + "description": "Auto Update Ring Type which is slow or fast etc." + }, + "autoUpdateRequestedWeek": { + "type": "integer", + "format": "int32", + "description": "Customer requested week of month for mcc install of auto update cycle", + "minimum": 1, + "maximum": 5 + }, + "autoUpdateRequestedDay": { + "type": "integer", + "format": "int32", + "description": "Customer requested day of week for mcc install of auto update cycle", + "minimum": 1, + "maximum": 7 + }, + "autoUpdateRequestedTime": { + "type": "string", + "description": "Customer requested time of the day for mcc install of auto update cycle, should be hh:mm", + "pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$" + } + } + }, + "CacheNodeInstallProperties": { + "type": "object", + "description": "Mcc cache node resource install script properties.", + "properties": { + "customerId": { + "type": "string", + "description": "Mcc customer resource Id." + }, + "cacheNodeId": { + "type": "string", + "description": "Mcc cache node resource Id." + }, + "primaryAccountKey": { + "type": "string", + "format": "password", + "description": "Mcc primary account key. Internal to Mcc.", + "readOnly": true, + "x-ms-secret": true + }, + "secondaryAccountKey": { + "type": "string", + "format": "password", + "description": "Mcc secondary account key. Internal to Mcc.", + "readOnly": true, + "x-ms-secret": true + }, + "registrationKey": { + "type": "string", + "format": "password", + "description": "Mcc Iot Central temporary device registration key, used once.", + "readOnly": true, + "x-ms-secret": true + } + } + }, + "CacheNodeOldResponse": { + "type": "object", + "description": "Model representing Cache Node for ConnectedCache resource", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioned state of the resource", + "readOnly": true + }, + "statusCode": { + "type": "string", + "description": "statusCode used to get code details of Mcc response object" + }, + "statusText": { + "type": "string", + "description": "statusText used to get status details in string format of Mcc response object" + }, + "statusDetails": { + "type": "string", + "description": "statusDetails used to get inner details of Mcc response object" + }, + "status": { + "type": "string", + "description": "status of the HTTP error code", + "readOnly": true + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error details" + } + } + }, + "CacheNodePreviewResource": { + "type": "object", + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/CacheNodeOldResponse", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CacheNodePreviewResourceListResult": { + "type": "object", + "description": "The response of a CacheNodePreviewResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CacheNodePreviewResource items on this page", + "items": { + "$ref": "#/definitions/CacheNodePreviewResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CacheNodeProperty": { + "type": "object", + "description": "Model representing an Mcc cache node connectedCache resource", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioned state of the resource", + "readOnly": true + }, + "cacheNode": { + "$ref": "#/definitions/CacheNodeEntity", + "description": "Mcc cache node resource (cache node entity)." + }, + "additionalCacheNodeProperties": { + "$ref": "#/definitions/AdditionalCacheNodeProperties", + "description": "Mcc cache node resource additional properties." + }, + "statusCode": { + "type": "string", + "description": "Mcc response status code." + }, + "statusText": { + "type": "string", + "description": "Mcc response status text as string for retrieving status details." + }, + "statusDetails": { + "type": "string", + "description": "Mcc response status details for retrieving response inner details." + }, + "status": { + "type": "string", + "description": "HTTP error status code.", + "readOnly": true + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "Mcc response error details." + } + } + }, + "ConfigurationState": { + "type": "string", + "description": "Cache node configuration setup state", + "enum": [ + "Configured", + "NotConfigured_Ip" + ], + "x-ms-enum": { + "name": "ConfigurationState", + "modelAsString": true, + "values": [ + { + "name": "Configured", + "value": "Configured", + "description": "connected cache setup configured" + }, + { + "name": "NotConfigured_Ip", + "value": "NotConfigured_Ip", + "description": "connected cache setup not configured" + } + ] + } + }, + "ConnectedCachePatchResource": { + "type": "object", + "description": "Mcc PATCH operation properties.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update" + ] + } + } + }, + "CustomerEntity": { + "type": "object", + "description": "Model representing Customer resource for ConnectedCache resource", + "properties": { + "fullyQualifiedResourceId": { + "type": "string", + "description": "Customer resource Azure fully qualified resource Id." + }, + "customerId": { + "type": "string", + "description": "Customer resource Guid Id.", + "readOnly": true + }, + "customerName": { + "type": "string", + "description": "Customer resource name." + }, + "contactEmail": { + "type": "string", + "description": "Customer resource contact email." + }, + "contactPhone": { + "type": "string", + "description": "Customer resource contact phone." + }, + "contactName": { + "type": "string", + "description": "Customer resource contact full name." + }, + "isEntitled": { + "type": "boolean", + "description": "Customer resource entitlement flag as boolean." + }, + "releaseVersion": { + "type": "integer", + "format": "int32", + "description": "Customer resource Mcc release version." + }, + "createAsyncOperationId": { + "type": "string", + "description": "Customer resource create async operation Id.", + "readOnly": true + }, + "deleteAsyncOperationId": { + "type": "string", + "description": "Customer resource deletion async operation Id.", + "readOnly": true + }, + "clientTenantId": { + "type": "string", + "description": "Customer resource client tenant Id of subscription." + }, + "synchWithAzureAttemptsCount": { + "type": "integer", + "format": "int32", + "description": "Customer resource sync attempts.", + "readOnly": true + }, + "lastSyncWithAzureTimestamp": { + "type": "string", + "format": "date-time", + "description": "Customer resource last Azure sync timestamp.", + "readOnly": true + }, + "isEnterpriseManaged": { + "type": "boolean", + "description": "Customer resource flag for enterprise management as boolean." + }, + "shouldMigrate": { + "type": "boolean", + "description": "Customer resource flag for migration." + }, + "resendSignupCode": { + "type": "boolean", + "description": "Customer resource flag for resending signup code as boolean." + }, + "verifySignupCode": { + "type": "boolean", + "description": "Customer resource flag for requiring verification of signup code as boolean." + }, + "verifySignupPhrase": { + "type": "string", + "format": "password", + "description": "Customer resource phrase for verifying signup.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + } + } + }, + "CustomerProperty": { + "type": "object", + "description": "Model representing customer for connectedCache resource", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioned state of the resource", + "readOnly": true + }, + "customer": { + "$ref": "#/definitions/CustomerEntity", + "description": "Mcc customer resource (customer entity)." + }, + "additionalCustomerProperties": { + "$ref": "#/definitions/AdditionalCustomerProperties", + "description": "Mcc customer resource additional properties." + }, + "statusCode": { + "type": "string", + "description": "Mcc response status code.", + "readOnly": true + }, + "statusText": { + "type": "string", + "description": "Mcc response status text as string for retrieving status details.", + "readOnly": true + }, + "statusDetails": { + "type": "string", + "description": "Mcc response status details for retrieving response inner details.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "HTTP error status code.", + "readOnly": true + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "Mcc response error details.", + "readOnly": true + } + } + }, + "CustomerTransitState": { + "type": "string", + "description": "Customer resource transit states", + "enum": [ + "NoTransit", + "CombinedTransit", + "TransitOnly" + ], + "x-ms-enum": { + "name": "CustomerTransitState", + "modelAsString": true, + "values": [ + { + "name": "NoTransit", + "value": "NoTransit", + "description": "do not have transit" + }, + { + "name": "CombinedTransit", + "value": "CombinedTransit", + "description": "transit provider and have own subscribers" + }, + { + "name": "TransitOnly", + "value": "TransitOnly", + "description": "pure transit provider or network service provider" + } + ] + } + }, + "CycleType": { + "type": "string", + "description": "Update Cycle type", + "enum": [ + "Preview", + "Slow", + "Fast" + ], + "x-ms-enum": { + "name": "CycleType", + "modelAsString": true, + "values": [ + { + "name": "Preview", + "value": "Preview", + "description": "customer selection of preview update install mcc on their physical vm" + }, + { + "name": "Slow", + "value": "Slow", + "description": "customer selection of slow update to install mcc on their physical vm" + }, + { + "name": "Fast", + "value": "Fast", + "description": "customer selection of fast / auto update to install mcc on their physical vm" + } + ] + } + }, + "EnterpriseMccCacheNodeResource": { + "type": "object", + "description": "Represents the high level Nodes needed to provision cache node resources", + "properties": { + "properties": { + "$ref": "#/definitions/CacheNodeProperty", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EnterpriseMccCacheNodeResourceListResult": { + "type": "object", + "description": "The response of a EnterpriseMccCacheNodeResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EnterpriseMccCacheNodeResource items on this page", + "items": { + "$ref": "#/definitions/EnterpriseMccCacheNodeResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EnterpriseMccCustomerResource": { + "type": "object", + "description": "Represents the high level Nodes needed to provision customer resources", + "properties": { + "properties": { + "$ref": "#/definitions/CustomerProperty", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EnterpriseMccCustomerResourceListResult": { + "type": "object", + "description": "The response of a EnterpriseMccCustomerResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EnterpriseMccCustomerResource items on this page", + "items": { + "$ref": "#/definitions/EnterpriseMccCustomerResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EnterprisePreviewResource": { + "type": "object", + "description": "ConnectedCache Resource. Represents the high level Nodes needed to provision CacheNode and customer resources used in private preview", + "properties": { + "properties": { + "$ref": "#/definitions/CacheNodeOldResponse", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EnterprisePreviewResourceListResult": { + "type": "object", + "description": "The response of a EnterprisePreviewResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EnterprisePreviewResource items on this page", + "items": { + "$ref": "#/definitions/EnterprisePreviewResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IspCacheNodeResource": { + "type": "object", + "description": "Represents the high level Nodes needed to provision cache node resources", + "properties": { + "properties": { + "$ref": "#/definitions/CacheNodeProperty", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IspCacheNodeResourceListResult": { + "type": "object", + "description": "The response of a IspCacheNodeResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IspCacheNodeResource items on this page", + "items": { + "$ref": "#/definitions/IspCacheNodeResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IspCustomerResource": { + "type": "object", + "description": "Represents the high level Nodes needed to provision isp customer resources", + "properties": { + "properties": { + "$ref": "#/definitions/CustomerProperty", + "description": "The resource-specific properties for this resource.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IspCustomerResourceListResult": { + "type": "object", + "description": "The response of a IspCustomerResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IspCustomerResource items on this page", + "items": { + "$ref": "#/definitions/IspCustomerResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MccCacheNodeBgpCidrDetails": { + "type": "object", + "description": "Represents all Cidr details of the Bgp request for a specific cache node resource", + "properties": { + "properties": { + "$ref": "#/definitions/BgpCidrsConfiguration", + "description": "Mcc cache node resource Bgp Cidr properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "MccCacheNodeInstallDetails": { + "type": "object", + "description": "Mcc cache node resource all install details.", + "properties": { + "properties": { + "$ref": "#/definitions/CacheNodeInstallProperties", + "description": "Mcc cache node resource install script details." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "OsType": { + "type": "string", + "description": "Operating System of the cache node", + "enum": [ + "Windows", + "Linux", + "Eflow" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "cache node installs on windows operating system" + }, + { + "name": "Linux", + "value": "Linux", + "description": "cache node installs on Linux Operating system" + }, + { + "name": "Eflow", + "value": "Eflow", + "description": "cache node installs on Azure Eflow" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "provisioning state of the resource", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Unknown", + "Accepted", + "Upgrading", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "unknown state of the provisioning state" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Accepted state of the provisioning state during the Async Operations" + }, + { + "name": "Upgrading", + "value": "Upgrading", + "description": "Upgrading state of the provisioning state" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deleting state of the provisioning state" + } + ] + }, + "readOnly": true + }, + "ProxyRequired": { + "type": "string", + "description": "Proxy details enum", + "enum": [ + "None", + "Required" + ], + "x-ms-enum": { + "name": "ProxyRequired", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Proxy is not required in setup" + }, + { + "name": "Required", + "value": "Required", + "description": "proxy is required in setup" + } + ] + } + }, + "ProxyUrlConfiguration": { + "type": "object", + "description": "ProxyUrl configuration of cache node", + "properties": { + "proxyUrl": { + "type": "string", + "description": "Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80" + } + } + }, + "autoUpdateRingType": { + "type": "string", + "description": "Auto update Ring type", + "enum": [ + "Preview", + "Slow", + "Fast" + ], + "x-ms-enum": { + "name": "autoUpdateRingType", + "modelAsString": true, + "values": [ + { + "name": "Preview", + "value": "Preview", + "description": "customer selection of preview update install mcc on their physical vm" + }, + { + "name": "Slow", + "value": "Slow", + "description": "customer selection of slow update to install mcc on their physical vm" + }, + { + "name": "Fast", + "value": "Fast", + "description": "customer selection of fast / auto update to install mcc on their physical vm" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_CreateorUpdate_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_CreateorUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..20f7d4479167 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_CreateorUpdate_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "CacheNodesOperations_CreateorUpdate", + "operationId": "CacheNodesOperations_CreateorUpdate", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "lwrsyhvfpcfrwrim", + "resource": { + "location": "westus", + "properties": { + "statusCode": "movtzupooyhdqk", + "statusText": "bjnsrpzaofjntleoesjwammgbi", + "statusDetails": "quuziibkwtgf", + "error": {} + }, + "tags": { + "key8256": "oreqiywrjkmate" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "movtzupooyhdqk", + "statusText": "bjnsrpzaofjntleoesjwammgbi", + "statusDetails": "quuziibkwtgf", + "status": "vxwmuwtqimapfw", + "error": { + "code": "dzxbdigdjbdbdclvxkxmfutgcbjf", + "message": "ifabxmzinicoximnsjkmhdpdgkw", + "details": [] + } + }, + "tags": { + "key8256": "oreqiywrjkmate" + }, + "systemData": { + "createdBy": "yqwxlhphavoggkcwg", + "createdByType": "User", + "createdAt": "2024-01-31T00:19:33.838Z", + "lastModifiedBy": "knekx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-31T00:19:33.838Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "movtzupooyhdqk", + "statusText": "bjnsrpzaofjntleoesjwammgbi", + "statusDetails": "quuziibkwtgf", + "status": "vxwmuwtqimapfw", + "error": { + "code": "dzxbdigdjbdbdclvxkxmfutgcbjf", + "message": "ifabxmzinicoximnsjkmhdpdgkw", + "details": [] + } + }, + "tags": { + "key8256": "oreqiywrjkmate" + }, + "systemData": { + "createdBy": "yqwxlhphavoggkcwg", + "createdByType": "User", + "createdAt": "2024-01-31T00:19:33.838Z", + "lastModifiedBy": "knekx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-31T00:19:33.838Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_Delete_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..38ee5bb25e0d --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "CacheNodesOperations_Delete", + "operationId": "CacheNodesOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "otvtvhmovthjwzjzbsqkbnmpcmmeianpqxmmaspvdczmrenquxigrtuarmlcmvsnaclhcbw" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_Get_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..38f8f3fa5f1f --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "CacheNodesOperations_Get", + "operationId": "CacheNodesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "nqoxkgorhuzbhjwcegymzqbeydzjupemekt" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "movtzupooyhdqk", + "statusText": "bjnsrpzaofjntleoesjwammgbi", + "statusDetails": "quuziibkwtgf", + "status": "vxwmuwtqimapfw", + "error": { + "code": "dzxbdigdjbdbdclvxkxmfutgcbjf", + "message": "ifabxmzinicoximnsjkmhdpdgkw", + "details": [] + } + }, + "tags": { + "key8256": "oreqiywrjkmate" + }, + "systemData": { + "createdBy": "yqwxlhphavoggkcwg", + "createdByType": "User", + "createdAt": "2024-01-31T00:19:33.838Z", + "lastModifiedBy": "knekx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-31T00:19:33.838Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_ListByResourceGroup_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..0c810c9aead4 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "CacheNodes Private Preview(Legacy) Get Operation List by Resource group - generated by [MaximumSet] rule", + "operationId": "CacheNodesOperations_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4711": "zfrkvxymuupxgxrkkmbm" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest1", + "name": "MCCTPTest1", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "gtqfmwgkfp", + "statusText": "ztbgggsdeihkputd", + "statusDetails": "odhpdelbuqrfkiaolqrrzpdaokctz", + "status": "mobullauhrxnpyocr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key8585": "jgoeqypqcf" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_ListBySubscription_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..38869c7627a8 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "title": "CacheNodes Private Preview(Legacy) resource List by Subscription - generated by [MaximumSet] rule", + "operationId": "CacheNodesOperations_ListBySubscription", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4711": "zfrkvxymuupxgxrkkmbm" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest1", + "name": "MCCTPTest1", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "gtqfmwgkfp", + "statusText": "ztbgggsdeihkputd", + "statusDetails": "odhpdelbuqrfkiaolqrrzpdaokctz", + "status": "mobullauhrxnpyocr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key8585": "jgoeqypqcf" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_Update_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..2eeb25d5728f --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/CacheNodesOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "CacheNodes Private Preview(Legacy) Update Operation - generated by [MaximumSet] rule", + "operationId": "CacheNodesOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "wlrwpdbcv", + "properties": { + "tags": { + "key5032": "esiuyjbpcwkpqriqiqztxuocv" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/cacheNodes/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/cacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "statusCode": "movtzupooyhdqk", + "statusText": "bjnsrpzaofjntleoesjwammgbi", + "statusDetails": "quuziibkwtgf", + "status": "vxwmuwtqimapfw", + "error": { + "code": "dzxbdigdjbdbdclvxkxmfutgcbjf", + "message": "ifabxmzinicoximnsjkmhdpdgkw", + "details": [] + } + }, + "tags": { + "key8256": "oreqiywrjkmate" + }, + "systemData": { + "createdBy": "yqwxlhphavoggkcwg", + "createdByType": "User", + "createdAt": "2024-01-31T00:19:33.838Z", + "lastModifiedBy": "knekx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-31T00:19:33.838Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_CreateOrUpdate_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..2863d0970d96 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "EnterpriseCustomerOperations_CreateOrUpdate", + "operationId": "EnterpriseCustomerOperations_CreateOrUpdate", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "l", + "resource": { + "properties": { + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "error": {} + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "zdzhhkjyogrqxwihkifnmeyhwpujbr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/enterpriseCustomers", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/enterpriseCustomers", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_Delete_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..b976232493c5 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "EnterpriseCustomerOperations_Delete", + "operationId": "EnterpriseCustomerOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "jeubxmhiaihcusgnahblvvckbdcetacvqgwbohlrqucodtlwuyefpejskvamgrdnwgucziodcfpjhqy" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_Get_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..80f8f49bc403 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "EnterpriseCustomerOperations_Get", + "operationId": "EnterpriseCustomerOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MCCTPTest2" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/enterpriseCustomers", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_ListByResourceGroup_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..609a175091bc --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "EnterpriseCustomerOperations_ListByResourceGroup", + "operationId": "EnterpriseCustomerOperations_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/enterpriseCustomers", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_ListBySubscription_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..7ab27fb6502f --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "EnterpriseCustomerOperations_ListBySubscription", + "operationId": "EnterpriseCustomerOperations_ListBySubscription", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/enterpriseCustomers", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_Update_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..dfe8a55b1e8f --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseCustomerOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "EnterpriseCustomerOperations_Update", + "operationId": "EnterpriseCustomerOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MCCTPTest2", + "properties": { + "tags": { + "key1653": "nzjczrhclhkndesgy" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "statusCode": "oldkroffqtkryqffpsi", + "statusText": "bs", + "statusDetails": "lhwvcz", + "status": "jurqdrxfpowdz", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4215": "zjbszvlzf" + }, + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/enterpriseCustomers", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..128155bd48e9 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,296 @@ +{ + "title": "Creates an enterpriseMccCacheNode resource - generated by [MaximumSet] rule", + "operationId": "EnterpriseMccCacheNodesOperations_CreateOrUpdate", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "nhdkvstdrrtsxxuz", + "cacheNodeResourceName": "fgduqdovidpemlnmhelomffuafdrbgaasqznvrdkbvspfzsnrhncdtqquhijhdpwyzwleukqldpceyxqhqlftqrr", + "resource": { + "location": "westus", + "properties": { + "cacheNode": { + "fullyQualifiedResourceId": "yeinlleavzbehelhsucb", + "customerName": "zsklcocjfjhkcpmzyefzkwamdzc", + "ipAddress": "gbfkdhloyphnpnhemwrcrxlk", + "customerIndex": "vafvezmelfgmjsrccjukrhppljvipg", + "cacheNodeId": "fmrjefyddfn", + "cacheNodeName": "qppvqxliajjfoalzjbgmxggr", + "customerAsn": 25, + "isEnabled": true, + "maxAllowableEgressInMbps": 27, + "isEnterpriseManaged": true, + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "shouldMigrate": true, + "cidrSelectionType": 11 + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "lgljxmyyoakw", + "additionalCacheNodeProperties": { + "cacheNodePropertiesDetailsIssuesList": [ + "ennbzfpuszgalzpawmwicaofqcwcj" + ], + "driveConfiguration": [ + { + "physicalPath": "pcbkezoofhamkycot", + "sizeInGb": 14, + "cacheNumber": 11, + "nginxMapping": "cirlpkpuxg" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "fjbggfvumrn" + }, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "ihkzxlzvpcywtzrogupqozkdud", + "optionalProperty1": "ph", + "optionalProperty2": "soqqgpgcbhb", + "optionalProperty3": "fpnycrbagptsujiotnjfuhlm", + "optionalProperty4": "gesqugrxvhxlxxyvatgrautxwlmxsf", + "optionalProperty5": "zknjgzpaqtvdqjydd" + }, + "error": {} + }, + "tags": { + "key259": "qbkixjuyjkoj" + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DOTest/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "yeinlleavzbehelhsucb", + "customerId": "xjjgcknmsakfawcmwbdufdxktysp", + "customerName": "zsklcocjfjhkcpmzyefzkwamdzc", + "ipAddress": "gbfkdhloyphnpnhemwrcrxlk", + "customerIndex": "vafvezmelfgmjsrccjukrhppljvipg", + "cacheNodeId": "fmrjefyddfn", + "cacheNodeName": "qppvqxliajjfoalzjbgmxggr", + "customerAsn": 25, + "isEnabled": true, + "maxAllowableEgressInMbps": 27, + "maxAllowableProbability": 12, + "xCid": "ooyrhuockukmsrqsevwaaqglhf", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "tvmivvnpisuboggoqgbobugld", + "clientTenantId": "iwrpakllacxvtqygpaimlpxvqrjz", + "category": "utfjefejkrpxcmrgygzawa", + "releaseVersion": 29, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 4, + "containerConfigurations": "dyvefvbvrtsmdrdmiuphzh", + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.774Z", + "bgpReviewStateText": "khtriksrqrjieouoz", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "bc", + "bgpNumberOfTimesUpdated": 23, + "bgpNumberOfRecords": 25, + "bgpCidrBlocksCount": 28, + "bgpAddressSpace": 30, + "shouldMigrate": true, + "bgpFileBytesTruncated": 26, + "cidrSelectionType": 11, + "isFrozen": true, + "reviewState": 2, + "reviewStateText": "xubwhyrdtramrmoldbxqwauyusymqu", + "reviewFeedback": "zowuztcnybt", + "configurationState": "Configured", + "configurationStateText": "okbofqwtzcsju", + "addressSpace": 1, + "workerConnections": 19, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.774Z", + "containerResyncTrigger": 23, + "imageUri": "wkowdrixfxvjmdcsy" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "lgljxmyyoakw", + "additionalCacheNodeProperties": { + "cacheNodePropertiesDetailsIssuesList": [ + "ennbzfpuszgalzpawmwicaofqcwcj" + ], + "aggregatedStatusDetails": "nztcstlyjhmllbnrrluhzusmoa", + "aggregatedStatusText": "ofiedyvzpbijnfghnrrigqaws", + "aggregatedStatusCode": 25, + "productVersion": "hfbuukpxoerpkziym", + "isProvisioned": true, + "cacheNodeStateDetailedText": "onckp", + "cacheNodeStateShortText": "yxkwlubqlzhkmemzjzlxksho", + "cacheNodeState": 30, + "driveConfiguration": [ + { + "physicalPath": "pcbkezoofhamkycot", + "sizeInGb": 14, + "cacheNumber": 11, + "nginxMapping": "cirlpkpuxg" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "fjbggfvumrn" + }, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "ihkzxlzvpcywtzrogupqozkdud", + "optionalProperty1": "ph", + "optionalProperty2": "soqqgpgcbhb", + "optionalProperty3": "fpnycrbagptsujiotnjfuhlm", + "optionalProperty4": "gesqugrxvhxlxxyvatgrautxwlmxsf", + "optionalProperty5": "zknjgzpaqtvdqjydd" + }, + "status": "utgrdjsw", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key259": "qbkixjuyjkoj" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DOTest/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "yeinlleavzbehelhsucb", + "customerId": "xjjgcknmsakfawcmwbdufdxktysp", + "customerName": "zsklcocjfjhkcpmzyefzkwamdzc", + "ipAddress": "gbfkdhloyphnpnhemwrcrxlk", + "customerIndex": "vafvezmelfgmjsrccjukrhppljvipg", + "cacheNodeId": "fmrjefyddfn", + "cacheNodeName": "qppvqxliajjfoalzjbgmxggr", + "customerAsn": 25, + "isEnabled": true, + "maxAllowableEgressInMbps": 27, + "maxAllowableProbability": 12, + "xCid": "ooyrhuockukmsrqsevwaaqglhf", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "tvmivvnpisuboggoqgbobugld", + "clientTenantId": "iwrpakllacxvtqygpaimlpxvqrjz", + "category": "utfjefejkrpxcmrgygzawa", + "releaseVersion": 29, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 4, + "containerConfigurations": "dyvefvbvrtsmdrdmiuphzh", + "cidrCsv": [ + "kaynxstxqsoreorwh" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.774Z", + "bgpReviewStateText": "khtriksrqrjieouoz", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "bc", + "bgpNumberOfTimesUpdated": 23, + "bgpNumberOfRecords": 25, + "bgpCidrBlocksCount": 28, + "bgpAddressSpace": 30, + "shouldMigrate": true, + "bgpFileBytesTruncated": 26, + "cidrSelectionType": 11, + "isFrozen": true, + "reviewState": 2, + "reviewStateText": "xubwhyrdtramrmoldbxqwauyusymqu", + "reviewFeedback": "zowuztcnybt", + "configurationState": "Configured", + "configurationStateText": "okbofqwtzcsju", + "addressSpace": 1, + "workerConnections": 19, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.774Z", + "containerResyncTrigger": 23, + "imageUri": "wkowdrixfxvjmdcsy" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "lgljxmyyoakw", + "additionalCacheNodeProperties": { + "cacheNodePropertiesDetailsIssuesList": [ + "ennbzfpuszgalzpawmwicaofqcwcj" + ], + "aggregatedStatusDetails": "nztcstlyjhmllbnrrluhzusmoa", + "aggregatedStatusText": "ofiedyvzpbijnfghnrrigqaws", + "aggregatedStatusCode": 25, + "productVersion": "hfbuukpxoerpkziym", + "isProvisioned": true, + "cacheNodeStateDetailedText": "onckp", + "cacheNodeStateShortText": "yxkwlubqlzhkmemzjzlxksho", + "cacheNodeState": 30, + "driveConfiguration": [ + { + "physicalPath": "pcbkezoofhamkycot", + "sizeInGb": 14, + "cacheNumber": 11, + "nginxMapping": "cirlpkpuxg" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "fjbggfvumrn" + }, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "ihkzxlzvpcywtzrogupqozkdud", + "optionalProperty1": "ph", + "optionalProperty2": "soqqgpgcbhb", + "optionalProperty3": "fpnycrbagptsujiotnjfuhlm", + "optionalProperty4": "gesqugrxvhxlxxyvatgrautxwlmxsf", + "optionalProperty5": "zknjgzpaqtvdqjydd" + }, + "status": "utgrdjsw", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key259": "qbkixjuyjkoj" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_Delete_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..0b27cadd91c0 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "EnterpriseMccCacheNodesOperations Delete Operation - generated by [MaximumSet] rule", + "operationId": "EnterpriseMccCacheNodesOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "hsincngmssuzeyispnufqwinpopadvhsbsemisguxgovwdjwviqexocelijvuyr", + "cacheNodeResourceName": "vwtrhdoxvkrunpliwcao" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json new file mode 100644 index 000000000000..458c99d5a293 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "Gets required properties for enterprise Mcc CacheNode resource install key details - generated by [MaximumSet] rule", + "operationId": "EnterpriseMccCacheNodesOperations_GetCacheNodeInstallDetails", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "fzwxcjmdpxxzayecabqqlh", + "cacheNodeResourceName": "ccexmqqttritxvtctivraso" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "properties": { + "customerId": "eqklliuswn", + "cacheNodeId": "zirahqqohbaju", + "primaryAccountKey": "mzfvziehrsbxidhj", + "secondaryAccountKey": "dq", + "registrationKey": "tnwkmorctwsgajewcoutombm" + }, + "tags": { + "key5811": "betoafcoprgfcuscoew" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_Get_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9bf1015a6954 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,126 @@ +{ + "title": "Gets enterpriseMccCacheNode resource information of an enterprise mcc customer parent resource - generated by [MaximumSet] rule", + "operationId": "EnterpriseMccCacheNodesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "cygqjgtcetihsajgyqwwrbclssqsvhgltrboemcqqtpoxdbhykqxblaihmrumyhbsx", + "cacheNodeResourceName": "fqxfadsultwjfzdwlqkvneakfsbyhratytmssmiukpbnus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DOTest/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "yeinlleavzbehelhsucb", + "customerId": "xjjgcknmsakfawcmwbdufdxktysp", + "customerName": "zsklcocjfjhkcpmzyefzkwamdzc", + "ipAddress": "gbfkdhloyphnpnhemwrcrxlk", + "customerIndex": "vafvezmelfgmjsrccjukrhppljvipg", + "cacheNodeId": "fmrjefyddfn", + "cacheNodeName": "qppvqxliajjfoalzjbgmxggr", + "customerAsn": 25, + "isEnabled": true, + "maxAllowableEgressInMbps": 27, + "maxAllowableProbability": 12, + "xCid": "ooyrhuockukmsrqsevwaaqglhf", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "tvmivvnpisuboggoqgbobugld", + "clientTenantId": "iwrpakllacxvtqygpaimlpxvqrjz", + "category": "utfjefejkrpxcmrgygzawa", + "releaseVersion": 29, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 4, + "containerConfigurations": "dyvefvbvrtsmdrdmiuphzh", + "cidrCsv": [ + "kaynxstxqsoreorwh" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.774Z", + "bgpReviewStateText": "khtriksrqrjieouoz", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "bc", + "bgpNumberOfTimesUpdated": 23, + "bgpNumberOfRecords": 25, + "bgpCidrBlocksCount": 28, + "bgpAddressSpace": 30, + "shouldMigrate": true, + "bgpFileBytesTruncated": 26, + "cidrSelectionType": 11, + "isFrozen": true, + "reviewState": 2, + "reviewStateText": "xubwhyrdtramrmoldbxqwauyusymqu", + "reviewFeedback": "zowuztcnybt", + "configurationState": "Configured", + "configurationStateText": "okbofqwtzcsju", + "addressSpace": 1, + "workerConnections": 19, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.774Z", + "containerResyncTrigger": 23, + "imageUri": "wkowdrixfxvjmdcsy" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "lgljxmyyoakw", + "additionalCacheNodeProperties": { + "cacheNodePropertiesDetailsIssuesList": [ + "ennbzfpuszgalzpawmwicaofqcwcj" + ], + "aggregatedStatusDetails": "nztcstlyjhmllbnrrluhzusmoa", + "aggregatedStatusText": "ofiedyvzpbijnfghnrrigqaws", + "aggregatedStatusCode": 25, + "productVersion": "hfbuukpxoerpkziym", + "isProvisioned": true, + "cacheNodeStateDetailedText": "onckp", + "cacheNodeStateShortText": "yxkwlubqlzhkmemzjzlxksho", + "cacheNodeState": 30, + "driveConfiguration": [ + { + "physicalPath": "pcbkezoofhamkycot", + "sizeInGb": 14, + "cacheNumber": 11, + "nginxMapping": "cirlpkpuxg" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "fjbggfvumrn" + }, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "ihkzxlzvpcywtzrogupqozkdud", + "optionalProperty1": "ph", + "optionalProperty2": "soqqgpgcbhb", + "optionalProperty3": "fpnycrbagptsujiotnjfuhlm", + "optionalProperty4": "gesqugrxvhxlxxyvatgrautxwlmxsf", + "optionalProperty5": "zknjgzpaqtvdqjydd" + }, + "status": "utgrdjsw", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key259": "qbkixjuyjkoj" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..0dbcaec9dac1 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource_MaximumSet_Gen.json @@ -0,0 +1,130 @@ +{ + "title": "EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource", + "operationId": "EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "syjjjzk" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "yeinlleavzbehelhsucb", + "customerId": "xjjgcknmsakfawcmwbdufdxktysp", + "customerName": "zsklcocjfjhkcpmzyefzkwamdzc", + "ipAddress": "gbfkdhloyphnpnhemwrcrxlk", + "customerIndex": "vafvezmelfgmjsrccjukrhppljvipg", + "cacheNodeId": "fmrjefyddfn", + "cacheNodeName": "qppvqxliajjfoalzjbgmxggr", + "customerAsn": 25, + "isEnabled": true, + "maxAllowableEgressInMbps": 27, + "maxAllowableProbability": 12, + "xCid": "ooyrhuockukmsrqsevwaaqglhf", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "tvmivvnpisuboggoqgbobugld", + "clientTenantId": "iwrpakllacxvtqygpaimlpxvqrjz", + "category": "utfjefejkrpxcmrgygzawa", + "releaseVersion": 29, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 4, + "containerConfigurations": "dyvefvbvrtsmdrdmiuphzh", + "cidrCsv": [ + "kaynxstxqsoreorwh" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.774Z", + "bgpReviewStateText": "khtriksrqrjieouoz", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "bc", + "bgpNumberOfTimesUpdated": 23, + "bgpNumberOfRecords": 25, + "bgpCidrBlocksCount": 28, + "bgpAddressSpace": 30, + "shouldMigrate": true, + "bgpFileBytesTruncated": 26, + "cidrSelectionType": 11, + "isFrozen": true, + "reviewState": 2, + "reviewStateText": "xubwhyrdtramrmoldbxqwauyusymqu", + "reviewFeedback": "zowuztcnybt", + "configurationState": "Configured", + "configurationStateText": "okbofqwtzcsju", + "addressSpace": 1, + "workerConnections": 19, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.774Z", + "containerResyncTrigger": 23, + "imageUri": "wkowdrixfxvjmdcsy" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "lgljxmyyoakw", + "additionalCacheNodeProperties": { + "cacheNodePropertiesDetailsIssuesList": [ + "ennbzfpuszgalzpawmwicaofqcwcj" + ], + "aggregatedStatusDetails": "nztcstlyjhmllbnrrluhzusmoa", + "aggregatedStatusText": "ofiedyvzpbijnfghnrrigqaws", + "aggregatedStatusCode": 25, + "productVersion": "hfbuukpxoerpkziym", + "isProvisioned": true, + "cacheNodeStateDetailedText": "onckp", + "cacheNodeStateShortText": "yxkwlubqlzhkmemzjzlxksho", + "cacheNodeState": 30, + "driveConfiguration": [ + { + "physicalPath": "pcbkezoofhamkycot", + "sizeInGb": 14, + "cacheNumber": 11, + "nginxMapping": "cirlpkpuxg" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "fjbggfvumrn" + }, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "ihkzxlzvpcywtzrogupqozkdud", + "optionalProperty1": "ph", + "optionalProperty2": "soqqgpgcbhb", + "optionalProperty3": "fpnycrbagptsujiotnjfuhlm", + "optionalProperty4": "gesqugrxvhxlxxyvatgrautxwlmxsf", + "optionalProperty5": "zknjgzpaqtvdqjydd" + }, + "status": "utgrdjsw", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key259": "qbkixjuyjkoj" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_Update_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..005f964caec3 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCacheNodesOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,130 @@ +{ + "title": "EnterpriseMccCacheNodesOperations Update - generated by [MaximumSet] rule", + "operationId": "EnterpriseMccCacheNodesOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "qanjqtvrxzjkljdysdjvdiqcxkttskpdzykzuefhbhz", + "cacheNodeResourceName": "kllmlvazrcxmfjfozulzqnsgvspgwmhogcafvauchunlgfr", + "properties": { + "tags": { + "key1653": "nzjczrhclhkndesgy" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "yeinlleavzbehelhsucb", + "customerId": "xjjgcknmsakfawcmwbdufdxktysp", + "customerName": "zsklcocjfjhkcpmzyefzkwamdzc", + "ipAddress": "gbfkdhloyphnpnhemwrcrxlk", + "customerIndex": "vafvezmelfgmjsrccjukrhppljvipg", + "cacheNodeId": "fmrjefyddfn", + "cacheNodeName": "qppvqxliajjfoalzjbgmxggr", + "customerAsn": 25, + "isEnabled": true, + "maxAllowableEgressInMbps": 27, + "maxAllowableProbability": 12, + "xCid": "ooyrhuockukmsrqsevwaaqglhf", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "tvmivvnpisuboggoqgbobugld", + "clientTenantId": "iwrpakllacxvtqygpaimlpxvqrjz", + "category": "utfjefejkrpxcmrgygzawa", + "releaseVersion": 29, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 4, + "containerConfigurations": "dyvefvbvrtsmdrdmiuphzh", + "cidrCsv": [ + "kaynxstxqsoreorwh" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.774Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.774Z", + "bgpReviewStateText": "khtriksrqrjieouoz", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "bc", + "bgpNumberOfTimesUpdated": 23, + "bgpNumberOfRecords": 25, + "bgpCidrBlocksCount": 28, + "bgpAddressSpace": 30, + "shouldMigrate": true, + "bgpFileBytesTruncated": 26, + "cidrSelectionType": 11, + "isFrozen": true, + "reviewState": 2, + "reviewStateText": "xubwhyrdtramrmoldbxqwauyusymqu", + "reviewFeedback": "zowuztcnybt", + "configurationState": "Configured", + "configurationStateText": "okbofqwtzcsju", + "addressSpace": 1, + "workerConnections": 19, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.774Z", + "containerResyncTrigger": 23, + "imageUri": "wkowdrixfxvjmdcsy" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "lgljxmyyoakw", + "additionalCacheNodeProperties": { + "cacheNodePropertiesDetailsIssuesList": [ + "ennbzfpuszgalzpawmwicaofqcwcj" + ], + "aggregatedStatusDetails": "nztcstlyjhmllbnrrluhzusmoa", + "aggregatedStatusText": "ofiedyvzpbijnfghnrrigqaws", + "aggregatedStatusCode": 25, + "productVersion": "hfbuukpxoerpkziym", + "isProvisioned": true, + "cacheNodeStateDetailedText": "onckp", + "cacheNodeStateShortText": "yxkwlubqlzhkmemzjzlxksho", + "cacheNodeState": 30, + "driveConfiguration": [ + { + "physicalPath": "pcbkezoofhamkycot", + "sizeInGb": 14, + "cacheNumber": 11, + "nginxMapping": "cirlpkpuxg" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "fjbggfvumrn" + }, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "ihkzxlzvpcywtzrogupqozkdud", + "optionalProperty1": "ph", + "optionalProperty2": "soqqgpgcbhb", + "optionalProperty3": "fpnycrbagptsujiotnjfuhlm", + "optionalProperty4": "gesqugrxvhxlxxyvatgrautxwlmxsf", + "optionalProperty5": "zknjgzpaqtvdqjydd" + }, + "status": "utgrdjsw", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob" + } + }, + "tags": { + "key259": "qbkixjuyjkoj" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_CreateOrUpdate_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..41d421189b6f --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,220 @@ +{ + "title": "EnterpriseMccCustomers_CreateOrUpdate", + "operationId": "EnterpriseMccCustomers_CreateOrUpdate", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest1", + "resource": { + "properties": { + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "clientTenantId": "fproidkpgvpdnac", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true, + "verifySignupPhrase": "tprjvttkgmrqlsyicnidhm" + }, + "additionalCustomerProperties": { + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "error": {} + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers", + "location": "westus", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1/enterpriseMccCacheNodes/MCCCachenode2", + "name": "MccRPTest2", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers/enterpriseMccCacheNodes", + "location": "westus", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_Delete_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..bd7d3d82e66c --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "EnterpriseMccCustomers_Delete", + "operationId": "EnterpriseMccCustomers_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "zktb" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_Get_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..89de109742f3 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_Get_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "title": "EnterpriseMccCustomers_Get", + "operationId": "EnterpriseMccCustomers_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "pvilvqkofbjbykupeewgvzlmjao" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers", + "location": "westus", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_ListByResourceGroup_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..e20505f9b477 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,99 @@ +{ + "title": "EnterpriseMccCustomers_ListByResourceGroup", + "operationId": "EnterpriseMccCustomers_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers", + "location": "westus", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/ae" + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_ListBySubscription_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..16668799f060 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "EnterpriseMccCustomers_ListBySubscription", + "operationId": "EnterpriseMccCustomers_ListBySubscription", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/MccRPTest1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/enterpriseMccCustomers", + "location": "westus", + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/ae" + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_Update_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..1471deab8567 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/EnterpriseMccCustomers_Update_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "title": "EnterpriseMccCustomers_Update", + "operationId": "EnterpriseMccCustomers_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest1", + "properties": { + "tags": { + "key1878": "warz" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr" + }, + "tags": { + "key3379": "dpyqeaqhcnutzezom" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..3f525b15ea57 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,284 @@ +{ + "title": "IspCacheNodesOperations_CreateOrUpdate", + "operationId": "IspCacheNodesOperations_CreateOrUpdate", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "zpqzbmanlljgmkrthtydrtneavhlnlqkdmviq", + "cacheNodeResourceName": "cabakm", + "resource": { + "location": "westus", + "properties": { + "cacheNode": { + "fullyQualifiedResourceId": "hskxkpbiqbrbjiwdzrxndru", + "customerName": "xwyqk", + "ipAddress": "voctagljcwqgcpnionqdcbjk", + "customerIndex": "qtoiglqaswivmkjhzogburcxtszmek", + "cacheNodeId": "xjzffjftwcgsehanoxsl", + "cacheNodeName": "mfjxb", + "customerAsn": 4, + "isEnabled": true, + "maxAllowableEgressInMbps": 29, + "isEnterpriseManaged": true, + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "shouldMigrate": true, + "cidrSelectionType": 4 + }, + "additionalCacheNodeProperties": { + "driveConfiguration": [ + { + "physicalPath": "/mcc", + "sizeInGb": 500, + "cacheNumber": 1, + "nginxMapping": "lijygenjq" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "pafcimhoog" + }, + "cacheNodePropertiesDetailsIssuesList": [ + "ex" + ], + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "qhux", + "optionalProperty1": "hvpmt", + "optionalProperty2": "talanelmsgxvksrzoeeontqkjzbpv", + "optionalProperty3": "bxkoxq", + "optionalProperty4": "pqlkcekupusoc", + "optionalProperty5": "nyvvmrjigqdufzjdvazdca" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "djruqvptzxak", + "error": {} + }, + "tags": { + "key4171": "qtjlszkawsdujzpgohsbw" + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DOTest/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "hskxkpbiqbrbjiwdzrxndru", + "customerId": "ceyfqoygknpmmjojlhuklqybfl", + "customerName": "xwyqk", + "ipAddress": "voctagljcwqgcpnionqdcbjk", + "customerIndex": "qtoiglqaswivmkjhzogburcxtszmek", + "cacheNodeId": "xjzffjftwcgsehanoxsl", + "cacheNodeName": "mfjxb", + "customerAsn": 4, + "isEnabled": true, + "maxAllowableEgressInMbps": 29, + "maxAllowableProbability": 16, + "xCid": "kwnwgdbeflazz", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "oeyevqzlpbsimi", + "clientTenantId": "ds", + "category": "rixlfzbl", + "releaseVersion": 30, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 11, + "containerConfigurations": "waygqqgfzvnvlbufilldsqavwlshzt", + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.777Z", + "bgpReviewStateText": "xduneialocyri", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "us", + "bgpNumberOfTimesUpdated": 2, + "bgpNumberOfRecords": 21, + "bgpCidrBlocksCount": 5, + "bgpAddressSpace": 6, + "shouldMigrate": true, + "bgpFileBytesTruncated": 13, + "cidrSelectionType": 4, + "isFrozen": true, + "reviewState": 19, + "reviewStateText": "mrnragzmnscovixohmif", + "reviewFeedback": "wrcfimvx", + "configurationState": "Configured", + "configurationStateText": "arugukqjcxmkbgfambg", + "addressSpace": 11, + "workerConnections": 18, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.777Z", + "containerResyncTrigger": 13, + "imageUri": "ezbwyfaainatxtlplyoailzxlhxy" + }, + "additionalCacheNodeProperties": { + "driveConfiguration": [ + { + "physicalPath": "/mcc", + "sizeInGb": 500, + "cacheNumber": 1, + "nginxMapping": "lijygenjq" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "pafcimhoog" + }, + "cacheNodePropertiesDetailsIssuesList": [ + "ex" + ], + "aggregatedStatusDetails": "emougql", + "aggregatedStatusText": "xcasvndgkob", + "aggregatedStatusCode": 22, + "productVersion": "oxhqgwlhgnuf", + "isProvisioned": true, + "cacheNodeStateDetailedText": "ufvomikgfnmnj", + "cacheNodeStateShortText": "orfpuvrevhrxsaasddazigglq", + "cacheNodeState": 9, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "qhux", + "optionalProperty1": "hvpmt", + "optionalProperty2": "talanelmsgxvksrzoeeontqkjzbpv", + "optionalProperty3": "bxkoxq", + "optionalProperty4": "pqlkcekupusoc", + "optionalProperty5": "nyvvmrjigqdufzjdvazdca" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "djruqvptzxak", + "status": "tnyrntqvazk" + }, + "tags": { + "key4171": "qtjlszkawsdujzpgohsbw" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DOTest/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "hskxkpbiqbrbjiwdzrxndru", + "customerId": "ceyfqoygknpmmjojlhuklqybfl", + "customerName": "xwyqk", + "ipAddress": "voctagljcwqgcpnionqdcbjk", + "customerIndex": "qtoiglqaswivmkjhzogburcxtszmek", + "cacheNodeId": "xjzffjftwcgsehanoxsl", + "cacheNodeName": "mfjxb", + "customerAsn": 4, + "isEnabled": true, + "maxAllowableEgressInMbps": 29, + "maxAllowableProbability": 16, + "xCid": "kwnwgdbeflazz", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "oeyevqzlpbsimi", + "clientTenantId": "ds", + "category": "rixlfzbl", + "releaseVersion": 30, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 11, + "containerConfigurations": "waygqqgfzvnvlbufilldsqavwlshzt", + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.777Z", + "bgpReviewStateText": "xduneialocyri", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "us", + "bgpNumberOfTimesUpdated": 2, + "bgpNumberOfRecords": 21, + "bgpCidrBlocksCount": 5, + "bgpAddressSpace": 6, + "shouldMigrate": true, + "bgpFileBytesTruncated": 13, + "cidrSelectionType": 4, + "reviewState": 19, + "reviewStateText": "mrnragzmnscovixohmif", + "reviewFeedback": "wrcfimvx", + "configurationState": "Configured", + "configurationStateText": "arugukqjcxmkbgfambg", + "isFrozen": true, + "workerConnections": 18, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.777Z", + "containerResyncTrigger": 13 + }, + "additionalCacheNodeProperties": { + "driveConfiguration": [ + { + "physicalPath": "/mcc", + "sizeInGb": 500, + "cacheNumber": 1, + "nginxMapping": "lijygenjq" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "pafcimhoog" + }, + "cacheNodePropertiesDetailsIssuesList": [ + "ex" + ], + "aggregatedStatusDetails": "emougql", + "aggregatedStatusText": "xcasvndgkob", + "aggregatedStatusCode": 22, + "productVersion": "oxhqgwlhgnuf", + "isProvisioned": true, + "cacheNodeStateDetailedText": "ufvomikgfnmnj", + "cacheNodeStateShortText": "orfpuvrevhrxsaasddazigglq", + "cacheNodeState": 9, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "qhux", + "optionalProperty1": "hvpmt", + "optionalProperty2": "talanelmsgxvksrzoeeontqkjzbpv", + "optionalProperty3": "bxkoxq", + "optionalProperty4": "pqlkcekupusoc", + "optionalProperty5": "nyvvmrjigqdufzjdvazdca" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "djruqvptzxak", + "status": "tnyrntqvazk" + }, + "tags": { + "key4171": "qtjlszkawsdujzpgohsbw" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_Delete_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..3959eb42ad8b --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "IspCacheNodes delete Operation - generated by [MaximumSet] rule", + "operationId": "IspCacheNodesOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "lvpcosvbfxtpzscakewx", + "cacheNodeResourceName": "wsiruvexelltpbouqxvsogqpxdizcwqwfowybncvjunlakjwcpgmqbdbgzjrsmxlkczxnsxfonhnqqa" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_GetBgpCidrs_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_GetBgpCidrs_MaximumSet_Gen.json new file mode 100644 index 000000000000..559b0beaafb1 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_GetBgpCidrs_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "IspCacheNodes resource BgpCidrs details - generated by [MaximumSet] rule", + "operationId": "IspCacheNodesOperations_GetBgpCidrs", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest1", + "cacheNodeResourceName": "MCCCachenode1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "location": "westus", + "properties": { + "bgpCidrs": [ + "10.1.0.1/23", + "10.1.0.1/32" + ] + }, + "tags": { + "key5911": "qllqoxckxvnyhdegqubvqtfediery" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json new file mode 100644 index 000000000000..3dde7870de38 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_GetCacheNodeInstallDetails_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "ispCacheNode resource get install details - generated by [MaximumSet] rule", + "operationId": "IspCacheNodesOperations_GetCacheNodeInstallDetails", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest1", + "cacheNodeResourceName": "MCCCachenode1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "location": "westus", + "properties": { + "customerId": "eqklliuswn", + "cacheNodeId": "zirahqqohbaju", + "primaryAccountKey": "mzfvziehrsbxidhj", + "secondaryAccountKey": "dq", + "registrationKey": "tnwkmorctwsgajewcoutombm" + }, + "tags": { + "key5811": "betoafcoprgfcuscoew" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_Get_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..41c2bc8cbaf2 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,126 @@ +{ + "title": "IspCacheNodes Get resource - generated by [MaximumSet] rule", + "operationId": "IspCacheNodesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "sgtqjsitdrskmgyrrkntszwrrjjkretscpjgaezraucvcwececlelcsorfunrnvxyxcsrg", + "cacheNodeResourceName": "lbsziwmudcjnwnwy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "hskxkpbiqbrbjiwdzrxndru", + "customerId": "ceyfqoygknpmmjojlhuklqybfl", + "customerName": "xwyqk", + "ipAddress": "voctagljcwqgcpnionqdcbjk", + "customerIndex": "qtoiglqaswivmkjhzogburcxtszmek", + "cacheNodeId": "xjzffjftwcgsehanoxsl", + "cacheNodeName": "mfjxb", + "customerAsn": 4, + "isEnabled": true, + "maxAllowableEgressInMbps": 29, + "maxAllowableProbability": 16, + "xCid": "kwnwgdbeflazz", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "oeyevqzlpbsimi", + "clientTenantId": "ds", + "category": "rixlfzbl", + "releaseVersion": 30, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 11, + "containerConfigurations": "waygqqgfzvnvlbufilldsqavwlshzt", + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.777Z", + "bgpReviewStateText": "xduneialocyri", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "us", + "bgpNumberOfTimesUpdated": 2, + "bgpNumberOfRecords": 21, + "bgpCidrBlocksCount": 5, + "bgpAddressSpace": 6, + "shouldMigrate": true, + "bgpFileBytesTruncated": 13, + "cidrSelectionType": 4, + "isFrozen": true, + "reviewState": 19, + "reviewStateText": "mrnragzmnscovixohmif", + "reviewFeedback": "wrcfimvx", + "configurationState": "Configured", + "configurationStateText": "arugukqjcxmkbgfambg", + "addressSpace": 11, + "workerConnections": 18, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.777Z", + "containerResyncTrigger": 13, + "imageUri": "ezbwyfaainatxtlplyoailzxlhxy" + }, + "additionalCacheNodeProperties": { + "driveConfiguration": [ + { + "physicalPath": "/mcc", + "sizeInGb": 500, + "cacheNumber": 1, + "nginxMapping": "lijygenjq" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "pafcimhoog" + }, + "cacheNodePropertiesDetailsIssuesList": [ + "ex" + ], + "aggregatedStatusDetails": "emougql", + "aggregatedStatusText": "xcasvndgkob", + "aggregatedStatusCode": 22, + "productVersion": "oxhqgwlhgnuf", + "isProvisioned": true, + "cacheNodeStateDetailedText": "ufvomikgfnmnj", + "cacheNodeStateShortText": "orfpuvrevhrxsaasddazigglq", + "cacheNodeState": 9, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "qhux", + "optionalProperty1": "hvpmt", + "optionalProperty2": "talanelmsgxvksrzoeeontqkjzbpv", + "optionalProperty3": "bxkoxq", + "optionalProperty4": "pqlkcekupusoc", + "optionalProperty5": "nyvvmrjigqdufzjdvazdca" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "djruqvptzxak", + "status": "tnyrntqvazk", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4171": "qtjlszkawsdujzpgohsbw" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_ListByIspCustomerResource_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_ListByIspCustomerResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..707d84da6991 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_ListByIspCustomerResource_MaximumSet_Gen.json @@ -0,0 +1,130 @@ +{ + "title": "IspCacheNodesOperations_ListByIspCustomerResource", + "operationId": "IspCacheNodesOperations_ListByIspCustomerResource", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "hskxkpbiqbrbjiwdzrxndru", + "customerId": "ceyfqoygknpmmjojlhuklqybfl", + "customerName": "xwyqk", + "ipAddress": "voctagljcwqgcpnionqdcbjk", + "customerIndex": "qtoiglqaswivmkjhzogburcxtszmek", + "cacheNodeId": "xjzffjftwcgsehanoxsl", + "cacheNodeName": "mfjxb", + "customerAsn": 4, + "isEnabled": true, + "maxAllowableEgressInMbps": 29, + "maxAllowableProbability": 16, + "xCid": "kwnwgdbeflazz", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "oeyevqzlpbsimi", + "clientTenantId": "ds", + "category": "rixlfzbl", + "releaseVersion": 30, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 11, + "containerConfigurations": "waygqqgfzvnvlbufilldsqavwlshzt", + "cidrCsv": [ + "nlqlvrthafvvljuupcbcw" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.777Z", + "bgpReviewStateText": "xduneialocyri", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "us", + "bgpNumberOfTimesUpdated": 2, + "bgpNumberOfRecords": 21, + "bgpCidrBlocksCount": 5, + "bgpAddressSpace": 6, + "shouldMigrate": true, + "bgpFileBytesTruncated": 13, + "cidrSelectionType": 4, + "isFrozen": true, + "reviewState": 19, + "reviewStateText": "mrnragzmnscovixohmif", + "reviewFeedback": "wrcfimvx", + "configurationState": "Configured", + "configurationStateText": "arugukqjcxmkbgfambg", + "addressSpace": 11, + "workerConnections": 18, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.777Z", + "containerResyncTrigger": 13, + "imageUri": "ezbwyfaainatxtlplyoailzxlhxy" + }, + "additionalCacheNodeProperties": { + "driveConfiguration": [ + { + "physicalPath": "/mcc", + "sizeInGb": 500, + "cacheNumber": 1, + "nginxMapping": "lijygenjq" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "pafcimhoog" + }, + "cacheNodePropertiesDetailsIssuesList": [ + "ex" + ], + "aggregatedStatusDetails": "emougql", + "aggregatedStatusText": "xcasvndgkob", + "aggregatedStatusCode": 22, + "productVersion": "oxhqgwlhgnuf", + "isProvisioned": true, + "cacheNodeStateDetailedText": "ufvomikgfnmnj", + "cacheNodeStateShortText": "orfpuvrevhrxsaasddazigglq", + "cacheNodeState": 9, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "qhux", + "optionalProperty1": "hvpmt", + "optionalProperty2": "talanelmsgxvksrzoeeontqkjzbpv", + "optionalProperty3": "bxkoxq", + "optionalProperty4": "pqlkcekupusoc", + "optionalProperty5": "nyvvmrjigqdufzjdvazdca" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "djruqvptzxak", + "status": "tnyrntqvazk", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4171": "qtjlszkawsdujzpgohsbw" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_Update_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..85cb4b9d4054 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCacheNodesOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,131 @@ +{ + "title": "IspCacheNodesOperations_Update", + "operationId": "IspCacheNodesOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest1", + "cacheNodeResourceName": "MCCCachenode1", + "properties": { + "tags": { + "key1653": "nzjczrhclhkndesgy" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1/ispCacheNodes/MCCCachenode1", + "name": "MccRPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers/ispCacheNodes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "cacheNode": { + "fullyQualifiedResourceId": "hskxkpbiqbrbjiwdzrxndru", + "customerId": "ceyfqoygknpmmjojlhuklqybfl", + "customerName": "xwyqk", + "ipAddress": "voctagljcwqgcpnionqdcbjk", + "customerIndex": "qtoiglqaswivmkjhzogburcxtszmek", + "cacheNodeId": "xjzffjftwcgsehanoxsl", + "cacheNodeName": "mfjxb", + "customerAsn": 4, + "isEnabled": true, + "maxAllowableEgressInMbps": 29, + "maxAllowableProbability": 16, + "xCid": "kwnwgdbeflazz", + "isEnterpriseManaged": true, + "deleteAsyncOperationId": "oeyevqzlpbsimi", + "clientTenantId": "ds", + "category": "rixlfzbl", + "releaseVersion": 30, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "synchWithAzureAttemptsCount": 11, + "containerConfigurations": "waygqqgfzvnvlbufilldsqavwlshzt", + "cidrCsv": [ + "127.0.0.1/20" + ], + "cidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpCidrCsvLastUpdateTime": "2024-01-30T00:54:04.777Z", + "bgpLastReportedTime": "2024-01-30T00:54:04.777Z", + "bgpReviewStateText": "xduneialocyri", + "bgpReviewState": "NotConfigured", + "bgpReviewFeedback": "us", + "bgpNumberOfTimesUpdated": 2, + "bgpNumberOfRecords": 21, + "bgpCidrBlocksCount": 5, + "bgpAddressSpace": 6, + "shouldMigrate": true, + "bgpFileBytesTruncated": 13, + "cidrSelectionType": 4, + "isFrozen": true, + "reviewState": 19, + "reviewStateText": "mrnragzmnscovixohmif", + "reviewFeedback": "wrcfimvx", + "configurationState": "Configured", + "configurationStateText": "arugukqjcxmkbgfambg", + "addressSpace": 11, + "workerConnections": 18, + "workerConnectionsLastUpdatedDateTime": "2024-01-30T00:54:04.777Z", + "containerResyncTrigger": 13, + "imageUri": "ezbwyfaainatxtlplyoailzxlhxy" + }, + "additionalCacheNodeProperties": { + "driveConfiguration": [ + { + "physicalPath": "/mcc", + "sizeInGb": 500, + "cacheNumber": 1, + "nginxMapping": "lijygenjq" + } + ], + "bgpConfiguration": { + "asnToIpAddressMapping": "pafcimhoog" + }, + "cacheNodePropertiesDetailsIssuesList": [ + "ex" + ], + "aggregatedStatusDetails": "emougql", + "aggregatedStatusText": "xcasvndgkob", + "aggregatedStatusCode": 22, + "productVersion": "oxhqgwlhgnuf", + "isProvisioned": true, + "cacheNodeStateDetailedText": "ufvomikgfnmnj", + "cacheNodeStateShortText": "orfpuvrevhrxsaasddazigglq", + "cacheNodeState": 9, + "proxyUrlConfiguration": { + "proxyUrl": "hplstyg" + }, + "proxyUrl": "qhux", + "optionalProperty1": "hvpmt", + "optionalProperty2": "talanelmsgxvksrzoeeontqkjzbpv", + "optionalProperty3": "bxkoxq", + "optionalProperty4": "pqlkcekupusoc", + "optionalProperty5": "nyvvmrjigqdufzjdvazdca" + }, + "statusCode": "1", + "statusText": "Success", + "statusDetails": "djruqvptzxak", + "status": "tnyrntqvazk", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key4171": "qtjlszkawsdujzpgohsbw" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_CreateOrUpdate_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..a5183a6bde6b --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,220 @@ +{ + "title": "ispCustomer CreateOrUpdate - generated by [MaximumSet] rule", + "operationId": "IspCustomers_CreateOrUpdate", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest2", + "resource": { + "location": "westus", + "properties": { + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "clientTenantId": "fproidkpgvpdnac", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true, + "verifySignupPhrase": "tprjvttkgmrqlsyicnidhm" + }, + "additionalCustomerProperties": { + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "error": {} + }, + "tags": { + "key1878": "warz" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key1878": "warz" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key1878": "warz" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_Delete_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2e43eaf23a71 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "IspCustomers Delete - generated by [MaximumSet] rule", + "operationId": "IspCustomers_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "hdontfoythjsaeyjhrakckgimgchxwzttbcnvntpvdsgeumxpgnjurptd" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_Get_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..7868924de6ca --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_Get_MaximumSet_Gen.json @@ -0,0 +1,94 @@ +{ + "title": "IspCustomers Get - generated by [MaximumSet] rule", + "operationId": "IspCustomers_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "cmcjfueweicolcjkwmsuvcj" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key1878": "warz" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_ListByResourceGroup_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..bcaf7a667d9f --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,180 @@ +{ + "title": "IspCustomers resource List by Resource group - generated by [MaximumSet] rule", + "operationId": "IspCustomers_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key1878": "warz" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1", + "name": "MCCTPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "oytrfgfhk", + "statusText": "pqitblihwfrq", + "statusDetails": "kvxqjbldcwqgslerajc", + "status": "stwi", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key2096": "uzoqqgqnnaiagdqilrjiezogx" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/ao" + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_ListBySubscription_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..1da8aeb7c6db --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,179 @@ +{ + "title": "ispCustomer List by Subscription - generated by [MaximumSet] rule", + "operationId": "IspCustomers_ListBySubscription", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key1878": "warz" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/DoTest/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest1", + "name": "MCCTPTest1", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.773Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "oytrfgfhk", + "statusText": "pqitblihwfrq", + "statusDetails": "kvxqjbldcwqgslerajc", + "status": "stwi", + "error": { + "code": "dkvgvtftpsjsbhlnapvihefxneoggs", + "message": "okakgyfnmyob", + "details": [] + } + }, + "tags": { + "key2096": "uzoqqgqnnaiagdqilrjiezogx" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + ], + "nextLink": "https://microsoft.com/ao" + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_Update_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..2896e29eb578 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/IspCustomers_Update_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "title": "ispCustomer Update details - generated by [MaximumSet] rule", + "operationId": "IspCustomers_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "rgConnectedCache", + "customerResourceName": "MccRPTest2", + "properties": { + "tags": { + "key1653": "nzjczrhclhkndesgy" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rgConnectedCache/providers/Microsoft.ConnectedCache/ispCustomers/MccRPTest2", + "name": "MCCTPTest2", + "type": "Microsoft.ConnectedCache/ispCustomers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "customer": { + "fullyQualifiedResourceId": "uqsbtgae", + "customerId": "nqxuzybu", + "customerName": "mkpzynfqihnjfdbaqbqwyhd", + "contactEmail": "xquos", + "contactPhone": "vue", + "contactName": "wxyqjoyoscmvimgwhpitxky", + "isEntitled": true, + "releaseVersion": 20, + "createAsyncOperationId": "zjpvgirzxecwmnfyofqkikst", + "deleteAsyncOperationId": "ajtdyoyecybeaxzyztjkvvtx", + "clientTenantId": "fproidkpgvpdnac", + "synchWithAzureAttemptsCount": 17, + "lastSyncWithAzureTimestamp": "2024-01-30T00:54:04.777Z", + "isEnterpriseManaged": true, + "shouldMigrate": true, + "resendSignupCode": true, + "verifySignupCode": true + }, + "additionalCustomerProperties": { + "peeringDbLastUpdateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheEfficiency": 20, + "customerPropertiesOverviewAverageEgressMbps": 8, + "customerPropertiesOverviewAverageMissMbps": 19, + "customerPropertiesOverviewEgressMbpsMax": 15, + "customerPropertiesOverviewEgressMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewMissMbpsMax": 28, + "customerPropertiesOverviewMissMbpsMaxDateTime": "2024-01-30T00:54:04.773Z", + "customerPropertiesOverviewCacheNodesHealthyCount": 24, + "customerPropertiesOverviewCacheNodesUnhealthyCount": 15, + "signupStatus": true, + "signupStatusCode": 21, + "signupStatusText": "dccv", + "signupPhaseStatusCode": 4, + "signupPhaseStatusText": "q", + "peeringDbLastUpdateDate": "2024-01-30T00:54:04.773Z", + "customerOrgName": "nshrwjhhggmdaqlpc", + "customerEmail": "zdjgibsidydyzm", + "customerTransitAsn": "habgklnxqzmozqpazoyejwiphezpi", + "customerTransitState": "voblixkxfejbmhxilb", + "customerAsn": "hgrelgnrtdkleisnepfolu", + "customerAsnEstimatedEgressPeekGbps": 10, + "customerEntitlementSkuId": "b", + "customerEntitlementSkuGuid": "rvzmdpxyflgqetvpwupnfaxsweiiz", + "customerEntitlementSkuName": "waaqfijr", + "customerEntitlementExpiration": "2024-01-30T00:54:04.773Z", + "optionalProperty1": "qhmwxza", + "optionalProperty2": "l", + "optionalProperty3": "mblwwvbie", + "optionalProperty4": "vzuek", + "optionalProperty5": "fzjodscdfcdr" + }, + "statusCode": "jax", + "statusText": "vsqydgruhuwuyipsplylgiqmkcv", + "statusDetails": "wmtksbahlbxrzaksogdbozfi", + "status": "rhfjbcr" + }, + "tags": { + "key1878": "warz" + }, + "systemData": { + "createdBy": "gambtqj", + "createdByType": "User", + "createdAt": "2024-01-30T00:54:04.771Z", + "lastModifiedBy": "qomgaceiessgnuogz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-01-30T00:54:04.771Z" + } + } + } + } +} diff --git a/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..3ae8071fca68 --- /dev/null +++ b/specification/connectedcache/resource-manager/Microsoft.ConnectedCache/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "List the operations for the provider - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "operationName", + "display": { + "provider": "providerName", + "resource": "resourceName", + "operation": "operationName", + "description": "zkcugoxocugvzcsedehxwbxiuvrb" + }, + "isDataAction": true, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/connectedcache/resource-manager/readme.csharp.md b/specification/connectedcache/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..15967e113cf2 --- /dev/null +++ b/specification/connectedcache/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.Azure.Management.ConnectedCache + output-folder: $(csharp-sdks-folder)/ConnectedCache/Microsoft.Azure.Management.ConnectedCache/src/Generated +``` diff --git a/specification/connectedcache/resource-manager/readme.go.md b/specification/connectedcache/resource-manager/readme.go.md new file mode 100644 index 000000000000..1c7b48243d5d --- /dev/null +++ b/specification/connectedcache/resource-manager/readme.go.md @@ -0,0 +1,18 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && !$(track2) +go: + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true +``` + +```yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/connectedcache/armconnectedcache +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +module-version: 0.1.0 +``` diff --git a/specification/connectedcache/resource-manager/readme.md b/specification/connectedcache/resource-manager/readme.md new file mode 100644 index 000000000000..bcb6b9fad573 --- /dev/null +++ b/specification/connectedcache/resource-manager/readme.md @@ -0,0 +1,73 @@ +# Microsoft Connected Cache + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for connectedcache. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the connectedcache + +``` yaml +openapi-type: arm +openapi-subtype: rpaas +tag: package-2023-05-01-preview +``` + + +### Tag: package-preview-2023-05-01-preview + +These settings apply only when `--tag=package-2023-05-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-05-01-preview' +input-file: + - Microsoft.ConnectedCache/preview/2023-05-01-preview/ConnectedCache.json +``` + +## Suppression + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-go + - repo: azure-cli-extensions + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_connectedcache'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) diff --git a/specification/connectedcache/resource-manager/readme.python.md b/specification/connectedcache/resource-manager/readme.python.md new file mode 100644 index 000000000000..aaef7b9da399 --- /dev/null +++ b/specification/connectedcache/resource-manager/readme.python.md @@ -0,0 +1,18 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-connectedcache +namespace: azure.mgmt.connectedcache +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/connectedcache/azure-mgmt-connectedcache/azure/mgmt/connectedcache +``` diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md index 1188f8f94034..00135b78301e 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md @@ -105,6 +105,20 @@ batch: - tag: package-preview-2024-07 - tag: package-2024-07 - tag: package-2024-08 + - tag: package-2024-09 +``` + +### Tag: package-2024-09 and java + +These settings apply only when `--tag=package-2024-09` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2024-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2024_09_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2024_09_01 +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2024-08 and java diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md index c3e291f63af1..0af7e3522e48 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md @@ -34,7 +34,16 @@ These are the global settings for the ContainerServices API. ``` yaml openapi-type: arm -tag: package-2024-08 +tag: package-2024-09 +``` + +### Tag: package-2024-09 + +These settings apply only when `--tag=package-2024-09` is specified on the command line. + +``` yaml $(tag) == 'package-2024-09' +input-file: + - stable/2024-09-01/managedClusters.json ``` ### Tag: package-2024-08 diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md index ec776d2d87ff..28fe70051b10 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md @@ -16,9 +16,10 @@ no-namespace-folders: true Generate all API versions currently shipped for this package ```yaml $(python) -default-api-version: "2024-08-01" +default-api-version: "2024-09-01" multiapi: true batch: + - tag: package-2024-09 - tag: package-2024-08 - tag: package-2024-07 - tag: package-preview-2024-07 @@ -112,6 +113,16 @@ perform-load: false clear-output-folder: false ``` +### Tag: package-2024-09 and python + +These settings apply only when `--tag=package-2024-09 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2024-09' && $(python) +namespace: azure.mgmt.containerservice.v2024_09_01 +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2024_09_01 +``` + ### Tag: package-2024-08 and python These settings apply only when `--tag=package-2024-08 --python` is specified on the command line. diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsAbortOperation.json new file mode 100644 index 000000000000..7a5842fc7c48 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsAbortOperation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2024-09-01" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_CRG.json new file mode 100644 index 000000000000..ad82de44ad3a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_CRG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_CustomNodeConfig.json new file mode 100644 index 000000000000..da00c5a4fee9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_CustomNodeConfig.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..ca4c3202ef06 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_DedicatedHostGroup.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..a12a72fffadf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_EnableFIPS.json new file mode 100644 index 000000000000..bfd5f90d870a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_EnableFIPS.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..26fe800b8c8c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_EnableUltraSSD.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..ab4b34e6eaf4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "kubeletDiskType": "OS", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_GPUMIG.json new file mode 100644 index 000000000000..5829973e050c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_GPUMIG.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_OSSKU.json new file mode 100644 index 000000000000..4246d4cbbcc6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_OSSKU.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..24bcb4e7f589 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_Snapshot.json new file mode 100644 index 000000000000..b4f675c20d36 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_Snapshot.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..7f2330545d1a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..fc28f9095e8c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_WasmWasi.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_WasmWasi.json new file mode 100644 index 000000000000..de4a1493d31b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_WasmWasi.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json new file mode 100644 index 000000000000..bbb4ad4e3970 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_WindowsOSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_WindowsOSSKU.json new file mode 100644 index 000000000000..3e01a490aa0f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsCreate_WindowsOSSKU.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..4aaa939b796e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsDeleteMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsDeleteMachines.json new file mode 100644 index 000000000000..42789133189f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsDeleteMachines.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machines": { + "machineNames": [ + "aks-nodepool1-42263519-vmss00000a", + "aks-nodepool1-42263519-vmss00000b" + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..28246bcb8f0e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "eTag": "ebwiyfneowv", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..ab7d48caf008 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..adae3c353df9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsList.json new file mode 100644 index 000000000000..3a9753b44970 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "eTag": "ewnfuib" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..49e71c40bd88 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ContainerService/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2018-07-31" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPools_Start.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPools_Start.json new file mode 100644 index 000000000000..882c1a2d608a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPools_Start.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Running" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPools_Stop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPools_Stop.json new file mode 100644 index 000000000000..f3e2a976fac6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPools_Stop.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Stopped" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..286dcccb8a89 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPools_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/KubernetesVersions_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/KubernetesVersions_List.json new file mode 100644 index 000000000000..3ea6a914646b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/KubernetesVersions_List.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "values": [ + { + "version": "1.23", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.23.12": { + "upgrades": [ + "1.23.15", + "1.24.6", + "1.24.9" + ] + }, + "1.23.15": { + "upgrades": [ + "1.24.6", + "1.24.9" + ] + } + } + }, + { + "version": "1.24", + "isDefault": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.24.6": { + "upgrades": [ + "1.24.9", + "1.25.4", + "1.25.5" + ] + }, + "1.24.9": { + "upgrades": [ + "1.25.4", + "1.25.5" + ] + } + } + }, + { + "version": "1.25", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.25.4": { + "upgrades": [ + "1.25.5", + "1.26.0" + ] + }, + "1.25.5": { + "upgrades": [ + "1.26.0" + ] + } + } + }, + { + "version": "1.26", + "isPreview": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.26.0": { + "upgrades": [] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MachineGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MachineGet.json new file mode 100644 index 000000000000..578a8f0a68f8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MachineGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "26fe00f8-9173-4872-9134-bb1d2e00343a", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machineName": "aks-nodepool1-42263519-vmss00000t" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000", + "name": "aks-nodepool1-25481572-vmss000000", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "properties": { + "network": { + "ipAddresses": [ + { + "ip": "172.20.2.4", + "family": "IPv4" + }, + { + "ip": "10.0.0.1", + "family": "IPv4" + } + ] + }, + "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MachineList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MachineList.json new file mode 100644 index 000000000000..7e7639ebde4b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MachineList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "26fe00f8-9173-4872-9134-bb1d2e00343a", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000", + "name": "aks-nodepool1-25481572-vmss000000", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "properties": { + "network": { + "ipAddresses": [ + { + "ip": "172.20.2.4", + "family": "IPv4" + }, + { + "ip": "10.0.0.1", + "family": "IPv4" + } + ] + }, + "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0" + } + } + ], + "nextLink": "http://xxxx.azure.com?encodedToken=c2tpcFRva2VuPTE" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsCreate_Update.json new file mode 100644 index 000000000000..a849b92c803a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsCreate_Update.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default", + "parameters": { + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json new file mode 100644 index 000000000000..e76eacebd2ad --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedAutoUpgradeSchedule", + "parameters": { + "properties": { + "maintenanceWindow": { + "schedule": { + "relativeMonthly": { + "intervalMonths": 3, + "weekIndex": "First", + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsDelete.json new file mode 100644 index 000000000000..43d0c7cd008d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json new file mode 100644 index 000000000000..9b13f7f6caf9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsGet.json new file mode 100644 index 000000000000..49001bcec24b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json new file mode 100644 index 000000000000..76cdb6ff7a3d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 3 + } + }, + "durationHours": 4, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "09:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsList.json new file mode 100644 index 000000000000..fe0a1a0eb6d9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json new file mode 100644 index 000000000000..72e7819280ca --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 5 + } + }, + "durationHours": 10, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "13:30" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "absoluteMonthly": { + "intervalMonths": 3, + "dayOfMonth": 15 + } + }, + "durationHours": 5, + "utcOffset": "+00:00", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersAbortOperation.json new file mode 100644 index 000000000000..928e079a50a0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersAbortOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2024-09-01" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json new file mode 100644 index 000000000000..b3a45c1fe19d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json @@ -0,0 +1,259 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_AzureServiceMesh.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_AzureServiceMesh.json new file mode 100644 index 000000000000..79830c4c6091 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_AzureServiceMesh.json @@ -0,0 +1,346 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + } + } + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_CRG.json new file mode 100644 index 000000000000..9df8bdb0be4e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_CRG.json @@ -0,0 +1,254 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..607d614b2bc6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_DedicatedHostGroup.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_DisableRunCommand.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_DisableRunCommand.json new file mode 100644 index 000000000000..81f74d7e1589 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_DisableRunCommand.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_DualStackNetworking.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_DualStackNetworking.json new file mode 100644 index 000000000000..33ae6c652a5e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_DualStackNetworking.json @@ -0,0 +1,323 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + }, + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.22.1", + "currentKubernetesVersion": "1.22.1", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.22.1", + "currentOrchestratorVersion": "1.22.1", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.22.1", + "currentKubernetesVersion": "1.22.1", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.22.1", + "currentOrchestratorVersion": "1.22.1", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..09d56ca8abca --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..6dd3d0730d89 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_EnableUltraSSD.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_EnabledFIPS.json new file mode 100644 index 000000000000..5e940b898bf8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_EnabledFIPS.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_GPUMIG.json new file mode 100644 index 000000000000..77de6eadceb0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_GPUMIG.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_HTTPProxy.json new file mode 100644 index 000000000000..2531e00f9695 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_HTTPProxy.json @@ -0,0 +1,280 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json new file mode 100644 index 000000000000..2a7d23284397 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_ManagedNATGateway.json new file mode 100644 index 000000000000..a110db9b16ca --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_ManagedNATGateway.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "managedOutboundIPProfile": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json new file mode 100644 index 000000000000..6d5b847b4881 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_OSSKU.json new file mode 100644 index 000000000000..21fa3a8c9792 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_OSSKU.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..add188bf1844 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_PodIdentity.json new file mode 100644 index 000000000000..126f10b2455b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_PodIdentity.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_Premium.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_Premium.json new file mode 100644 index 000000000000..1c6d9bb697e7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_Premium.json @@ -0,0 +1,274 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json new file mode 100644 index 000000000000..caeba88d6662 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json @@ -0,0 +1,266 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json new file mode 100644 index 000000000000..70655389a2a6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_SecurityProfile.json new file mode 100644 index 000000000000..8ec74e3f65b9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_SecurityProfile.json @@ -0,0 +1,262 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_Snapshot.json new file mode 100644 index 000000000000..a424ab2390ab --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_Snapshot.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..54e74f7563d4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,317 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json new file mode 100644 index 000000000000..e96849206e1c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..ee5825483a93 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,295 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..d697b8847746 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json new file mode 100644 index 000000000000..a0dfad71174f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..6bff14fcd9b1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..7d7d082fa953 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "eTag": "beywbwei", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "eTag": "nvewbvoi", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..2bffd807bfee --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "a3ViZUNvbmZpZzE=" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..50f3c13c648e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet_MeshRevisionProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet_MeshRevisionProfile.json new file mode 100644 index 000000000000..58b23aed0adf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet_MeshRevisionProfile.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet_MeshUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet_MeshUpgradeProfile.json new file mode 100644 index 000000000000..5b772251ef5e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet_MeshUpgradeProfile.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersList.json new file mode 100644 index 000000000000..81692f6489ef --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersList.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "eTag": "nvweuib", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "eTag": "byuefvwi" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..c5206d8de045 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListClusterAdminCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListClusterAdminCredentials.json new file mode 100644 index 000000000000..d8b4ea56e2ff --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListClusterAdminCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json new file mode 100644 index 000000000000..d8b4ea56e2ff --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListClusterUserCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListClusterUserCredentials.json new file mode 100644 index 000000000000..d8b4ea56e2ff --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersListClusterUserCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersList_MeshRevisionProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersList_MeshRevisionProfiles.json new file mode 100644 index 000000000000..40b4397c02b9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersList_MeshRevisionProfiles.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersList_MeshUpgradeProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersList_MeshUpgradeProfiles.json new file mode 100644 index 000000000000..216dfb050a58 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersList_MeshUpgradeProfiles.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "asm-1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..e935a93eedab --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..4619a6a2edb9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..6bff14fcd9b1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json new file mode 100644 index 000000000000..6bff14fcd9b1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..6bff14fcd9b1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..6bff14fcd9b1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersStop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..4b49f8cb8457 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/Operation_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/Operation_List.json new file mode 100644 index 000000000000..a3a8072a9fce --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/Operation_List.json @@ -0,0 +1,3573 @@ +{ + "parameters": { + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets the status of an asynchronous operation", + "operation": "Get Operation", + "provider": "Microsoft Container Service", + "resource": "Operation" + }, + "name": "Microsoft.ContainerService/locations/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists the supported orchestrators", + "operation": "List Orchestrators", + "provider": "Microsoft Container Service", + "resource": "Orchestrator" + }, + "name": "Microsoft.ContainerService/locations/orchestrators/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists operations available on Microsoft.ContainerService resource provider", + "operation": "List Available Container Service Operations", + "provider": "Microsoft Container Service", + "resource": "Available Container Service Operations" + }, + "name": "Microsoft.ContainerService/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Registers Subscription with Microsoft.ContainerService resource provider", + "operation": "Register Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Register Subscription" + }, + "name": "Microsoft.ContainerService/register/action", + "origin": "user,system" + }, + { + "display": { + "description": "Unregisters Subscription with Microsoft.ContainerService resource provider", + "operation": "Unregister Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Unregister Subscription" + }, + "name": "Microsoft.ContainerService/unregister/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the status of an asynchronous operation result", + "operation": "Get Operation Result", + "provider": "Microsoft Container Service", + "resource": "OperationResult" + }, + "name": "Microsoft.ContainerService/locations/operationresults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a container service", + "operation": "Get Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new container service or updates an existing one", + "operation": "Create or Update Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a container service", + "operation": "Delete Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster", + "operation": "Get Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new managed cluster or updates an existing one", + "operation": "Create or Update Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a managed cluster", + "operation": "Delete Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Starts a managed cluster", + "operation": "Start Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/start/action", + "origin": "user,system" + }, + { + "display": { + "description": "Stops a managed cluster", + "operation": "Stop Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/stop/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets a maintenance configuration", + "operation": "Get a maintenance configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new MaintenanceConfiguration or updates an existing one", + "operation": "Create or Update maintenance configuratio", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a maintenance configuration", + "operation": "Delete Maintenance Configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an agent pool", + "operation": "Get Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new agent pool or updates an existing one", + "operation": "Create or Update Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes an agent pool", + "operation": "Delete Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the Agent Pool", + "operation": "Get Agent Pool UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Upgrade the node image version of agent pool", + "operation": "Upgrade agent pool node image version", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeNodeImageVersion/write", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available agent pool versions of the cluster", + "operation": "Get Available Agent Pool Versions", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/availableAgentPoolVersions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name", + "operation": "Get Managed Cluster AccessProfile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name using list credential", + "operation": "Get Managed Cluster AccessProfile by List Credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/listCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the cluster", + "operation": "Get UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "UpgradeProfile" + }, + "name": "Microsoft.ContainerService/managedClusters/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterAdmin credential of a managed cluster", + "operation": "List clusterAdmin credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterAdminCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterUser credential of a managed cluster", + "operation": "List clusterUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterMonitoringUser credential of a managed cluster", + "operation": "List clusterMonitoringUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterMonitoringUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the service principal profile of a managed cluster", + "operation": "Reset service principal profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetServicePrincipalProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Resolve the private link service id of a managed cluster", + "operation": "Resolve private link service id", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resolvePrivateLinkServiceId/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the AAD profile of a managed cluster", + "operation": "Reset AAD profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetAADProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Rotate certificates of a managed cluster", + "operation": "Rotate certificates of the cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/rotateClusterCertificates/action", + "origin": "user,system" + }, + { + "display": { + "description": "Run user issued command against managed kubernetes server.", + "operation": "RunCommand", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/runCommand/action", + "origin": "user,system" + }, + { + "display": { + "description": "Retrieve result from previous issued command.", + "operation": "CommandResult", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/commandResults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get the diagnostic setting for a managed cluster resource", + "operation": "Read Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/read", + "origin": "system" + }, + { + "display": { + "description": "Creates or updates the diagnostic setting for a managed cluster resource", + "operation": "Write Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/write", + "origin": "system" + }, + { + "display": { + "description": "Get Managed Cluster Detector", + "operation": "Get Managed Cluster Detector", + "provider": "Microsoft Container Service", + "resource": "Managed Cluster Detector" + }, + "name": "Microsoft.ContainerService/managedClusters/detectors/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the diagnostics state of the cluster", + "operation": "Get Diagnostics State", + "provider": "Microsoft Container Service", + "resource": "Diagnostics State" + }, + "name": "Microsoft.ContainerService/managedClusters/diagnosticsState/read", + "origin": "user,system" + }, + { + "display": { + "description": "Determines if user is allowed to approve a private endpoint connection", + "operation": "Approve Private Endpoint Connections", + "provider": "Microsoft Container Service", + "resource": "Approve Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnectionsApproval/action", + "origin": "user,system" + }, + { + "display": { + "description": "Get private endpoint connection", + "operation": "Get private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/read", + "origin": "user,system" + }, + { + "display": { + "description": "Approve or Reject a private endpoint connection", + "operation": "Update private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete private endpoint connection", + "operation": "Delete private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an extension addon", + "operation": "Get an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/read", + "origin": "system" + }, + { + "display": { + "description": "Creates a new extension addon or updates an existing one", + "operation": "Create or Update extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/write", + "origin": "system" + }, + { + "display": { + "description": "Deletes an extension addon", + "operation": "Delete an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/delete", + "origin": "system" + }, + { + "display": { + "description": "Get a snapshot", + "operation": "Get Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new snapshot", + "operation": "Create Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a snapshot", + "operation": "Delete Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get eventgrid filter", + "operation": "Get eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/read", + "origin": "system" + }, + { + "display": { + "description": "Create or Update eventgrid filter", + "operation": "Create or Update eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/write", + "origin": "system" + }, + { + "display": { + "description": "Delete an eventgrid filter", + "operation": "Delete an eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/delete", + "origin": "system" + }, + { + "display": { + "description": "Reads initializerconfigurations", + "operation": "Gets/List initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes initializerconfigurations", + "operation": "Creates/Updates initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes/DeletesCollection initializerconfigurations resource", + "operation": "Initializerconfigurations", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads mutatingwebhookconfigurations", + "operation": "Gets/List mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes mutatingwebhookconfigurations", + "operation": "Creates/Updates mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes mutatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads validatingwebhookconfigurations", + "operation": "Gets/List validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes validatingwebhookconfigurations", + "operation": "Creates/Updates validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes validatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads customresourcedefinitions", + "operation": "Gets/List customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes customresourcedefinitions", + "operation": "Creates/Updates customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes customresourcedefinitions", + "operation": "Deletes/DeletesCollection customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservices", + "operation": "Gets/List apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes apiservices", + "operation": "Creates/Updates apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes apiservices", + "operation": "Deletes/DeletesCollection apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads controllerrevisions", + "operation": "Gets/List controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes controllerrevisions", + "operation": "Creates/Updates controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes controllerrevisions", + "operation": "Deletes/DeletesCollection controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads statefulsets", + "operation": "Gets/List statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes statefulsets", + "operation": "Creates/Updates statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes statefulsets", + "operation": "Deletes/DeletesCollection statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes tokenreviews", + "operation": "Creates/Updates tokenreviews resource", + "provider": "Microsoft Container Service", + "resource": "Tokenreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/tokenreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes localsubjectaccessreviews", + "operation": "Creates/Updates localsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Localsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/localsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectaccessreviews", + "operation": "Creates/Updates selfsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectrulesreviews", + "operation": "Creates/Updates selfsubjectrulesreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectrulesreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectrulesreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes subjectaccessreviews", + "operation": "Creates/Updates subjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Subjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/subjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads horizontalpodautoscalers", + "operation": "Gets/List horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes horizontalpodautoscalers", + "operation": "Creates/Updates horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes horizontalpodautoscalers", + "operation": "Deletes/DeletesCollection horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads cronjobs", + "operation": "Gets/List cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes cronjobs", + "operation": "Creates/Updates cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes cronjobs", + "operation": "Deletes/DeletesCollection cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads jobs", + "operation": "Gets/List jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes jobs", + "operation": "Creates/Updates jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes jobs", + "operation": "Deletes/DeletesCollection jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificatesigningrequests", + "operation": "Gets/List certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes certificatesigningrequests", + "operation": "Creates/Updates certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes certificatesigningrequests", + "operation": "Deletes/DeletesCollection certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads leases", + "operation": "Gets/List leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes leases", + "operation": "Creates/Updates leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes leases", + "operation": "Deletes/DeletesCollection leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes bindings", + "operation": "Creates/Updates bindings resource", + "provider": "Microsoft Container Service", + "resource": "Bindings" + }, + "name": "Microsoft.ContainerService/managedClusters/bindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads componentstatuses", + "operation": "Gets/List componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes componentstatuses", + "operation": "Creates/Updates componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes componentstatuses", + "operation": "Deletes/DeletesCollection componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads configmaps", + "operation": "Gets/List configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes configmaps", + "operation": "Creates/Updates configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes configmaps", + "operation": "Deletes/DeletesCollection configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads endpoints", + "operation": "Gets/List endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes endpoints", + "operation": "Creates/Updates endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes endpoints", + "operation": "Deletes/DeletesCollection endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads limitranges", + "operation": "Gets/List limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes limitranges", + "operation": "Creates/Updates limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes limitranges", + "operation": "Deletes/DeletesCollection limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads namespaces", + "operation": "Gets/List namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes namespaces", + "operation": "Creates/Updates namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes namespaces", + "operation": "Deletes/DeletesCollection namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes nodes", + "operation": "Creates/Updates nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes nodes", + "operation": "Deletes/DeletesCollection nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumeclaims", + "operation": "Gets/List persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumeclaims", + "operation": "Creates/Updates persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumeclaims", + "operation": "Deletes/DeletesCollection persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumes", + "operation": "Gets/List persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumes", + "operation": "Creates/Updates persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumes", + "operation": "Deletes/DeletesCollection persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes pods", + "operation": "Creates/Updates pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes pods", + "operation": "Deletes/DeletesCollection pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Exec into pods resource", + "operation": "Exec into pods resource ", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/exec/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podtemplates", + "operation": "Gets/List podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podtemplates", + "operation": "Creates/Updates podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podtemplates", + "operation": "Deletes/DeletesCollection podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicationcontrollers", + "operation": "Gets/List replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicationcontrollers", + "operation": "Creates/Updates replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicationcontrollers", + "operation": "Deletes/DeletesCollection replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resourcequotas", + "operation": "Gets/List resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes resourcequotas", + "operation": "Creates/Updates resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes resourcequotas", + "operation": "Deletes/DeletesCollection resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads secrets", + "operation": "Gets/List secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes secrets", + "operation": "Creates/Updates secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes secrets", + "operation": "Deletes/DeletesCollection secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads serviceaccounts", + "operation": "Gets/List serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes serviceaccounts", + "operation": "Creates/Updates serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes serviceaccounts", + "operation": "Deletes/DeletesCollection serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads services", + "operation": "Gets/List services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes services", + "operation": "Creates/Updates services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes services", + "operation": "Deletes/DeletesCollection services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads runtimeclasses", + "operation": "Gets/List runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes runtimeclasses", + "operation": "Creates/Updates runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes runtimeclasses", + "operation": "Deletes/DeletesCollection runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api", + "operation": "Gets/List api resource", + "provider": "Microsoft Container Service", + "resource": "Api" + }, + "name": "Microsoft.ContainerService/managedClusters/api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api/v1", + "operation": "Gets/List api/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Api/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/api/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apis", + "operation": "Gets/List apis resource", + "provider": "Microsoft Container Service", + "resource": "Apis" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io", + "operation": "Gets/List admissionregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1", + "operation": "Gets/List admissionregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1beta1", + "operation": "Gets/List admissionregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io", + "operation": "Gets/List apiextensions.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1", + "operation": "Gets/List apiextensions.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1beta1", + "operation": "Gets/List apiextensions.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io", + "operation": "Gets/List apiregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1", + "operation": "Gets/List apiregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1beta1", + "operation": "Gets/List apiregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps", + "operation": "Gets/List apps resource", + "provider": "Microsoft Container Service", + "resource": "Apps" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1", + "operation": "Gets/List apps/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta1", + "operation": "Gets/List apps/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta2", + "operation": "Gets/List apps/v1beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io", + "operation": "Gets/List authentication.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1", + "operation": "Gets/List authentication.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1beta1", + "operation": "Gets/List authentication.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io", + "operation": "Gets/List authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1", + "operation": "Gets/List authorization.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1beta1", + "operation": "Gets/List authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling", + "operation": "Gets/List autoscaling resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v1", + "operation": "Gets/List autoscaling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta1", + "operation": "Gets/List autoscaling/v2beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta2", + "operation": "Gets/List autoscaling/v2beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch", + "operation": "Gets/List batch resource", + "provider": "Microsoft Container Service", + "resource": "Batch" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1", + "operation": "Gets/List batch/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1beta1", + "operation": "Gets/List batch/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io", + "operation": "Gets/List certificates.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io/v1beta1", + "operation": "Gets/List certificates.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io", + "operation": "Gets/List coordination.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination/v1", + "operation": "Gets/List coordination/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io/v1beta1", + "operation": "Gets/List coordination.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io", + "operation": "Gets/List events.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io/v1beta1", + "operation": "Gets/List events.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions", + "operation": "Gets/List extensions resource", + "provider": "Microsoft Container Service", + "resource": "Extensions" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions/v1beta1", + "operation": "Gets/List extensions/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Extensions/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io", + "operation": "Gets/List metrics.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io/v1beta1", + "operation": "Gets/List metrics.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io", + "operation": "Gets/List networking.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking/v1", + "operation": "Gets/List networking/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io/v1beta1", + "operation": "Gets/List networking.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io", + "operation": "Gets/List node.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io/v1beta1", + "operation": "Gets/List node.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy", + "operation": "Gets/List policy resource", + "provider": "Microsoft Container Service", + "resource": "Policy" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy/v1beta1", + "operation": "Gets/List policy/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Policy/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io", + "operation": "Gets/List rbac.authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization/v1", + "operation": "Gets/List rbac.authorization/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io/v1beta1", + "operation": "Gets/List rbac.authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io", + "operation": "Gets/List scheduling.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling/v1", + "operation": "Gets/List scheduling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io/v1beta1", + "operation": "Gets/List scheduling.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io", + "operation": "Gets/List storage.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage/v1", + "operation": "Gets/List storage/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io/v1beta1", + "operation": "Gets/List storage.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads healthz", + "operation": "Gets/List healthz resource", + "provider": "Microsoft Container Service", + "resource": "Healthz" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads livez", + "operation": "Gets/List livez resource", + "provider": "Microsoft Container Service", + "resource": "Livez" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads logs", + "operation": "Gets/List logs resource", + "provider": "Microsoft Container Service", + "resource": "Logs" + }, + "name": "Microsoft.ContainerService/managedClusters/logs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics", + "operation": "Gets/List metrics resource", + "provider": "Microsoft Container Service", + "resource": "Metrics" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads v2", + "operation": "Gets/List v2 resource", + "provider": "Microsoft Container Service", + "resource": "Openapi/V2" + }, + "name": "Microsoft.ContainerService/managedClusters/openapi/v2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads readyz", + "operation": "Gets/List readyz resource", + "provider": "Microsoft Container Service", + "resource": "Readyz" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads shutdown", + "operation": "Gets/List shutdown resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Shutdown" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/shutdown/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resetMetrics", + "operation": "Gets/List resetMetrics resource", + "provider": "Microsoft Container Service", + "resource": "Resetmetrics" + }, + "name": "Microsoft.ContainerService/managedClusters/resetMetrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-ui", + "operation": "Gets/List swagger-ui resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-api", + "operation": "Gets/List swagger-api resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Api" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ui", + "operation": "Gets/List ui resource", + "provider": "Microsoft Container Service", + "resource": "Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads version", + "operation": "Gets/List version resource", + "provider": "Microsoft Container Service", + "resource": "Version" + }, + "name": "Microsoft.ContainerService/managedClusters/version/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads poddisruptionbudgets", + "operation": "Gets/List poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes poddisruptionbudgets", + "operation": "Creates/Updates poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes poddisruptionbudgets", + "operation": "Deletes/DeletesCollection poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterrolebindings", + "operation": "Gets/List clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterrolebindings", + "operation": "Creates/Updates clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterrolebindings", + "operation": "Deletes/DeletesCollection clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterroles", + "operation": "Gets/List clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterroles", + "operation": "Creates/Updates clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterroles", + "operation": "Deletes/DeletesCollection clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rolebindings", + "operation": "Gets/List rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes rolebindings", + "operation": "Creates/Updates rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes rolebindings", + "operation": "Deletes/DeletesCollection rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads roles", + "operation": "Gets/List roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes roles", + "operation": "Creates/Updates roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes roles", + "operation": "Deletes/DeletesCollection roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads priorityclasses", + "operation": "Gets/List priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes priorityclasses", + "operation": "Creates/Updates priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes priorityclasses", + "operation": "Deletes/DeletesCollection priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Use action on podsecuritypolicies", + "operation": "Use podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/use/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds clusterroles", + "operation": "Bind clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates", + "operation": "Escalate clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds roles", + "operation": "Bind roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates roles", + "operation": "Escalate roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate serviceaccounts", + "operation": "Impersonate serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate users", + "operation": "Impersonate users resource", + "provider": "Microsoft Container Service", + "resource": "Users" + }, + "name": "Microsoft.ContainerService/managedClusters/users/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate groups", + "operation": "Impersonate groups resource", + "provider": "Microsoft Container Service", + "resource": "Groups" + }, + "name": "Microsoft.ContainerService/managedClusters/groups/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate userextras", + "operation": "Impersonate userextras resource", + "provider": "Microsoft Container Service", + "resource": "Userextras" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/userextras/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storageclasses", + "operation": "Gets/List storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes storageclasses", + "operation": "Creates/Updates storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes storageclasses", + "operation": "Deletes/DeletesCollection storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads volumeattachments", + "operation": "Gets/List volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes volumeattachments", + "operation": "Creates/Updates volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes volumeattachments", + "operation": "Deletes/DeletesCollection volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csidrivers", + "operation": "Gets/List csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csidrivers", + "operation": "Creates/Updates csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csidrivers", + "operation": "Deletes/DeletesCollection csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csinodes", + "operation": "Gets/List csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csinodes", + "operation": "Creates/Updates csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csinodes", + "operation": "Deletes/DeletesCollection csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available metrics for Managed Cluster", + "operation": "Read Managed Cluster metric definitions", + "provider": "Microsoft Container Service", + "resource": "The metric definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/metricDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Gets the available logs for Managed Cluster", + "operation": "Read Managed Cluster log definitions", + "provider": "Microsoft Container Service", + "resource": "The log definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/logDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Get a Open Shift Managed Cluster", + "operation": "Get Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Managed Cluster or updates an existing one", + "operation": "Create or Update Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Managed Cluster", + "operation": "Delete Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a Open Shift Cluster", + "operation": "Get Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Cluster or updates an existing one", + "operation": "Create or Update Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Cluster", + "operation": "Delete Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/delete", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..40da2ba0058c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "images", + "endpoints": [ + { + "domainName": "mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.data.mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https", + "description": "mcr cdn" + } + ] + } + ] + }, + { + "category": "artifacts", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "acs-mirror.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "time-sync", + "endpoints": [ + { + "domainName": "ntp.ubuntu.com", + "endpointDetails": [ + { + "port": 123, + "protocol": "UDP" + } + ] + } + ] + }, + { + "category": "ubuntu-optional", + "endpoints": [ + { + "domainName": "security.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "changelogs.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "gpu", + "endpoints": [ + { + "domainName": "nvidia.github.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "us.download.nvidia.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "apt.dockerproject.org", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "windows", + "endpoints": [ + { + "domainName": "onegetcdn.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "go.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.mp.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "www.msftconnecttest.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "ctldl.windowsupdate.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "apiserver", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "tunnel-classic", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 9000, + "protocol": "TCP" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..664f85b7e604 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..ff32006396c0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..9d89af5a485c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..0283be59d882 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..8a5b4732a0ed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..d29b4fb4d888 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/RunCommandRequest.json new file mode 100644 index 000000000000..29b5e0ed533b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/RunCommandRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "requestPayload": { + "command": "kubectl apply -f ns.yaml", + "context": "", + "clusterToken": "" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-09-01" + } + }, + "200": { + "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE", + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/RunCommandResultFailed.json new file mode 100644 index 000000000000..1b79577562f9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/RunCommandResultFailed.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-09-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "failed", + "reason": "ImagePullBackoff" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/RunCommandResultSucceed.json new file mode 100644 index 000000000000..5572cc66b528 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/RunCommandResultSucceed.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2024-09-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsCreate.json new file mode 100644 index 000000000000..f9621e3ebf9a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsDelete.json new file mode 100644 index 000000000000..113236c64f95 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsGet.json new file mode 100644 index 000000000000..d2322d2afdfa --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsList.json new file mode 100644 index 000000000000..ca8830310b0e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..75d4fdc2ff54 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsUpdateTags.json new file mode 100644 index 000000000000..159ee4b76bd5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/SnapshotsUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json new file mode 100644 index 000000000000..f3f89c5d043f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoleBindings_CreateOrUpdate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1", + "trustedAccessRoleBinding": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoleBindings_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoleBindings_Delete.json new file mode 100644 index 000000000000..b981b56248b6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoleBindings_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoleBindings_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoleBindings_Get.json new file mode 100644 index 000000000000..fb222d2c1354 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoleBindings_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoleBindings_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoleBindings_List.json new file mode 100644 index 000000000000..e526a0eb9278 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoleBindings_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoles_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoles_List.json new file mode 100644 index 000000000000..f9fc854c675b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/TrustedAccessRoles_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sourceResourceType": "Microsoft.MachineLearningServices/workspaces", + "name": "reader", + "rules": [ + { + "verbs": [ + "get" + ], + "apiGroups": [ + "" + ], + "resources": [ + "pods" + ], + "resourceNames": [], + "nonResourceURLs": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/managedClusters.json new file mode 100644 index 000000000000..559eabeaab29 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/managedClusters.json @@ -0,0 +1,7994 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2024-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "Operations_List", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List available operations for the container service resource provider": { + "$ref": "./examples/Operation_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListKubernetesVersions", + "summary": "Gets a list of supported Kubernetes versions in the specified subscription.", + "description": "Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubernetesVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Kubernetes Versions": { + "$ref": "./examples/KubernetesVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets the upgrade profile of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Lists the admin credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterAdminCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Lists the user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + }, + { + "$ref": "#/parameters/CredentialFormatParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterUserCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Lists the cluster monitoring user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterMonitoringUserCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The managed cluster to create or update." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "The request should only proceed if no entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + } + ], + "responses": { + "200": { + "description": "The existing managed cluster was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "The new managed cluster was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create Managed Cluster with OSSKU": { + "$ref": "./examples/ManagedClustersCreate_OSSKU.json" + }, + "Create Managed Cluster with GPUMIG": { + "$ref": "./examples/ManagedClustersCreate_GPUMIG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + }, + "Create Managed Cluster with EncryptionAtHost enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json" + }, + "Create Managed Cluster with UltraSSD enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json" + }, + "Create Managed Cluster with PodIdentity enabled": { + "$ref": "./examples/ManagedClustersCreate_PodIdentity.json" + }, + "Create Managed Private Cluster with fqdn subdomain specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json" + }, + "Create Managed Private Cluster with Public FQDN specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json" + }, + "Create Managed Cluster with RunCommand disabled": { + "$ref": "./examples/ManagedClustersCreate_DisableRunCommand.json" + }, + "Create Managed Cluster with LongTermSupport": { + "$ref": "./examples/ManagedClustersCreate_Premium.json" + }, + "Create Managed Cluster with Node Public IP Prefix": { + "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json" + }, + "Create Managed Cluster with Azure KeyVault Secrets Provider Addon": { + "$ref": "./examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json" + }, + "Create Managed Cluster with FIPS enabled OS": { + "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json" + }, + "Create Managed Cluster with HTTP proxy configured": { + "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json" + }, + "Create Managed Cluster with Security Profile configured": { + "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json" + }, + "Create Managed Cluster with Web App Routing Ingress Profile configured": { + "$ref": "./examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json" + }, + "Create Managed Cluster with AKS-managed NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json" + }, + "Create Managed Cluster with user-assigned NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json" + }, + "Create Managed Cluster using an agent pool snapshot": { + "$ref": "./examples/ManagedClustersCreate_Snapshot.json" + }, + "Create/Update Managed Cluster with Windows gMSA enabled": { + "$ref": "./examples/ManagedClustersCreate_UpdateWindowsGmsa.json" + }, + "Create/Update Managed Cluster with dual-stack networking": { + "$ref": "./examples/ManagedClustersCreate_DualStackNetworking.json" + }, + "Create Managed Cluster with Capacity Reservation Group": { + "$ref": "./examples/ManagedClustersCreate_CRG.json" + }, + "Create Managed Cluster with Dedicated Host Group": { + "$ref": "./examples/ManagedClustersCreate_DedicatedHostGroup.json" + }, + "Create/Update Managed Cluster with Azure Service Mesh": { + "$ref": "./examples/ManagedClustersCreate_AzureServiceMesh.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_ListByManagedCluster", + "summary": "Gets a list of maintenance configurations in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List maintenance configurations by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList.json" + }, + "List maintenance configurations configured with maintenance window by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Get", + "summary": "Gets the specified maintenance configuration of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsGet.json" + }, + "Get Maintenance Configuration Configured With Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsGet_MaintenanceWindow.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "summary": "Creates or updates a maintenance configuration in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The maintenance configuration to create or update." + } + ], + "responses": { + "200": { + "description": "The existing maintenance configuration was successfully updated.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "201": { + "description": "The new maintenance configuration was successfully created.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create/Update Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update.json" + }, + "Create/Update Maintenance Configuration with Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Delete", + "summary": "Deletes a maintenance configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Delete Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsDelete.json" + }, + "Delete Maintenance Configuration For Node OS Upgrade": { + "$ref": "./examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_AbortLatestOperation", + "summary": "Aborts last operation running on agent pool.", + "description": "Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on agent pool": { + "$ref": "./examples/AgentPoolsAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the specified managed cluster agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The agent pool to create or update." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "The request should only proceed if no entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + } + ], + "responses": { + "200": { + "description": "The existing agent pool was successfully updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "The new agent pool was successfully created.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with OSSKU": { + "$ref": "./examples/AgentPoolsCreate_OSSKU.json" + }, + "Create Agent Pool with Windows OSSKU": { + "$ref": "./examples/AgentPoolsCreate_WindowsOSSKU.json" + }, + "Create Windows Agent Pool with disabling OutboundNAT": { + "$ref": "./examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json" + }, + "Create Agent Pool with GPUMIG": { + "$ref": "./examples/AgentPoolsCreate_GPUMIG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + }, + "Create Agent Pool with KubeletConfig and LinuxOSConfig": { + "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json" + }, + "Create Agent Pool with EncryptionAtHost enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json" + }, + "Create Agent Pool with UltraSSD enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json" + }, + "Create Agent Pool with FIPS enabled OS": { + "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json" + }, + "Create Agent Pool using an agent pool snapshot": { + "$ref": "./examples/AgentPoolsCreate_Snapshot.json" + }, + "Create Agent Pool with Krustlet and the WASI runtime": { + "$ref": "./examples/AgentPoolsCreate_WasmWasi.json" + }, + "Stop Agent Pool": { + "$ref": "./examples/AgentPools_Stop.json" + }, + "Start Agent Pool": { + "$ref": "./examples/AgentPools_Start.json" + }, + "Create Agent Pool with Capacity Reservation Group": { + "$ref": "./examples/AgentPoolsCreate_CRG.json" + }, + "Create Agent Pool with Dedicated Host Group": { + "$ref": "./examples/AgentPoolsCreate_DedicatedHostGroup.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "#/parameters/IgnorePodDisruptionBudgetParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets the upgrade profile for an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/deleteMachines": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_DeleteMachines", + "summary": "Deletes specific machines in an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "machines", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPoolDeleteMachinesParameter" + }, + "description": "A list of machines from the agent pool to be deleted." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Specific Machines in an Agent Pool": { + "$ref": "./examples/AgentPoolsDeleteMachines.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.", + "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset the Service Principal Profile of a managed cluster.", + "description": "This action cannot be performed on a cluster that is not using a service principal", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "The service principal profile to set on the managed cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset the AAD Profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "The AAD profile to set on the Managed Cluster" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotates the certificates of a managed cluster.", + "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_AbortLatestOperation", + "summary": "Aborts last operation running on managed cluster.", + "description": "Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on managed cluster": { + "$ref": "./examples/ManagedClustersAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateServiceAccountSigningKeys", + "summary": "Rotates the service account signing keys of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Service Account Signing Keys": { + "$ref": "./examples/ManagedClustersRotateServiceAccountSigningKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stops a Managed Cluster", + "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Starts a previously stopped Managed Cluster", + "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the specified private endpoint connection.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The updated private endpoint connection." + } + ], + "responses": { + "200": { + "description": "The existing private endpoint connection was successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The new private endpoint connection was successfully created.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_UpgradeNodeImageVersion", + "summary": "Upgrades the node image version of an agent pool to the latest.", + "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters required in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RunCommand", + "summary": "Submits a command to run against the Managed Cluster.", + "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "requestPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandRequest" + }, + "description": "The run command request" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "200": { + "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "submitNewCommand": { + "$ref": "./examples/RunCommandRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetCommandResult", + "summary": "Gets the results of a command which has been run on the Managed Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the command." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "200": { + "description": "command finished", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "commandSucceedResult": { + "$ref": "./examples/RunCommandResultSucceed.json" + }, + "commandFailedResult": { + "$ref": "./examples/RunCommandResultFailed.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints", + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.", + "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Managed Cluster": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Gets a list of snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots": { + "$ref": "./examples/SnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "summary": "Lists snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots by Resource Group": { + "$ref": "./examples/SnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Gets a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Snapshot": { + "$ref": "./examples/SnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "summary": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "201": { + "description": "The new snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Snapshot": { + "$ref": "./examples/SnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_UpdateTags", + "summary": "Updates tags on a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Snapshot Tags": { + "$ref": "./examples/SnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Snapshot": { + "$ref": "./examples/SnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshRevisionProfiles", + "summary": "Lists mesh revision profiles for all meshes in the specified location.", + "description": "Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List mesh revision profiles in a location": { + "$ref": "./examples/ManagedClustersList_MeshRevisionProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshRevisionProfile", + "summary": "Gets a mesh revision profile for a specified mesh in the specified location.", + "description": "Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a mesh revision profile for a mesh mode": { + "$ref": "./examples/ManagedClustersGet_MeshRevisionProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshUpgradeProfiles", + "summary": "Lists available upgrades for all service meshes in a specific cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists version compatibility and upgrade profile for all service meshes in a cluster": { + "$ref": "./examples/ManagedClustersList_MeshUpgradeProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshUpgradeProfile", + "summary": "Gets available upgrades for a service mesh in a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets version compatibility and upgrade profile for a service mesh in a cluster": { + "$ref": "./examples/ManagedClustersGet_MeshUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_List", + "summary": "List trusted access role bindings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBindingListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access role bindings": { + "$ref": "./examples/TrustedAccessRoleBindings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Get", + "summary": "Get a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Get.json" + } + } + }, + "put": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_CreateOrUpdate", + "summary": "Create or update a trusted access role binding", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + }, + { + "name": "trustedAccessRoleBinding", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "A trusted access role binding" + } + ], + "responses": { + "200": { + "description": "The existing trusted access role binding was successfully updated.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "201": { + "description": "The new trusted access role binding was successfully created.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Delete", + "summary": "Delete a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoles_List", + "summary": "List supported trusted access roles.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access roles": { + "$ref": "./examples/TrustedAccessRoles_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines": { + "get": { + "operationId": "Machines_List", + "summary": "Gets a list of machines in the specified agent pool.", + "tags": [ + "Machines" + ], + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Machines in an Agentpool by Managed Cluster": { + "$ref": "./examples/MachineList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines/{machineName}": { + "get": { + "operationId": "Machines_Get", + "summary": "Get a specific machine in the specified agent pool.", + "tags": [ + "Machines" + ], + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "#/parameters/MachineNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a Machine in an Agent Pools by Managed Cluster": { + "$ref": "./examples/MachineGet.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "x-ms-identifiers": [], + "description": "The list of operations" + } + }, + "description": "The List Operation response." + }, + "OperationValue": { + "type": "object", + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Operation Value Display." + } + }, + "description": "Describes the properties of a Operation value." + }, + "OperationValueDisplay": { + "type": "object", + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Operation Value Display." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 2048, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ManagedClusterServicePrincipalProfile": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "ManagedClusterAgentPoolProfileProperties": { + "type": "object", + "properties": { + "eTag": { + "type": "string", + "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "type": "string", + "title": "The size of the agent pool VMs.", + "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "workloadRuntime": { + "$ref": "#/definitions/WorkloadRuntime" + }, + "vnetSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which agent pool nodes and optionally pods will join on startup.", + "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which pods will join when launched.", + "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "scaleDownMode": { + "$ref": "#/definitions/ScaleDownMode", + "title": "The scale down mode to use when scaling the Agent Pool.", + "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete." + }, + "type": { + "$ref": "#/definitions/AgentPoolType" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode" + }, + "orchestratorVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)." + }, + "currentOrchestratorVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes the Agent Pool is running.", + "description": "If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "powerState": { + "title": "Whether the Agent Pool is running or stopped.", + "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'." + }, + "enableNodePublicIP": { + "type": "boolean", + "title": "Whether each node is allocated its own public IP.", + "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "title": "The public IP prefix ID which VM nodes should use IPs from.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "title": "The Virtual Machine Scale Set eviction policy to use.", + "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the agent pool nodes." + }, + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux agent nodes." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "title": "Whether to enable host based OS and data drive encryption.", + "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption" + }, + "enableUltraSSD": { + "type": "boolean", + "description": "Whether to enable UltraSSD" + }, + "enableFIPS": { + "type": "boolean", + "title": "Whether to use a FIPS-enabled OS.", + "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details." + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot." + }, + "capacityReservationGroupID": { + "$ref": "#/definitions/CapacityReservationGroupID", + "description": "AKS will associate the specified agent pool with the Capacity Reservation Group." + }, + "hostGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/hostGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)." + }, + "networkProfile": { + "$ref": "#/definitions/AgentPoolNetworkProfile", + "description": "Network-related settings of an agent pool." + }, + "windowsProfile": { + "$ref": "#/definitions/AgentPoolWindowsProfile", + "description": "The Windows agent pool's specific profile." + }, + "securityProfile": { + "$ref": "#/definitions/AgentPoolSecurityProfile", + "description": "The security settings of an agent pool." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "AgentPoolNetworkProfile": { + "type": "object", + "properties": { + "nodePublicIPTags": { + "$ref": "#/definitions/NodePublicIPTags", + "description": "IPTags of instance-level public IPs." + }, + "allowedHostPorts": { + "type": "array", + "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap.", + "items": { + "$ref": "#/definitions/PortRange" + }, + "x-ms-identifiers": [] + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/applicationSecurityGroups" + } + ] + } + }, + "description": "The IDs of the application security groups which agent pool will associate when created." + } + }, + "description": "Network settings of an agent pool." + }, + "NodePublicIPTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IPTag" + }, + "x-ms-identifiers": [], + "description": "The list of tags associated with the node public IP address." + }, + "IPTag": { + "type": "object", + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type. Example: RoutingPreference." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag associated with the public IP. Example: Internet." + } + }, + "description": "Contains the IPTag associated with the object." + }, + "PortRange": { + "type": "object", + "description": "The port range.", + "properties": { + "portStart": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd." + }, + "portEnd": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart." + }, + "protocol": { + "type": "string", + "description": "The network protocol of the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true, + "values": [ + { + "value": "TCP", + "description": "TCP protocol." + }, + { + "value": "UDP", + "description": "UDP protocol." + } + ] + } + } + } + }, + "ManagedClusterAgentPoolProfile": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + } + ], + "properties": { + "name": { + "type": "string", + "title": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "description": "Windows agent pool names must be 6 characters or less.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + }, + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true, + "values": [ + { + "value": "VirtualMachineScaleSets", + "description": "Create an Agent Pool backed by a Virtual Machine Scale Set." + }, + { + "value": "AvailabilitySet", + "description": "Use of this is strongly discouraged." + } + ] + }, + "description": "The type of Agent Pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory." + }, + { + "value": "User", + "description": "User agent pools are primarily for hosting your application pods." + } + ] + }, + "title": "The mode of an agent pool.", + "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools" + }, + "AgentPoolListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "properties": { + "maxSurge": { + "type": "string", + "title": "The maximum number or percentage of nodes that are surged during upgrade.", + "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade" + }, + "drainTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 1440, + "minimum": 1, + "title": "The drain timeout for a node", + "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes." + }, + "nodeSoakDurationInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 30, + "minimum": 0, + "title": "The soak duration for a node", + "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes." + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + }, + "description": "Agent Pool." + }, + "ManagedClusterWindowsProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**Restriction:** Cannot end in \".\"

**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

**Minimum-length:** 1 character

**Max-length:** 20 characters" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"" + }, + "licenseType": { + "type": "string", + "enum": [ + "None", + "Windows_Server" + ], + "x-ms-enum": { + "name": "licenseType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No additional licensing is applied." + }, + { + "value": "Windows_Server", + "description": "Enables Azure Hybrid User Benefits for Windows VMs." + } + ] + }, + "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details." + }, + "enableCSIProxy": { + "type": "boolean", + "title": "Whether to enable CSI proxy.", + "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)." + }, + "gmsaProfile": { + "$ref": "#/definitions/WindowsGmsaProfile", + "description": "The Windows gMSA Profile in the Managed Cluster." + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the managed cluster." + }, + "WindowsGmsaProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable Windows gMSA.", + "description": "Specifies whether to enable Windows gMSA in the managed cluster." + }, + "dnsServer": { + "type": "string", + "description": "Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + }, + "rootDomainName": { + "type": "string", + "description": "Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + } + }, + "description": "Windows gMSA Profile in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ManagedClusterNodeResourceGroupProfile": { + "type": "object", + "properties": { + "restrictionLevel": { + "type": "string", + "enum": [ + "Unrestricted", + "ReadOnly" + ], + "x-ms-enum": { + "name": "RestrictionLevel", + "modelAsString": true, + "values": [ + { + "value": "Unrestricted", + "description": "All RBAC permissions are allowed on the managed node resource group" + }, + { + "value": "ReadOnly", + "description": "Only */read RBAC permissions allowed on the managed node resource group" + } + ] + }, + "description": "The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted'" + } + }, + "description": "Node resource group lockdown profile for a managed cluster." + }, + "ContainerServiceNetworkProfile": { + "type": "object", + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet", + "none" + ], + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + }, + { + "value": "none", + "description": "No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPluginMode": { + "type": "string", + "enum": [ + "overlay" + ], + "x-ms-enum": { + "name": "NetworkPluginMode", + "modelAsString": true, + "values": [ + { + "value": "overlay", + "description": "Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay." + } + ] + }, + "description": "The mode the network plugin should use." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "none", + "calico", + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "none", + "description": "Network policies will not be enforced. This is the default value when NetworkPolicy is not specified." + }, + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "cilium", + "description": "Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "networkDataplane": { + "type": "string", + "enum": [ + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "networkDataplane", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use Azure network dataplane." + }, + { + "value": "cilium", + "description": "Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information." + } + ] + }, + "description": "Network dataplane used in the Kubernetes cluster." + }, + "advancedNetworking": { + "$ref": "#/definitions/AdvancedNetworking" + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting", + "managedNATGateway", + "userAssignedNATGateway" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + }, + { + "value": "managedNATGateway", + "description": "The AKS-managed NAT gateway is used for egress." + }, + { + "value": "userAssignedNATGateway", + "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration." + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + }, + "natGatewayProfile": { + "$ref": "#/definitions/ManagedClusterNATGatewayProfile", + "description": "Profile of the cluster NAT gateway." + }, + "podCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign pod IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking." + }, + "serviceCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign service cluster IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges." + }, + "ipFamilies": { + "type": "array", + "items": { + "type": "string", + "description": "The IP version to use for cluster networking and IP assignment.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "ipFamily", + "modelAsString": true + } + }, + "title": "The IP families used to specify IP versions available to the cluster.", + "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6." + } + }, + "description": "Profile of network configuration." + }, + "AdvancedNetworking": { + "type": "object", + "description": "Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false." + }, + "observability": { + "$ref": "#/definitions/AdvancedNetworkingObservability" + }, + "security": { + "$ref": "#/definitions/AdvancedNetworkingSecurity" + } + } + }, + "AdvancedNetworkingObservability": { + "type": "object", + "description": "Observability profile to enable advanced network metrics and flow logs with historical contexts.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates the enablement of Advanced Networking observability functionalities on clusters." + } + } + }, + "AdvancedNetworkingSecurity": { + "type": "object", + "description": "Security profile to enable security features on cilium based cluster.", + "properties": { + "enabled": { + "type": "boolean", + "description": "This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false." + } + } + }, + "MaintenanceConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "MaintenanceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.", + "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "type": "object", + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "x-ms-identifiers": [], + "title": "Time slots during the week when planned maintenance is allowed to proceed.", + "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "x-ms-identifiers": [], + "description": "Time slots on which upgrade is not allowed." + }, + "maintenanceWindow": { + "type": "object", + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window for the maintenance configuration." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "MaintenanceWindow": { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "Recurrence schedule for the maintenance window." + }, + "durationHours": { + "type": "integer", + "format": "int32", + "minimum": 4, + "maximum": 24, + "default": 24, + "description": "Length of maintenance window range from 4 to 24 hours." + }, + "utcOffset": { + "type": "string", + "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$", + "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away." + }, + "startTime": { + "type": "string", + "pattern": "^\\d{2}:\\d{2}$", + "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'." + }, + "notAllowedDates": { + "type": "array", + "items": { + "$ref": "#/definitions/DateSpan" + }, + "x-ms-identifiers": [], + "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time." + } + }, + "description": "Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.", + "required": [ + "schedule", + "durationHours", + "startTime" + ] + }, + "Schedule": { + "type": "object", + "properties": { + "daily": { + "$ref": "#/definitions/DailySchedule" + }, + "weekly": { + "$ref": "#/definitions/WeeklySchedule" + }, + "absoluteMonthly": { + "$ref": "#/definitions/AbsoluteMonthlySchedule" + }, + "relativeMonthly": { + "$ref": "#/definitions/RelativeMonthlySchedule" + } + }, + "description": "One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule." + }, + "DailySchedule": { + "type": "object", + "properties": { + "intervalDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 7, + "description": "Specifies the number of days between each set of occurrences." + } + }, + "description": "For schedules like: 'recur every day' or 'recur every 3 days'.", + "required": [ + "intervalDays" + ] + }, + "WeeklySchedule": { + "type": "object", + "properties": { + "intervalWeeks": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4, + "description": "Specifies the number of weeks between each set of occurrences." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.", + "required": [ + "intervalWeeks", + "dayOfWeek" + ] + }, + "AbsoluteMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "dayOfMonth": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 31, + "description": "The date of the month." + } + }, + "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.", + "required": [ + "intervalMonths", + "dayOfMonth" + ] + }, + "RelativeMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "weekIndex": { + "type": "string", + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "First", + "description": "First week of the month." + }, + { + "value": "Second", + "description": "Second week of the month." + }, + { + "value": "Third", + "description": "Third week of the month." + }, + { + "value": "Fourth", + "description": "Fourth week of the month." + }, + { + "value": "Last", + "description": "Last week of the month." + } + ] + }, + "title": "The week index.", + "description": "Specifies on which week of the month the dayOfWeek applies." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.", + "required": [ + "intervalMonths", + "weekIndex", + "dayOfWeek" + ] + }, + "DateSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date", + "description": "The start date of the date span." + }, + "end": { + "type": "string", + "format": "date", + "description": "The end date of the date span." + } + }, + "title": "A date range.", + "description": "For example, between '2022-12-23' and '2023-01-05'.", + "required": [ + "start", + "end" + ] + }, + "TimeInWeek": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "title": "A list of hours in the day used to identify a time range.", + "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "title": "A time range.", + "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterNATGatewayProfile": { + "type": "object", + "properties": { + "managedOutboundIPProfile": { + "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile", + "description": "Profile of the managed outbound IP resources of the cluster NAT gateway." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster NAT gateway." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.", + "default": 4 + } + }, + "description": "Profile of the managed cluster NAT gateway." + }, + "ManagedClusterManagedOutboundIPProfile": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 16, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Profile of the managed outbound IP resources of the managed cluster." + }, + "ManagedClusterLoadBalancerProfile": { + "type": "object", + "properties": { + "managedOutboundIPs": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "countIPv6": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0, + "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ", + "default": 0 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "type": "object", + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "type": "object", + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + }, + "enableMultipleStandardLoadBalancers": { + "type": "boolean", + "description": "Enable multiple standard load balancers per AKS cluster or not." + }, + "backendPoolType": { + "type": "string", + "x-ms-enum": { + "name": "BackendPoolType", + "modelAsString": true, + "values": [ + { + "value": "NodeIPConfiguration", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + }, + { + "value": "NodeIP", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + } + ] + }, + "enum": [ + "NodeIPConfiguration", + "NodeIP" + ], + "description": "The type of the managed inbound Load Balancer BackendPool.", + "default": "NodeIPConfiguration" + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "x-ms-identifiers": [], + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "type": "object", + "properties": { + "eTag": { + "type": "string", + "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + }, + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "currentKubernetesVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes the Managed Cluster is running.", + "description": "If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used." + }, + "dnsPrefix": { + "type": "string", + "title": "The DNS prefix of the Managed Cluster.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "title": "The FQDN subdomain of the private cluster with custom private dns zone.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.", + "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "x-ms-identifiers": [], + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "oidcIssuerProfile": { + "$ref": "#/definitions/ManagedClusterOIDCIssuerProfile", + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "nodeResourceGroupProfile": { + "$ref": "#/definitions/ManagedClusterNodeResourceGroupProfile", + "description": "Profile of the node resource group configuration." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "supportPlan": { + "$ref": "#/definitions/KubernetesSupportPlan", + "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "upgradeSettings": { + "$ref": "#/definitions/ClusterUpgradeSettings", + "description": "Settings for upgrading a cluster." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "title": "Detects similar node pools and balances the number of nodes between them.", + "description": "Valid values are 'true' and 'false'" + }, + "daemonset-eviction-for-empty-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from empty nodes", + "description": "If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "daemonset-eviction-for-occupied-nodes": { + "type": "boolean", + "title": "DaemonSet pods will be gracefully terminated from non-empty nodes", + "description": "If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "ignore-daemonsets-utilization": { + "type": "boolean", + "title": "Should CA ignore DaemonSet pods when calculating resource utilization for scaling down", + "description": "If set to true, the resources used by daemonset will be taken into account when making scaling down decisions." + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "title": "The expander to use when scaling up", + "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "max-empty-bulk-delete": { + "type": "string", + "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.", + "description": "The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.", + "description": "The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "title": "The maximum time the autoscaler waits for a node to be provisioned.", + "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.", + "description": "The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "title": "Ignore unscheduled pods before they're a certain age.", + "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.", + "description": "This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "title": "How often cluster is reevaluated for scale up or down.", + "description": "The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "title": "How long after scale up that scale down evaluation resumes", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "title": "How long after node deletion that scale down evaluation resumes.", + "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "title": "How long after scale down failure that scale down evaluation resumes.", + "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "title": "How long a node should be unneeded before it is eligible for scale down.", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "title": "How long an unready node should be unneeded before it is eligible for scale down", + "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", + "description": "The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.", + "description": "The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)", + "description": "The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/diskEncryptionSets" + } + ] + }, + "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is \"kubeletidentity\", with value of \"resourceId\": \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}\"." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "title": "If local accounts should be disabled on the Managed Cluster.", + "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + }, + "securityProfile": { + "$ref": "#/definitions/ManagedClusterSecurityProfile", + "description": "Security profile for the managed cluster." + }, + "storageProfile": { + "$ref": "#/definitions/ManagedClusterStorageProfile", + "description": "Storage profile for the managed cluster." + }, + "ingressProfile": { + "$ref": "#/definitions/ManagedClusterIngressProfile", + "description": "Ingress profile for the managed cluster." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "title": "PublicNetworkAccess of the managedCluster", + "description": "Allow or deny public network access for AKS" + }, + "workloadAutoScalerProfile": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfile" + }, + "azureMonitorProfile": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfile" + }, + "serviceMeshProfile": { + "$ref": "#/definitions/ServiceMeshProfile" + }, + "resourceUID": { + "readOnly": true, + "type": "string", + "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)" + }, + "metricsProfile": { + "$ref": "#/definitions/ManagedClusterMetricsProfile", + "description": "Optional cluster metrics configuration." + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "type": "object", + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "ManagedClusterAPIServerAccessProfile": { + "type": "object", + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the Kubernetes API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "title": "Whether to create the cluster as a private cluster or not.", + "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "title": "The private DNS zone mode for the cluster.", + "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + }, + "disableRunCommand": { + "type": "boolean", + "description": "Whether to disable run command for the cluster or not." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "title": "The type of identity used for the managed cluster.", + "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "delegatedResources": { + "$ref": "../../../../../../common-types/resource-management/v4/managedidentitywithdelegation.json#/definitions/DelegatedResources", + "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.", + "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + }, + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "type": "object", + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "x-ms-identifiers": [], + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "type": "object", + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching" + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "title": "The upgrade channel for auto upgrade. The default is 'none'.", + "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + }, + "nodeOSUpgradeChannel": { + "type": "string", + "enum": [ + "Unmanaged", + "None", + "NodeImage", + "SecurityPatch" + ], + "x-ms-enum": { + "name": "nodeOSUpgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates" + }, + { + "value": "Unmanaged", + "description": "OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice" + }, + { + "value": "NodeImage", + "description": "AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images." + }, + { + "value": "SecurityPatch", + "description": "AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption." + } + ] + }, + "title": "Node OS Upgrade Channel", + "description": "Manner in which the OS on your nodes is updated. The default is NodeImage." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "UpgradeOverrideSettings": { + "type": "object", + "properties": { + "forceUpgrade": { + "type": "boolean", + "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution." + }, + "until": { + "type": "string", + "format": "date-time", + "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect." + } + }, + "description": "Settings for overrides when upgrading a cluster." + }, + "ClusterUpgradeSettings": { + "type": "object", + "properties": { + "overrideSettings": { + "$ref": "#/definitions/UpgradeOverrideSettings", + "description": "Settings for overrides." + } + }, + "description": "Settings for upgrading a cluster." + }, + "ManagedClusterAADProfile": { + "type": "object", + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppID": { + "type": "string", + "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppSecret": { + "type": "string", + "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "title": "AADProfile specifies attributes for Azure Active Directory integration.", + "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "type": "object", + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.", + "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.", + "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + }, + "x-ms-identifiers": [] + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + }, + "x-ms-identifiers": [] + } + }, + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterOIDCIssuerProfile": { + "type": "object", + "properties": { + "issuerURL": { + "readOnly": true, + "type": "string", + "description": "The OIDC issuer url of the Managed Cluster." + }, + "enabled": { + "type": "boolean", + "description": "Whether the OIDC issuer is enabled." + } + }, + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "ManagedClusterUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "type": "object", + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "Ubuntu", + "CBLMariner", + "AzureLinux", + "Windows2019", + "Windows2022" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true, + "values": [ + { + "value": "Ubuntu", + "description": "Use Ubuntu as the OS for node images." + }, + { + "value": "AzureLinux", + "description": "Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information." + }, + { + "value": "CBLMariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "Windows2019", + "description": "Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa." + }, + { + "value": "Windows2022", + "description": "Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa." + } + ] + }, + "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "title": "The Virtual Machine Scale Set eviction policy.", + "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ScaleDownMode": { + "type": "string", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleDownMode", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Create new instances during scale up and remove instances during scale down." + }, + { + "value": "Deallocate", + "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down." + } + ] + }, + "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)." + }, + "ProximityPlacementGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/proximityPlacementGroups" + } + ] + }, + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "type": "object", + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "type": "object", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Base" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true, + "values": [ + { + "value": "Base", + "description": "Base option for the AKS control plane." + } + ] + } + }, + "tier": { + "type": "string", + "title": "The tier of a managed cluster SKU.", + "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details.", + "enum": [ + "Standard", + "Free", + "Premium" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions." + }, + { + "value": "Standard", + "description": "Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Canceled", + "Creating", + "Deleting", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "title": "The OS disk type to be used for machines in the agent pool.", + "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "WorkloadRuntime": { + "type": "string", + "enum": [ + "OCIContainer", + "WasmWasi" + ], + "x-ms-enum": { + "name": "WorkloadRuntime", + "modelAsString": true, + "values": [ + { + "value": "OCIContainer", + "description": "Nodes will use Kubelet to run standard OCI container workloads." + }, + { + "value": "WasmWasi", + "description": "Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview)." + } + ] + }, + "description": "Determines the type of workload a node can run." + }, + "KubeletConfig": { + "title": "Kubelet configurations of agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "title": "The CPU Manager policy to use.", + "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.", + "description": "The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "title": "The CPU CFS quota period value.", + "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage after which image garbage collection is always run.", + "description": "To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage before which image garbage collection is never run.", + "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "title": "The Topology Manager policy to use.", + "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + } + } + }, + "LinuxOSConfig": { + "title": "OS configurations of Linux agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "title": "Whether transparent hugepages are enabled.", + "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.", + "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "AgentPoolWindowsProfile": { + "type": "object", + "description": "The Windows agent pool's specific profile.", + "properties": { + "disableOutboundNat": { + "type": "boolean", + "title": "Whether to disable OutboundNAT in windows nodes", + "description": "The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled." + } + } + }, + "AgentPoolSecurityProfile": { + "type": "object", + "properties": { + "enableVTPM": { + "type": "boolean", + "description": "vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false." + }, + "enableSecureBoot": { + "type": "boolean", + "description": "Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false." + } + }, + "description": "The security settings of an agent pool." + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "minimum": 10, + "maximum": 90, + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "minimum": 131072, + "maximum": 2097152, + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "minimum": 65536, + "maximum": 524288, + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [] + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterIngressProfile": { + "type": "object", + "properties": { + "webAppRouting": { + "$ref": "#/definitions/ManagedClusterIngressProfileWebAppRouting", + "description": "App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default." + } + }, + "description": "Ingress profile for the container service cluster." + }, + "ManagedClusterIngressProfileWebAppRouting": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the Application Routing add-on." + }, + "dnsZoneResourceIds": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/dnszones" + }, + { + "type": "Microsoft.Network/privateDnsZones" + } + ] + } + }, + "maxItems": 5, + "description": "Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group." + }, + "identity": { + "readOnly": true, + "type": "object", + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions." + } + }, + "description": "Application Routing add-on settings for the ingress profile." + }, + "ManagedClusterSecurityProfile": { + "type": "object", + "properties": { + "defender": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefender", + "description": "Microsoft Defender settings for the security profile." + }, + "azureKeyVaultKms": { + "$ref": "#/definitions/AzureKeyVaultKms", + "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile." + }, + "workloadIdentity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileWorkloadIdentity", + "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details." + }, + "imageCleaner": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageCleaner", + "description": "Image Cleaner settings for the security profile." + } + }, + "description": "Security profile for the container service cluster." + }, + "AzureKeyVaultKms": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Azure Key Vault key management service. The default is false." + }, + "keyId": { + "type": "string", + "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty." + }, + "keyVaultNetworkAccess": { + "type": "string", + "enum": [ + "Public", + "Private" + ], + "default": "Public", + "x-ms-enum": { + "name": "KeyVaultNetworkAccessTypes", + "modelAsString": true + }, + "title": "Network access of the key vault", + "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`." + }, + "keyVaultResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty." + } + }, + "description": "Azure Key Vault key management service settings for the security profile." + }, + "ManagedClusterSecurityProfileWorkloadIdentity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable workload identity." + } + }, + "description": "Workload identity settings for the security profile." + }, + "ManagedClusterSecurityProfileImageCleaner": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Image Cleaner on AKS cluster." + }, + "intervalHours": { + "type": "integer", + "format": "int32", + "description": "Image Cleaner scanning interval in hours." + } + }, + "description": "Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile." + }, + "ManagedClusterStorageProfile": { + "type": "object", + "properties": { + "diskCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileDiskCSIDriver", + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "fileCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileFileCSIDriver", + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "snapshotController": { + "$ref": "#/definitions/ManagedClusterStorageProfileSnapshotController", + "description": "Snapshot Controller settings for the storage profile." + }, + "blobCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileBlobCSIDriver", + "description": "AzureBlob CSI Driver settings for the storage profile." + } + }, + "description": "Storage profile for the container service cluster." + }, + "ManagedClusterSecurityProfileDefender": { + "type": "object", + "properties": { + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty." + }, + "securityMonitoring": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityMonitoring", + "description": "Microsoft Defender threat detection for Cloud settings for the security profile." + } + }, + "description": "Microsoft Defender settings for the security profile." + }, + "ManagedClusterSecurityProfileDefenderSecurityMonitoring": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Defender threat detection" + } + }, + "description": "Microsoft Defender settings for the security profile threat detection." + }, + "ManagedClusterStorageProfileDiskCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureDisk CSI Driver. The default value is true." + } + }, + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileFileCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureFile CSI Driver. The default value is true." + } + }, + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileSnapshotController": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Snapshot Controller. The default value is true." + } + }, + "description": "Snapshot Controller settings for the storage profile." + }, + "ManagedClusterStorageProfileBlobCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureBlob CSI Driver. The default value is false." + } + }, + "description": "AzureBlob CSI Driver settings for the storage profile." + }, + "CreationData": { + "description": "Data used when creating a target resource from a source resource.", + "type": "object", + "properties": { + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "This is the ARM ID of the source object to be used to create the target object." + } + } + }, + "SnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Snapshots operation." + }, + "Snapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a snapshot.", + "$ref": "#/definitions/SnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A node pool snapshot resource." + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image." + }, + "osType": { + "readOnly": true, + "$ref": "#/definitions/OSType" + }, + "osSku": { + "readOnly": true, + "$ref": "#/definitions/OSSKU" + }, + "vmSize": { + "readOnly": true, + "type": "string", + "description": "The size of the VM." + }, + "enableFIPS": { + "readOnly": true, + "type": "boolean", + "description": "Whether to use a FIPS-enabled OS." + } + }, + "description": "Properties used to configure a node pool snapshot." + }, + "SnapshotType": { + "type": "string", + "default": "NodePool", + "enum": [ + "NodePool" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "value": "NodePool", + "description": "The snapshot is a snapshot of a node pool." + } + ] + }, + "description": "The type of a snapshot. The default is NodePool." + }, + "ManagedClusterWorkloadAutoScalerProfile": { + "type": "object", + "description": "Workload Auto-scaler profile for the managed cluster.", + "properties": { + "keda": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileKeda" + }, + "verticalPodAutoscaler": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler" + } + } + }, + "ManagedClusterWorkloadAutoScalerProfileKeda": { + "type": "object", + "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable KEDA." + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler": { + "type": "object", + "description": "VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable VPA. Default value is false.", + "default": false + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterAzureMonitorProfile": { + "type": "object", + "description": "Azure Monitor addon profiles for monitoring the managed cluster.", + "properties": { + "metrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileMetrics" + } + } + }, + "ManagedClusterAzureMonitorProfileKubeStateMetrics": { + "type": "object", + "description": "Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details.", + "properties": { + "metricLabelsAllowlist": { + "type": "string", + "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels." + }, + "metricAnnotationsAllowList": { + "type": "string", + "description": "Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels." + } + } + }, + "ManagedClusterAzureMonitorProfileMetrics": { + "type": "object", + "description": "Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling." + }, + "kubeStateMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileKubeStateMetrics" + } + }, + "required": [ + "enabled" + ] + }, + "ServiceMeshProfile": { + "type": "object", + "description": "Service mesh profile for a managed cluster.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of the service mesh.", + "enum": [ + "Istio", + "Disabled" + ], + "x-ms-enum": { + "name": "ServiceMeshMode", + "modelAsString": true, + "values": [ + { + "value": "Istio", + "description": "Istio deployed as an AKS addon." + }, + { + "value": "Disabled", + "description": "Mesh is disabled." + } + ] + } + }, + "istio": { + "$ref": "#/definitions/IstioServiceMesh" + } + }, + "required": [ + "mode" + ] + }, + "IstioServiceMesh": { + "type": "object", + "description": "Istio service mesh configuration.", + "properties": { + "components": { + "$ref": "#/definitions/IstioComponents" + }, + "certificateAuthority": { + "$ref": "#/definitions/IstioCertificateAuthority" + }, + "revisions": { + "type": "array", + "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade", + "items": { + "type": "string" + }, + "uniqueItems": true, + "maxItems": 2 + } + } + }, + "IstioComponents": { + "type": "object", + "description": "Istio components configuration.", + "properties": { + "ingressGateways": { + "type": "array", + "description": "Istio ingress gateways.", + "items": { + "$ref": "#/definitions/IstioIngressGateway" + }, + "x-ms-identifiers": [] + }, + "egressGateways": { + "type": "array", + "description": "Istio egress gateways.", + "items": { + "$ref": "#/definitions/IstioEgressGateway" + }, + "x-ms-identifiers": [] + } + } + }, + "IstioIngressGateway": { + "type": "object", + "description": "Istio ingress gateway configuration. For now, we support up to one external ingress gateway named `aks-istio-ingressgateway-external` and one internal ingress gateway named `aks-istio-ingressgateway-internal`.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of an ingress gateway.", + "enum": [ + "External", + "Internal" + ], + "x-ms-enum": { + "name": "IstioIngressGatewayMode", + "modelAsString": true, + "values": [ + { + "value": "External", + "description": "The ingress gateway is assigned a public IP address and is publicly accessible." + }, + { + "value": "Internal", + "description": "The ingress gateway is assigned an internal IP address and cannot is accessed publicly." + } + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to enable the ingress gateway." + } + }, + "required": [ + "mode", + "enabled" + ] + }, + "IstioCertificateAuthority": { + "type": "object", + "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca", + "properties": { + "plugin": { + "$ref": "#/definitions/IstioPluginCertificateAuthority" + } + } + }, + "IstioPluginCertificateAuthority": { + "type": "object", + "description": "Plugin certificates information for Service Mesh.", + "properties": { + "keyVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "The resource ID of the Key Vault." + }, + "certObjectName": { + "type": "string", + "description": "Intermediate certificate object name in Azure Key Vault." + }, + "keyObjectName": { + "type": "string", + "description": "Intermediate certificate private key object name in Azure Key Vault." + }, + "rootCertObjectName": { + "type": "string", + "description": "Root certificate object name in Azure Key Vault." + }, + "certChainObjectName": { + "type": "string", + "description": "Certificate chain object name in Azure Key Vault." + } + } + }, + "IstioEgressGateway": { + "type": "object", + "description": "Istio egress gateway configuration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the egress gateway." + } + }, + "required": [ + "enabled" + ] + }, + "MeshRevisionProfileList": { + "type": "object", + "description": "Holds an array of MeshRevisionsProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevisionProfile" + }, + "description": "Array of service mesh add-on revision profiles for all supported mesh modes." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh revision profile.", + "readOnly": true + } + } + }, + "MeshRevisionProfile": { + "type": "object", + "description": "Mesh revision profile for a mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshRevisionProfileProperties" + } + } + }, + "MeshRevisionProfileProperties": { + "type": "object", + "description": "Mesh revision profile properties for a mesh", + "properties": { + "meshRevisions": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevision" + } + } + } + }, + "MeshUpgradeProfileList": { + "type": "object", + "description": "Holds an array of MeshUpgradeProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshUpgradeProfile" + }, + "description": "Array of supported service mesh add-on upgrade profiles." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh upgrade profile.", + "readOnly": true + } + } + }, + "MeshUpgradeProfile": { + "type": "object", + "description": "Upgrade profile for given mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshUpgradeProfileProperties" + } + } + }, + "MeshUpgradeProfileProperties": { + "type": "object", + "description": "Mesh upgrade profile properties for a major.minor release.", + "allOf": [ + { + "$ref": "#/definitions/MeshRevision" + } + ] + }, + "MeshRevision": { + "type": "object", + "description": "Holds information on upgrades and compatibility for given major.minor mesh release.", + "properties": { + "revision": { + "type": "string", + "description": "The revision of the mesh release." + }, + "upgrades": { + "type": "array", + "description": "List of revisions available for upgrade of a specific mesh revision", + "items": { + "type": "string", + "description": "An upgradeable mesh revision" + } + }, + "compatibleWith": { + "type": "array", + "description": "List of items this revision of service mesh is compatible with, and their associated versions.", + "items": { + "$ref": "#/definitions/CompatibleVersions" + }, + "x-ms-identifiers": [] + } + } + }, + "CompatibleVersions": { + "type": "object", + "description": "Version information about a product/service that is compatible with a service mesh revision.", + "properties": { + "name": { + "type": "string", + "description": "The product/service name." + }, + "versions": { + "type": "array", + "description": "Product/service versions compatible with a service mesh add-on revision.", + "items": { + "type": "string", + "description": "A compatible product/service version." + } + } + } + }, + "KubernetesSupportPlan": { + "type": "string", + "description": "Different support tiers for AKS managed clusters", + "enum": [ + "KubernetesOfficial", + "AKSLongTermSupport" + ], + "x-ms-enum": { + "name": "KubernetesSupportPlan", + "modelAsString": true, + "values": [ + { + "value": "KubernetesOfficial", + "description": "Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release." + }, + { + "value": "AKSLongTermSupport", + "description": "Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support." + } + ] + } + }, + "KubernetesVersionCapabilities": { + "type": "object", + "description": "Capabilities on this Kubernetes version.", + "properties": { + "supportPlan": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesSupportPlan" + } + } + } + }, + "KubernetesPatchVersion": { + "type": "object", + "description": "Kubernetes patch version profile", + "properties": { + "upgrades": { + "type": "array", + "description": "Possible upgrade path for given patch version", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "KubernetesVersion": { + "type": "object", + "description": "Kubernetes version profile for given major.minor release.", + "properties": { + "version": { + "type": "string", + "description": "major.minor version of Kubernetes release" + }, + "capabilities": { + "$ref": "#/definitions/KubernetesVersionCapabilities", + "description": "Capabilities on this Kubernetes version." + }, + "isDefault": { + "type": "boolean", + "description": "Whether this version is default." + }, + "isPreview": { + "type": "boolean", + "description": "Whether this version is in preview mode." + }, + "patchVersions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KubernetesPatchVersion" + }, + "description": "Patch versions of Kubernetes release" + } + } + }, + "KubernetesVersionListResult": { + "type": "object", + "description": "Hold values properties, which is array of KubernetesVersion", + "properties": { + "values": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesVersion" + }, + "description": "Array of AKS supported Kubernetes versions." + } + } + }, + "ManagedClusterMetricsProfile": { + "type": "object", + "description": "The metrics profile for the ManagedCluster.", + "properties": { + "costAnalysis": { + "$ref": "#/definitions/ManagedClusterCostAnalysis", + "title": "The configuration for detailed per-Kubernetes resource cost analysis." + } + } + }, + "ManagedClusterCostAnalysis": { + "type": "object", + "description": "The cost analysis configuration for the cluster", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable cost analysis", + "description": "The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis." + } + } + }, + "AgentPoolDeleteMachinesParameter": { + "type": "object", + "properties": { + "machineNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The agent pool machine names." + } + }, + "required": [ + "machineNames" + ], + "description": "Specifies a list of machine names from the agent pool to be deleted." + }, + "TrustedAccessRoleRule": { + "type": "object", + "description": "Rule for trusted access role", + "properties": { + "verbs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed verbs" + }, + "apiGroups": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed apiGroups" + }, + "resources": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed resources" + }, + "resourceNames": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed names" + }, + "nonResourceURLs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed nonResourceURLs" + } + } + }, + "TrustedAccessRole": { + "type": "object", + "description": "Trusted access role definition.", + "properties": { + "sourceResourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type of Azure resource" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of role, name is unique under a source resource type" + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRoleRule" + }, + "x-ms-identifiers": [], + "description": "List of rules for the role. This maps to 'rules' property of [Kubernetes Cluster Role](https://kubernetes.io/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1/#ClusterRole)." + } + } + }, + "TrustedAccessRoleBindingProperties": { + "type": "object", + "description": "Properties for trusted access role binding", + "required": [ + "sourceResourceId", + "roles" + ], + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of trusted access role binding.", + "enum": [ + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "TrustedAccessRoleBindingProvisioningState", + "modelAsString": true + } + }, + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource ID of source resource that trusted access is configured for." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'." + } + } + }, + "TrustedAccessRoleBinding": { + "type": "object", + "description": "Defines binding between a resource and role", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TrustedAccessRoleBindingProperties", + "x-ms-client-flatten": true + } + } + }, + "TrustedAccessRoleBindingListResult": { + "type": "object", + "description": "List of trusted access role bindings", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "Role binding list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "TrustedAccessRoleListResult": { + "type": "object", + "description": "List of trusted access roles", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRole" + }, + "x-ms-identifiers": [ + "sourceResourceType", + "name" + ], + "description": "Role list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CapacityReservationGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/CapacityReservationGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Capacity Reservation Group to provide virtual machines from a reserved group of Virtual Machines.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Compute/capacityreservationgroups/{capacityReservationGroupName}' Customers use it to create an agentpool with a specified CRG. For more information see [Capacity Reservation](https://learn.microsoft.com/en-us/azure/virtual-machines/capacity-reservation-overview)" + }, + "Machine": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "A machine. Contains details about the underlying virtual machine. A machine may be visible here but not in kubectl get nodes; if so it may be because the machine has not been registered with the Kubernetes API Server yet.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineProperties", + "description": "The properties of the machine" + } + }, + "type": "object" + }, + "MachineIpAddress": { + "description": "The machine IP address details.", + "properties": { + "family": { + "description": "To determine if address belongs IPv4 or IPv6 family", + "enum": [ + "IPv4", + "IPv6" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IPFamily", + "values": [ + { + "description": "IPv4 family", + "value": "IPv4" + }, + { + "description": "IPv6 family", + "value": "IPv6" + } + ] + } + }, + "ip": { + "description": "IPv4 or IPv6 address of the machine", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "MachineListResult": { + "description": "The response from the List Machines operation.", + "properties": { + "nextLink": { + "description": "The URL to get the next set of machine results.", + "format": "uri", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The list of Machines in cluster.", + "items": { + "$ref": "#/definitions/Machine" + }, + "type": "array", + "x-ms-identifiers": [ + "id" + ] + } + }, + "type": "object" + }, + "MachineNetworkProperties": { + "description": "network properties of the machine", + "properties": { + "ipAddresses": { + "description": "IPv4, IPv6 addresses of the machine", + "items": { + "$ref": "#/definitions/MachineIpAddress" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + } + }, + "readOnly": true, + "type": "object" + }, + "MachineProperties": { + "description": "The properties of the machine", + "properties": { + "network": { + "$ref": "#/definitions/MachineNetworkProperties" + }, + "resourceId": { + "description": "Azure resource id of the machine. It can be used to GET underlying VM Instance", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/virtualMachines" + }, + { + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines" + } + ] + }, + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + } + }, + "parameters": { + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "AgentPoolNameParameter": { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + }, + "TrustedAccessRoleBindingNameParameter": { + "name": "trustedAccessRoleBindingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of trusted access role binding.", + "pattern": "^([A-Za-z0-9-])+$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "CredentialFormatParameter": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "exec", + "azure" + ], + "x-ms-enum": { + "name": "format", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Return azure auth-provider kubeconfig. This format is deprecated in v1.22 and will be fully removed in v1.26. See: https://aka.ms/k8s/changes-1-26." + }, + { + "value": "exec", + "description": "Return exec format kubeconfig. This format requires kubelogin binary in the path." + } + ] + }, + "description": "Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.", + "x-ms-parameter-location": "method" + }, + "MeshModeParameter": { + "name": "mode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The mode of the mesh.", + "x-ms-parameter-location": "method" + }, + "MachineNameParameter": { + "type": "string", + "description": "host name of the machine", + "name": "machineName", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][-_a-zA-Z0-9]{0,39}$", + "x-ms-parameter-location": "method" + }, + "IgnorePodDisruptionBudgetParameter": { + "name": "ignore-pod-disruption-budget", + "in": "query", + "required": false, + "type": "boolean", + "description": "ignore-pod-disruption-budget=true to delete those pods on a node without considering Pod Disruption Budget", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/readme.python.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/readme.python.md index c1f9236ffd5d..4314a4a07628 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/readme.python.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/readme.python.md @@ -1,141 +1,19 @@ ## Python These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. -```yaml $(python) -title: ContainerServiceFleetMgmtClient +``` yaml $(python) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-containerservicefleet -package-version: 1.0.0b1 +namespace: azure.mgmt.containerservicefleet +package-version: 3.0.0 clear-output-folder: true -no-namespace-folders: true -``` - -### Python multi-api - -Generate all API versions currently shipped for this package - -```yaml $(python) -default-api-version: "2024-04-01" -multiapi: true -batch: - - tag: package-2024-05-preview - - tag: package-2024-04 - - tag: package-2024-02-preview - - tag: package-2023-10 - - tag: package-2023-08-preview - - tag: package-2023-06-preview - - tag: package-2023-03-preview - - tag: package-2022-09-preview - - tag: package-2022-07-preview - - tag: package-2022-06-preview - - multiapiscript: true -``` - -``` yaml $(multiapiscript) -output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservicefleet/azure/mgmt/containerservicefleet/ -clear-output-folder: false -perform-load: false -``` - -### Tag: package-2024-05-preview and python - -These settings apply only when `--tag=package-2024-05-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2024-05-preview' && $(python) -namespace: azure.mgmt.containerservicefleet.v2024_05_02_preview -output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservicefleet/azure/mgmt/containerservicefleet/v2024_05_02_preview -``` - - -### Tag: package-2024-04 and python - -These settings apply only when `--tag=package-2024-04 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2024-04' && $(python) -namespace: azure.mgmt.containerservicefleet.v2024_04_01 -output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservicefleet/azure/mgmt/containerservicefleet/v2024_04_01 -``` - -### Tag: package-2024-02-preview and python - -These settings apply only when `--tag=package-2024-02-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2024-02-preview' && $(python) -namespace: azure.mgmt.containerservicefleet.v2024_02_02_preview -output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservicefleet/azure/mgmt/containerservicefleet/v2024_02_02_preview -``` - -### Tag: package-2023-10 and python - -These settings apply only when `--tag=package-2023-10 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-10' && $(python) -namespace: azure.mgmt.containerservicefleet.v2023_10_15 -output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservicefleet/azure/mgmt/containerservicefleet/v2023_10_15 -``` - -### Tag: package-2023-08-preview and python - -These settings apply only when `--tag=package-2023-08-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-08-preview' && $(python) -namespace: azure.mgmt.containerservicefleet.v2023_08_15_preview -output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservicefleet/azure/mgmt/containerservicefleet/v2023_08_15_preview -``` - -### Tag: package-2023-06-preview and python - -These settings apply only when `--tag=package-2023-06-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-06-preview' && $(python) -namespace: azure.mgmt.containerservicefleet.v2023_06_15_preview -output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservicefleet/azure/mgmt/containerservicefleet/v2023_06_15_preview -``` - -### Tag: package-2023-03-preview and python - -These settings apply only when `--tag=package-2023-03-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-03-preview' && $(python) -namespace: azure.mgmt.containerservicefleet.v2023_03_15_preview -output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservicefleet/azure/mgmt/containerservicefleet/v2023_03_15_preview -``` - -### Tag: package-2022-09-preview and python - -These settings apply only when `--tag=package-2022-09-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2022-06-preview' && $(python) -namespace: azure.mgmt.containerservicefleet.v2022_09_02_preview -output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservicefleet/azure/mgmt/containerservicefleet/v2022_09_02_preview -``` - -### Tag: package-2022-07-preview and python - -These settings apply only when `--tag=package-2022-07-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2022-07-preview' && $(python) -namespace: azure.mgmt.containerservicefleet.v2022_07_02_preview -output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservicefleet/azure/mgmt/containerservicefleet/v2022_07_02_preview +title: ContainerServiceFleetMgmtClient ``` -### Tag: package-2022-06-preview and python - -These settings apply only when `--tag=package-2022-06-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2022-09-preview' && $(python) -namespace: azure.mgmt.containerservicefleet.v2022_06_02_preview -output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservicefleet/azure/mgmt/containerservicefleet/v2022_06_02_preview +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservicefleet/azure/mgmt/containerservicefleet ``` diff --git a/specification/contosowidgetmanager/Contoso.Management/employee.tsp b/specification/contosowidgetmanager/Contoso.Management/employee.tsp index 081564ed9236..b796033881f6 100644 --- a/specification/contosowidgetmanager/Contoso.Management/employee.tsp +++ b/specification/contosowidgetmanager/Contoso.Management/employee.tsp @@ -56,13 +56,7 @@ union ProvisioningState { interface Employees { get is ArmResourceRead; createOrUpdate is ArmResourceCreateOrReplaceAsync; - update is ArmCustomPatchSync< - Employee, - Azure.ResourceManager.Foundations.ResourceUpdateModel< - Employee, - EmployeeProperties - > - >; + update is ArmResourcePatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByResourceGroup is ArmResourceListByParent; listBySubscription is ArmListBySubscription; diff --git a/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml b/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml index 23b54895ca02..788cbd5f5991 100644 --- a/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml +++ b/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml @@ -9,7 +9,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/contoso.json" - emit-common-types-schema: "never" "@azure-tools/typespec-csharp": flavor: azure package-dir: "Azure.ResourceManager.Contoso" diff --git a/specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/preview/2021-10-01-preview/contoso.json b/specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/preview/2021-10-01-preview/contoso.json index baa25985dfb4..c51e0e74c52f 100644 --- a/specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/preview/2021-10-01-preview/contoso.json +++ b/specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/preview/2021-10-01-preview/contoso.json @@ -402,6 +402,24 @@ } }, "definitions": { + "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": { + "type": "object", + "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ] + }, "Employee": { "type": "object", "description": "Employee resource", @@ -465,40 +483,18 @@ }, "EmployeeUpdate": { "type": "object", - "description": "The type used for update operations of the Employee.", + "description": "Employee resource", "properties": { - "tags": { - "type": "object", - "description": "Resource tags.", - "additionalProperties": { - "type": "string" - } - }, "properties": { - "$ref": "#/definitions/EmployeeUpdateProperties", + "$ref": "#/definitions/EmployeeProperties", "description": "The resource-specific properties for this resource." } - } - }, - "EmployeeUpdateProperties": { - "type": "object", - "description": "The updatable properties of the Employee.", - "properties": { - "age": { - "type": "integer", - "format": "int32", - "description": "Age of employee" - }, - "city": { - "type": "string", - "description": "City of employee" - }, - "profile": { - "type": "string", - "format": "base64url", - "description": "Profile of employee" + }, + "allOf": [ + { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" } - } + ] }, "ProvisioningState": { "type": "string", diff --git a/specification/databox/resource-manager/readme.python.md b/specification/databox/resource-manager/readme.python.md index d2cb18813776..d3cddf5b0f03 100644 --- a/specification/databox/resource-manager/readme.python.md +++ b/specification/databox/resource-manager/readme.python.md @@ -2,208 +2,19 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. ``` yaml $(python) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION -namespace: azure.mgmt.databox package-name: azure-mgmt-databox -package-version: 1.0.0b1 +namespace: azure.mgmt.databox +package-version: 3.0.0 +clear-output-folder: true title: DataBoxManagementClient description: The DataBox Client. -clear-output-folder: true -no-namespace-folders: true -``` - -### Python multi-api - -Generate all API versions currently shipped for this package - -```yaml $(python) -multiapi: true -default-api-version: "2023-03-01" -batch: - - tag: package-2024-03-preview - - tag: package-2024-02-preview - - tag: package-2023-12 - - tag: package-2023-03 - - tag: package-2022-12 - - tag: package-2022-10 - - tag: package-2022-09 - - tag: package-2022-02 - - tag: package-2021-12 - - tag: package-2021-08-preview - - tag: package-2021-05 - - tag: package-2021-03 - - tag: package-2020-11 - - tag: package-2020-04 - - tag: package-2019-09 - - tag: package-2018-01 - - multiapiscript: true -``` - -``` yaml $(multiapiscript) -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/ -perform-load: false -``` - -### Tag: package-2024-03-preview and python - -These settings apply only when `--tag=package-2024-03-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2024-03-preview' && $(python) -namespace: azure.mgmt.databox.v2024_03_01_preview -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2024_03_01_preview -``` - -### Tag: package-2024-02-preview and python - -These settings apply only when `--tag=package-2024-02-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2024-02-preview' && $(python) -namespace: azure.mgmt.databox.v2024_02_01_preview -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2024_02_01_preview -``` - -### Tag: package-2023-12 and python - -These settings apply only when `--tag=package-2023-12 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-12' && $(python) -namespace: azure.mgmt.databox.v2023_12_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2023_12_01 -``` - -### Tag: package-2023-03 and python - -These settings apply only when `--tag=package-2023-03 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-03' && $(python) -namespace: azure.mgmt.databox.v2023_03_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2023_03_01 -``` - -### Tag: package-2022-12 and python - -These settings apply only when `--tag=package-2022-12 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2022-12' && $(python) -namespace: azure.mgmt.databox.v2022_12_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2022_12_01 -``` - -### Tag: package-2022-10 and python - -These settings apply only when `--tag=package-2022-10 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2022-10' && $(python) -namespace: azure.mgmt.databox.v2022_10_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2022_10_01 -``` - -### Tag: package-2022-09 and python - -These settings apply only when `--tag=package-2022-09 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2022-09' && $(python) -namespace: azure.mgmt.databox.v2022_09_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2022_09_01 ``` -### Tag: package-2022-02 and python - -These settings apply only when `--tag=package-2022-02 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2022-02' && $(python) -namespace: azure.mgmt.databox.v2022_02_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2022_02_01 -``` - -### Tag: package-2021-12 and python - -These settings apply only when `--tag=package-2021-12 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-12' && $(python) -namespace: azure.mgmt.databox.v2021_12_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2021_12_01 -``` - -### Tag: package-2021-08-preview and python - -These settings apply only when `--tag=package-2021-08-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-08-preview' && $(python) -namespace: azure.mgmt.databox.v2021_08_01_preview -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2021_08_01_preview -``` - -### Tag: package-2021-05 and python - -These settings apply only when `--tag=package-2021-05 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-05' && $(python) -namespace: azure.mgmt.databox.v2021_05_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2021_05_01 -``` - -### Tag: package-2021-03 and python - -These settings apply only when `--tag=package-2021-03 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-03' && $(python) -namespace: azure.mgmt.databox.v2021_03_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2021_03_01 -``` - -### Tag: package-2020-11 and python - -These settings apply only when `--tag=package-2020-11 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-11' && $(python) -namespace: azure.mgmt.databox.v2020_11_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2020_11_01 -``` - -### Tag: package-2020-04 and python - -These settings apply only when `--tag=package-2020-04 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-04' && $(python) -namespace: azure.mgmt.databox.v2020_04_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2020_04_01 -``` - -### Tag: package-2019-09 and python - -These settings apply only when `--tag=package-2019-09 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-09' && $(python) -namespace: azure.mgmt.databox.v2019_09_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2019_09_01 -``` - -### Tag: package-2018-01 and python - -These settings apply only when `--tag=package-2018-01 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2018-01' && $(python) -namespace: azure.mgmt.databox.v2018_01_01 -output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2018_01_01 +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox ``` diff --git a/specification/digitaltwins/resource-manager/readme.python.md b/specification/digitaltwins/resource-manager/readme.python.md index 1fd7c6dda03b..3149c6931d4e 100644 --- a/specification/digitaltwins/resource-manager/readme.python.md +++ b/specification/digitaltwins/resource-manager/readme.python.md @@ -3,110 +3,16 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -```yaml $(python) +``` yaml $(python) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-digitaltwins -package-version: 1.0.0b1 -no-namespace-folders: true -``` - -### Python multi-api - -Generate all API versions currently shipped for this package - -```yaml $(python) -multiapi: true -default-api-version: "2023-01-31" +namespace: azure.mgmt.digitaltwins +package-version: 7.0.0 clear-output-folder: true -batch: - - tag: package-2023-01 - - tag: package-2022-10 - - tag: package-2022-05 - - tag: package-2021-06-30-preview - - tag: package-2020-12 - - tag: package-2020-10 - - tag: package-2020-03-01-preview - - multiapiscript: true -``` - -``` yaml $(multiapiscript) -output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins/ -perform-load: false -``` - -### Tag: package-2023-01 and python - -These settings apply only when `--tag=package-2023-01 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-01' && $(python) -namespace: azure.mgmt.digitaltwins.v2023_01_31 -output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins/v2023_01_31 -``` - -### Tag: package-2022-10 and python - -These settings apply only when `--tag=package-2022-10 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2022-10' && $(python) -namespace: azure.mgmt.digitaltwins.v2022_10_31 -output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins/v2022_10_31 -``` - -### Tag: package-2022-05 and python - -These settings apply only when `--tag=package-2022-05 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2022-05' && $(python) -namespace: azure.mgmt.digitaltwins.v2022_05_31 -output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins/v2022_05_31 ``` -### Tag: package-2021-06-30-preview and python - -These settings apply only when `--tag=package-2021-06-30-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-06-30-preview' && $(python) -namespace: azure.mgmt.digitaltwins.v2021_06_30_preview -output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins/v2021_06_30_preview -``` - -### Tag: package-2020-12 and python - -These settings apply only when `--tag=package-2020-12 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-12' && $(python) -namespace: azure.mgmt.digitaltwins.v2020_12_01 -output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins/v2020_12_01 -``` - -### Tag: package-2020-10 and python - -These settings apply only when `--tag=package-2020-10 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-10' && $(python) -namespace: azure.mgmt.digitaltwins.v2020_10_31 -output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins/v2020_10_31 -``` - -### Tag: package-2020-03-01-preview and python - -These settings apply only when `--tag=package-2020-03-01-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-03-01-preview' && $(python) -namespace: azure.mgmt.digitaltwins.v2020_03_01_preview -output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins/v2020_03_01_preview -``` - - -```yaml $(python) -modelerfour: - lenient-model-deduplication: true +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins ``` diff --git a/specification/edge/Microsoft.Edge.Management/tspconfig.yaml b/specification/edge/Microsoft.Edge.Management/tspconfig.yaml index eab6dfa143ab..5f82fdff7ce7 100644 --- a/specification/edge/Microsoft.Edge.Management/tspconfig.yaml +++ b/specification/edge/Microsoft.Edge.Management/tspconfig.yaml @@ -1,3 +1,12 @@ +parameters: + "service-dir": + default: "sdk/commonedgesitemanageroperations" + "python-sdk-folder": + default: "{project-root}/azure-sdk-for-python/" + "java-sdk-folder": + default: "{project-root}/azure-sdk-for-java/" + "service-directory-name": + default: "commonedgesitemanageroperations" emit: - "@azure-tools/typespec-autorest" options: @@ -7,6 +16,46 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/edge/{version-status}/{version}/operations.json" arm-types-dir: "{project-root}/../../common-types/resource-management" + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-commonedgesitemanageroperations" + namespace: "com.azure.resourcemanager.commonedgesitemanageroperations" + emitter-output-dir: "{java-sdk-folder}/sdk/{service-directory-name}/azure-resourcemanager-commonedgesitemanageroperations" + flavor: azure + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-commonedgesitemanageroperations" + package-name: "{package-dir}" + emitter-output-dir: "{python-sdk-folder}/sdk/{service-directory-name}/{package-name}" + generate-test: true + generate-sample: true + flavor: azure + "@azure-tools/typespec-ts": + azureSdkForJs: true + isModularLibrary: true + generateMetadata: true + hierarchyClient: false + experimentalExtensibleEnums: true + enableOperationGroup: true + flavor: azure + package-dir: "arm-commonedgesitemanageroperations" + packageDetails: + name: "@azure/arm-commonedgesitemanageroperations" + "@azure-tools/typespec-csharp": + package-dir: "Azure.ResourceManager.CommonEdgeSiteManagerOperations" + namespace: "{package-dir}" + clear-output-folder: true + model-namespace: false + flavor: azure + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/commonedgesitemanageroperations" + package-dir: "armcommonedgesitemanageroperations" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/{package-dir}" + fix-const-stuttering: true + flavor: "azure" + generate-examples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true + remove-unreferenced-types: true linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/edge/Microsoft.Edge.Sites.Management/tspconfig.yaml b/specification/edge/Microsoft.Edge.Sites.Management/tspconfig.yaml index f19226f18685..a40975d3745a 100644 --- a/specification/edge/Microsoft.Edge.Sites.Management/tspconfig.yaml +++ b/specification/edge/Microsoft.Edge.Sites.Management/tspconfig.yaml @@ -1,3 +1,12 @@ +parameters: + "service-dir": + default: "sdk/sitemanager" + "python-sdk-folder": + default: "{project-root}/azure-sdk-for-python/" + "java-sdk-folder": + default: "{project-root}/azure-sdk-for-java/" + "service-directory-name": + default: "sitemanager" emit: - "@azure-tools/typespec-autorest" options: @@ -7,6 +16,47 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/sites/{version-status}/{version}/sites.json" arm-types-dir: "{project-root}/../../common-types/resource-management" + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-sitemanager" + namespace: "com.azure.resourcemanager.sitemanager" + emitter-output-dir: "{java-sdk-folder}/sdk/{service-directory-name}/azure-resourcemanager-sitemanager" + flavor: azure + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-sitemanager" + package-name: "{package-dir}" + emitter-output-dir: "{python-sdk-folder}/sdk/{service-directory-name}/{package-name}" + generate-test: true + generate-sample: true + flavor: azure + "@azure-tools/typespec-ts": + azureSdkForJs: true + isModularLibrary: true + generateMetadata: true + hierarchyClient: false + experimentalExtensibleEnums: true + enableOperationGroup: true + flavor: azure + package-dir: "arm-sitemanager" + packageDetails: + name: "@azure/arm-sitemanager" + "@azure-tools/typespec-csharp": + package-dir: "Azure.ResourceManager.SiteManager" + namespace: "{package-dir}" + clear-output-folder: true + model-namespace: false + flavor: azure + generate-sample-project: false + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/sitemanager" + package-dir: "armsitemanager" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/{package-dir}" + fix-const-stuttering: true + flavor: "azure" + generate-examples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true + remove-unreferenced-types: true linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.az.md b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.az.md index 3a913718257c..dd4e0f0cabaa 100644 --- a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.az.md +++ b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.az.md @@ -6,11 +6,11 @@ For new Resource Provider. It is highly recommended to onboard Azure CLI extensi ``` yaml $(az) && $(target-mode) != 'core' az: - extensions: edgeupdates - namespace: azure.mgmt.edgeupdates - package-name: azure-mgmt-edgeupdates -az-output-folder: $(azure-cli-extension-folder)/src/edgeupdates -python-sdk-output-folder: "$(az-output-folder)/azext_edgeupdates/vendored_sdks/edgeupdates" + extensions: commonedgesitemanageroperations + namespace: azure.mgmt.commonedgesitemanageroperations + package-name: azure-mgmt-commonedgesitemanageroperations +az-output-folder: $(azure-cli-extension-folder)/src/commonedgesitemanageroperations +python-sdk-output-folder: "$(az-output-folder)/azext_commonedgesitemanageroperations/vendored_sdks/commonedgesitemanageroperations" # add additional configuration here specific for Azure CLI # refer to the faq.md for more details ``` @@ -20,9 +20,9 @@ python-sdk-output-folder: "$(az-output-folder)/azext_edgeupdates/vendored_sdks/e This is for command modules that already in azure cli main repo. ``` yaml $(az) && $(target-mode) == 'core' az: - extensions: edgeupdates - namespace: azure.mgmt.edgeupdates - package-name: azure-mgmt-edgeupdates -az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/edgeupdates -python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/edgeupdates" + extensions: commonedgesitemanageroperations + namespace: azure.mgmt.commonedgesitemanageroperations + package-name: azure-mgmt-commonedgesitemanageroperations +az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/commonedgesitemanageroperations +python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/commonedgesitemanageroperations" ``` \ No newline at end of file diff --git a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.csharp.md b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.csharp.md index 17306261f4f0..ce153bb60ca5 100644 --- a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.csharp.md +++ b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.csharp.md @@ -11,5 +11,5 @@ csharp: clear-output-folder: true client-side-validation: false namespace: Microsoft.Edge - output-folder: $(csharp-sdks-folder)/edgeupdates/management/Microsoft.Edge/GeneratedProtocol + output-folder: $(csharp-sdks-folder)/commonedgesitemanageroperations/management/Microsoft.Edge/GeneratedProtocol ``` \ No newline at end of file diff --git a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.go.md b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.go.md index 44597e30919a..43fa0763cf5c 100644 --- a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.go.md +++ b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.go.md @@ -5,7 +5,7 @@ These settings apply only when `--go` is specified on the command line. ```yaml $(go) && $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION -module-name: sdk/resourcemanager/edgeupdates/armedgeupdates +module-name: sdk/resourcemanager/commonedgesitemanageroperations/armcommonedgesitemanageroperations module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) ``` \ No newline at end of file diff --git a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.java.md b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.java.md new file mode 100644 index 000000000000..38efe778cd63 --- /dev/null +++ b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.java.md @@ -0,0 +1,12 @@ +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +namespace: com.azure.resourcemanager.commonedgesitemanageroperations +license-header: MICROSOFT_MIT_NO_VERSION +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-commonedgesitemanageroperations +``` \ No newline at end of file diff --git a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.md b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.md index 45063be20a28..fcf490afd284 100644 --- a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.md +++ b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.md @@ -27,14 +27,14 @@ These are the global settings for the edge. ```yaml openapi-type: arm openapi-subtype: providerHub -tag: updates-package-2024-02-01-preview +tag: package-2024-02-01-preview ``` -### Tag: updates-package-2024-02-01-preview +### Tag: package-2024-02-01-preview -These settings apply only when `--tag=updates-package-2024-02-01-preview` is specified on the command line. +These settings apply only when `--tag=package-2024-02-01-preview` is specified on the command line. -```yaml $(tag) == 'updates-package-2024-02-01-preview' +```yaml $(tag) == 'package-2024-02-01-preview' input-file: - preview/2024-02-01-preview/operations.json ``` @@ -51,6 +51,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java + - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-resource-manager-schemas - repo: azure-cli-extensions @@ -77,3 +78,7 @@ See configuration in [readme.typescript.md](./readme.typescript.md) See configuration in [readme.csharp.md](./readme.csharp.md) +## Java + +See configuration in [readme.java.md](./readme.java.md) + diff --git a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.python.md b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.python.md index d0219bf5fcd6..4aa7d619ff3f 100644 --- a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.python.md +++ b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.python.md @@ -6,13 +6,13 @@ Please also specify `--python-sdks-folder=`. + +``` yaml $(java) +azure-arm: true +namespace: com.azure.resourcemanager.sitemanager +license-header: MICROSOFT_MIT_NO_VERSION +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-sitemanager +``` \ No newline at end of file diff --git a/specification/edge/resource-manager/Microsoft.Edge/sites/readme.md b/specification/edge/resource-manager/Microsoft.Edge/sites/readme.md index 86d64c575a6d..8995c5c1fbec 100644 --- a/specification/edge/resource-manager/Microsoft.Edge/sites/readme.md +++ b/specification/edge/resource-manager/Microsoft.Edge/sites/readme.md @@ -86,3 +86,7 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp See configuration in [readme.csharp.md](./readme.csharp.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) diff --git a/specification/edge/resource-manager/Microsoft.Edge/sites/readme.python.md b/specification/edge/resource-manager/Microsoft.Edge/sites/readme.python.md index b0a6463f78da..d2d9ecf4f9b4 100644 --- a/specification/edge/resource-manager/Microsoft.Edge/sites/readme.python.md +++ b/specification/edge/resource-manager/Microsoft.Edge/sites/readme.python.md @@ -6,13 +6,13 @@ Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -These settings apply only when `--track2` is specified on the command line. ``` yaml $(python) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION -namespace: azure.mgmt.edgeorder package-name: azure-mgmt-edgeorder -package-version: 1.0.0b1 +namespace: azure.mgmt.edgeorder +package-version: 3.0.0 +clear-output-folder: true title: EdgeOrderManagementClient description: The EdgeOrder Client. -clear-output-folder: true -no-namespace-folders: true ``` -### Python multi-api - -Generate all API versions currently shipped for this package - -```yaml $(python) -multiapi: true -default-api-version: "2021-12-01" -batch: - - tag: package-2022-05-preview - - tag: package-2021-12 - - tag: package-2020-12-preview - - multiapiscript: true -``` - -``` yaml $(multiapiscript) -output-folder: $(python-sdks-folder)/edgeorder/azure-mgmt-edgeorder/azure/mgmt/edgeorder/ -perform-load: false -``` - -### Tag: package-2022-05-preview and python - -These settings apply only when `--tag=package-2022-05-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2022-05-preview' && $(python) -namespace: azure.mgmt.edgeorder.v2022_05_01_preview -output-folder: $(python-sdks-folder)/edgeorder/azure-mgmt-edgeorder/azure/mgmt/edgeorder/v2022_05_01_preview -``` - -### Tag: package-2021-12 and python - -These settings apply only when `--tag=package-2021-12 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-12' && $(python) -namespace: azure.mgmt.edgeorder.v2021_12_01 -output-folder: $(python-sdks-folder)/edgeorder/azure-mgmt-edgeorder/azure/mgmt/edgeorder/v2021_12_01 -``` - -### Tag: package-2020-12-preview and python - -These settings apply only when `--tag=package-2020-12-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-12-preview' && $(python) -namespace: azure.mgmt.edgeorder.v2020_12_01_preview -output-folder: $(python-sdks-folder)/edgeorder/azure-mgmt-edgeorder/azure/mgmt/edgeorder/v2020_12_01_preview +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/edgeorder/azure-mgmt-edgeorder/azure/mgmt/edgeorder ``` diff --git a/specification/extendedlocation/resource-manager/readme.python.md b/specification/extendedlocation/resource-manager/readme.python.md index 6663d71b5b44..06bf337a8ff7 100644 --- a/specification/extendedlocation/resource-manager/readme.python.md +++ b/specification/extendedlocation/resource-manager/readme.python.md @@ -1,59 +1,18 @@ ## Python -These settings apply only when `--track2` is specified on the command line. +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. -```yaml $(python) +``` yaml $(python) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-extendedlocation -package-version: 1.0.0b1 -no-namespace-folders: true -``` - -### Python multi-api - -``` yaml $(python) -multiapi: true -default-api-version: "2021-08-15" +namespace: azure.mgmt.extendedlocation +package-version: 2.0.0 clear-output-folder: true -batch: - - tag: package-2021-03-15-preview - - tag: package-2021-08-15 - - tag: package-2021-08-31-preview - - multiapiscript: true -``` - -```yaml $(multiapiscript) -output-folder: $(python-sdks-folder)/extendedlocation/azure-mgmt-extendedlocation/azure/mgmt/extendedlocation/ -perform-load: false -``` - -### Tag: package-2021-03-15-preview and python - -These settings apply only when `--tag=package-2021-03-15-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -```yaml $(tag) == 'package-2021-03-15-preview' && $(python) -namespace: azure.mgmt.extendedlocation.v2021_03_15_preview -output-folder: $(python-sdks-folder)/extendedlocation/azure-mgmt-extendedlocation/azure/mgmt/extendedlocation/v2021_03_15_preview -``` - -### Tag: package-2021-08-15 and python - -These settings apply only when `--tag=package-2021-08-15 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -```yaml $(tag) == 'package-2021-08-15' && $(python) -namespace: azure.mgmt.extendedlocation.v2021_08_15 -output-folder: $(python-sdks-folder)/extendedlocation/azure-mgmt-extendedlocation/azure/mgmt/extendedlocation/v2021_08_15 ``` -### Tag: package-2021-08-31-preview and python - -These settings apply only when `--tag=package-2021-08-31-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -```yaml $(tag) == 'package-2021-08-31-preview' && $(python) -namespace: azure.mgmt.extendedlocation.v2021_08_31_preview -output-folder: $(python-sdks-folder)/extendedlocation/azure-mgmt-extendedlocation/azure/mgmt/extendedlocation/v2021_08_31_preview +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/extendedlocation/azure-mgmt-extendedlocation/azure/mgmt/extendedlocation ``` diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/examples/InferenceGroup/modifyDeltaModelsAsync.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/examples/InferenceGroup/modifyDeltaModelsAsync.json index 0ed4d21d786e..f56cbb15cfe5 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/examples/InferenceGroup/modifyDeltaModelsAsync.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/examples/InferenceGroup/modifyDeltaModelsAsync.json @@ -19,7 +19,7 @@ "responses": { "202": { "headers": { - "location": "location_header_to_poll" + "location": "https://management.azure.com/subscriptions/...pathToOperationStatus.." } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/AKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/AKSCompute.json new file mode 100644 index 000000000000..864d6775c8f8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/AKSCompute.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01", + "parameters": { + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "properties": { + "agentCount": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded", + "properties": { + "agentCount": 4 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/AmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/AmlCompute.json new file mode 100644 index 000000000000..f655df9d1ef5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/AmlCompute.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "description": "some compute", + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "computeType": "AmlCompute", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "osType": "Windows", + "virtualMachineImage": null, + "isolatedNetwork": false, + "subnet": { + "id": "test-subnet-resource-id" + }, + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "Enabled", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "errors": null, + "currentNodeCount": 0, + "targetNodeCount": 1, + "nodeStateCounts": { + "preparingNodeCount": 0, + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "leavingNodeCount": 0, + "preemptedNodeCount": 0 + }, + "enableNodePublicIp": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/BasicAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/BasicAKSCompute.json new file mode 100644 index 000000000000..5c8723409d25 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/BasicAKSCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AKS" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/BasicAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/BasicAmlCompute.json new file mode 100644 index 000000000000..7baed97381b1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/BasicAmlCompute.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "osType": "Windows", + "virtualMachineImage": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myImageGallery/images/myImageDefinition/versions/0.0.1" + }, + "isolatedNetwork": false, + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "NotSpecified", + "enableNodePublicIp": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json new file mode 100644 index 000000000000..1dcb286d73d1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "DataFactory" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/ComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/ComputeInstance.json new file mode 100644 index 000000000000..488eb405f5d4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/ComputeInstance.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6", + "subnet": { + "id": "test-subnet-resource-id" + }, + "applicationSharingPolicy": "Personal", + "customServices": [ + { + "docker": { + "privileged": true + }, + "environmentVariables": { + "test_variable": { + "type": "local", + "value": "test_value" + } + }, + "volumes": [ + { + "type": "bind", + "readOnly": false, + "source": "/home/azureuser/cloudfiles", + "target": "/home/azureuser/cloudfiles" + } + ], + "endpoints": [ + { + "name": "connect", + "target": 8787, + "published": 8787, + "protocol": "http" + } + ], + "image": { + "type": "docker", + "reference": "ghcr.io/azure/rocker-rstudio-ml-verse:latest" + }, + "name": "rstudio" + } + ], + "sshSettings": { + "sshPublicAccess": "Disabled" + }, + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json new file mode 100644 index 000000000000..52530f0fdc4c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json new file mode 100644 index 000000000000..df9634796c0a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6", + "applicationSharingPolicy": "Personal", + "sshSettings": { + "sshPublicAccess": "Disabled" + }, + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + }, + "schedules": { + "computeStartStop": [ + { + "status": "Enabled", + "action": "Stop", + "triggerType": "Cron", + "cron": { + "expression": "0 18 * * *", + "startTime": "2021-04-23T01:30:00", + "timeZone": "Pacific Standard Time" + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/KubernetesCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/KubernetesCompute.json new file mode 100644 index 000000000000..4589b2ddfcb1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/createOrUpdate/KubernetesCompute.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01", + "parameters": { + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "properties": { + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "provisioningState": "Creating", + "properties": { + "relayConnectionString": null, + "serviceBusConnectionString": null, + "extensionPrincipalId": null, + "extensionInstanceReleaseTrain": "stable", + "vcName": null, + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "provisioningState": "Creating", + "properties": { + "relayConnectionString": null, + "serviceBusConnectionString": null, + "extensionPrincipalId": null, + "extensionInstanceReleaseTrain": "stable", + "vcName": null, + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/delete.json new file mode 100644 index 000000000000..f1e3c6ee6b11 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01", + "underlyingResourceAction": "Delete" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/get/AKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/get/AKSCompute.json new file mode 100644 index 000000000000..2af320f50ab6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/get/AKSCompute.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/get/AmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/get/AmlCompute.json new file mode 100644 index 000000000000..49ab7cc5b531 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/get/AmlCompute.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "computeType": "AmlCompute", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "osType": "Windows", + "virtualMachineImage": null, + "isolatedNetwork": false, + "subnet": { + "id": "test-subnet-resource-id" + }, + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "Enabled", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "errors": null, + "currentNodeCount": 0, + "targetNodeCount": 1, + "nodeStateCounts": { + "preparingNodeCount": 0, + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "leavingNodeCount": 0, + "preemptedNodeCount": 0 + }, + "enableNodePublicIp": true + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/get/ComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/get/ComputeInstance.json new file mode 100644 index 000000000000..2f086cc4d86c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/get/ComputeInstance.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "computeType": "ComputeInstance", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "subnet": { + "id": "test-subnet-resource-id" + }, + "applicationSharingPolicy": "Shared", + "sshSettings": { + "sshPublicAccess": "Enabled", + "adminUserName": "azureuser", + "sshPort": 22 + }, + "osImageMetadata": { + "currentImageVersion": "22.06.14", + "latestImageVersion": "22.07.22", + "isLatestOsImageVersion": false + }, + "customServices": [ + { + "docker": { + "privileged": true + }, + "environmentVariables": { + "test_var": { + "type": "local", + "value": "test_val" + } + }, + "volumes": [ + { + "type": "bind", + "readOnly": false, + "source": "/home/azureuser/cloudfiles", + "target": "/home/azureuser/cloudfiles" + } + ], + "endpoints": [ + { + "name": "connect", + "target": 8787, + "published": 8787, + "protocol": "http" + } + ], + "image": { + "type": "docker", + "reference": "ghcr.io/azure/rocker-rstudio-ml-verse:latest" + }, + "name": "rstudio" + } + ], + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + }, + "createdBy": { + "userName": "foobar@microsoft.com", + "userOrgId": "00000000-0000-0000-0000-000000000000", + "userId": "00000000-0000-0000-0000-000000000000" + }, + "connectivityEndpoints": { + "publicIpAddress": "10.0.0.1", + "privateIpAddress": "10.0.0.1" + }, + "applications": [ + { + "displayName": "Jupyter", + "endpointUri": "https://compute123.eastus2.azureml.net/jupyter" + } + ], + "errors": null, + "state": "Running" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/get/KubernetesCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/get/KubernetesCompute.json new file mode 100644 index 000000000000..2da66c44a520 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/get/KubernetesCompute.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "provisioningState": "Succeeded", + "isAttachedCompute": true, + "properties": { + "relayConnectionString": null, + "serviceBusConnectionString": null, + "extensionPrincipalId": null, + "extensionInstanceReleaseTrain": "stable", + "vcName": null, + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/list.json new file mode 100644 index 000000000000..900042c42150 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/list.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute1234", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute1234", + "location": "eastus", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute1234-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/listKeys.json new file mode 100644 index 000000000000..b2a4700ed4c8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/listKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "computeType": "AKS", + "userKubeConfig": "user kube config...", + "adminKubeConfig": "admin kube config...", + "imagePullSecretName": "the image pull secret name" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/listNodes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/listNodes.json new file mode 100644 index 000000000000..afa0070d8074 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/listNodes.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "nodes": [ + { + "nodeId": "tvm-3601533753_1-20170719t162906z", + "privateIpAddress": "13.84.190.124", + "publicIpAddress": "13.84.190.134", + "port": 50000, + "nodeState": "running", + "runId": "2f378a44-38f2-443a-9f0d-9909d0b47890" + }, + { + "nodeId": "tvm-3601533753_2-20170719t162906z", + "privateIpAddress": "13.84.190.124", + "publicIpAddress": "13.84.190.134", + "port": 50001, + "nodeState": "idle" + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/patch.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/patch.json new file mode 100644 index 000000000000..825bb28e1626 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/patch.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01", + "parameters": { + "properties": { + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/restart.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/restart.json new file mode 100644 index 000000000000..dc8e2560b465 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/restart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...computeOperationsStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/start.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/start.json new file mode 100644 index 000000000000..dc8e2560b465 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/start.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...computeOperationsStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/stop.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/stop.json new file mode 100644 index 000000000000..dc8e2560b465 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Compute/stop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2024-10-01" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...computeOperationsStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/DataReference/getBlobReferenceSAS.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/DataReference/getBlobReferenceSAS.json new file mode 100644 index 000000000000..c287947a2a8d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/DataReference/getBlobReferenceSAS.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "assetId": "string", + "blobUri": "https://www.contoso.com/example" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "NoCredentials" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json new file mode 100644 index 000000000000..4c22508df524 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "skipValidation": false, + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey", + "key": "string" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "isDefault": false, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "isDefault": false, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json new file mode 100644 index 000000000000..2659128f9b9d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "skipValidation": false, + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal", + "clientSecret": "string" + } + }, + "datastoreType": "AzureDataLakeGen1", + "storeName": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } + }, + "datastoreType": "AzureDataLakeGen1", + "storeName": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } + }, + "datastoreType": "AzureDataLakeGen1", + "storeName": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json new file mode 100644 index 000000000000..bccadee0df0d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "skipValidation": false, + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal", + "clientSecret": "string" + } + }, + "datastoreType": "AzureDataLakeGen2", + "filesystem": "string", + "accountName": "string", + "endpoint": "string", + "protocol": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } + }, + "datastoreType": "AzureDataLakeGen2", + "filesystem": "string", + "accountName": "string", + "endpoint": "string", + "protocol": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } + }, + "datastoreType": "AzureDataLakeGen2", + "filesystem": "string", + "accountName": "string", + "endpoint": "string", + "protocol": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json new file mode 100644 index 000000000000..aaba36abfed9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "skipValidation": false, + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey", + "key": "string" + } + }, + "datastoreType": "AzureFile", + "accountName": "string", + "fileShareName": "string", + "endpoint": "string", + "protocol": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureFile", + "accountName": "string", + "fileShareName": "string", + "endpoint": "string", + "protocol": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureFile", + "accountName": "string", + "fileShareName": "string", + "endpoint": "string", + "protocol": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/delete.json new file mode 100644 index 000000000000..fa09d91d2bf4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/get.json new file mode 100644 index 000000000000..85fddc8a32b7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "isDefault": false, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/list.json new file mode 100644 index 000000000000..74ecf56ea56a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/list.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01", + "$skipToken": "string", + "count": 1, + "isDefault": false, + "names": [ + "string" + ], + "searchText": "string", + "orderBy": "string", + "orderByAsc": false + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "isDefault": false, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/listSecrets.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/listSecrets.json new file mode 100644 index 000000000000..c5b310dafb7a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Datastore/listSecrets.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "secretsType": "AccountKey", + "key": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ExternalFQDN/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ExternalFQDN/get.json new file mode 100644 index 000000000000..25ea7962a06b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ExternalFQDN/get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "category": "Azure Active Directory", + "endpoints": [ + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + }, + { + "properties": { + "category": "Azure portal", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Feature/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Feature/get.json new file mode 100644 index 000000000000..89b7f2882265 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Feature/get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "featuresetName": "string", + "featuresetVersion": "string", + "featureName": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "featureName": "string", + "dataType": "Float" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:51", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:51", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Feature/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Feature/list.json new file mode 100644 index 000000000000..c0b6a66898e0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Feature/list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "featuresetName": "string", + "featuresetVersion": "string", + "api-version": "2024-10-01", + "$skipToken": "string", + "tags": "string", + "featureName": "string", + "description": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "featureName": "string", + "dataType": "Boolean" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:50", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:50", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/AutoMLJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/AutoMLJob/createOrUpdate.json new file mode 100644 index 000000000000..ef98591bcf36 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/AutoMLJob/createOrUpdate.json @@ -0,0 +1,252 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "jobType": "AutoML", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + } + } + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "taskDetails": { + "taskType": "ImageClassification", + "limitSettings": { + "maxTrials": 2 + }, + "targetColumnName": "string", + "trainingData": { + "jobInputType": "mltable", + "uri": "string" + }, + "modelSettings": { + "validationCropSize": 2 + }, + "searchSpace": [ + { + "validationCropSize": "choice(2, 360)" + } + ] + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Scheduled", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "jobType": "AutoML", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + } + } + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "taskDetails": { + "taskType": "ImageClassification", + "limitSettings": { + "maxTrials": 2 + }, + "targetColumnName": "string", + "trainingData": { + "jobInputType": "mltable", + "uri": "string" + }, + "modelSettings": { + "validationCropSize": 2 + }, + "searchSpace": [ + { + "validationCropSize": "choice(2, 360)" + } + ] + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Scheduled", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "jobType": "AutoML", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + } + } + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "taskDetails": { + "taskType": "ImageClassification", + "limitSettings": { + "maxTrials": 2 + }, + "targetColumnName": "string", + "trainingData": { + "jobInputType": "mltable", + "uri": "string" + }, + "modelSettings": { + "validationCropSize": 2 + }, + "searchSpace": [ + { + "validationCropSize": "choice(2, 360)" + } + ] + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/AutoMLJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/AutoMLJob/get.json new file mode 100644 index 000000000000..ef9c22534f7f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/AutoMLJob/get.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Scheduled", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "jobType": "AutoML", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + } + } + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "taskDetails": { + "taskType": "ImageClassification", + "limitSettings": { + "maxTrials": 2 + }, + "targetColumnName": "string", + "trainingData": { + "jobInputType": "mltable", + "uri": "string" + }, + "modelSettings": { + "validationCropSize": 2 + }, + "searchSpace": [ + { + "validationCropSize": "choice(2, 360)" + } + ] + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/AutoMLJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/AutoMLJob/list.json new file mode 100644 index 000000000000..e4a89f9925a6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/AutoMLJob/list.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Scheduled", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "jobType": "AutoML", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + } + } + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "taskDetails": { + "taskType": "ImageClassification", + "limitSettings": { + "maxTrials": 2 + }, + "targetColumnName": "string", + "trainingData": { + "jobInputType": "mltable", + "uri": "string" + }, + "modelSettings": { + "validationCropSize": 2 + }, + "searchSpace": [ + { + "validationCropSize": "choice(2, 360)" + } + ] + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/CommandJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/CommandJob/createOrUpdate.json new file mode 100644 index 000000000000..f33f60c7dd89 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/CommandJob/createOrUpdate.json @@ -0,0 +1,252 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "e6b6493e-7d5e-4db3-be1e-306ec641327e": null + } + } + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "ReadWriteMount", + "uri": "string" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "identity": { + "identityType": "AMLToken" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "a0847709-f5aa-4561-8ba5-d915d403fdcf": null + } + } + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "ReadWriteMount", + "uri": "string" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "identity": { + "identityType": "AMLToken" + }, + "parameters": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "b8163d40-c351-43d6-8a34-d0cd895b8a5a": null + } + } + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "ReadWriteMount", + "uri": "string" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "identity": { + "identityType": "AMLToken" + }, + "parameters": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/CommandJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/CommandJob/get.json new file mode 100644 index 000000000000..59916ef17df9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/CommandJob/get.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "8385cf05-78c0-41ef-b31d-36796a678e19": null + } + } + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "ReadWriteMount", + "uri": "string" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "identity": { + "identityType": "AMLToken" + }, + "parameters": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/CommandJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/CommandJob/list.json new file mode 100644 index 000000000000..b9f6d163167d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/CommandJob/list.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01", + "$skipToken": "string", + "jobType": "string", + "tag": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "7aad5998-6c83-4ca9-b50a-b44dfc43f420": null + } + } + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "ReadWriteMount", + "uri": "string" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "identity": { + "identityType": "AMLToken" + }, + "parameters": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/PipelineJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/PipelineJob/createOrUpdate.json new file mode 100644 index 000000000000..262f0b4e9810 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/PipelineJob/createOrUpdate.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/PipelineJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/PipelineJob/get.json new file mode 100644 index 000000000000..0c200e8efece --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/PipelineJob/get.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/PipelineJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/PipelineJob/list.json new file mode 100644 index 000000000000..71b1019198d9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/PipelineJob/list.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01", + "$skipToken": "string", + "jobType": "string", + "tag": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/SweepJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/SweepJob/createOrUpdate.json new file mode 100644 index 000000000000..1741cea2e982 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/SweepJob/createOrUpdate.json @@ -0,0 +1,246 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Sweep", + "samplingAlgorithm": { + "samplingAlgorithmType": "Grid" + }, + "limits": { + "jobLimitsType": "Sweep", + "maxTotalTrials": 1, + "maxConcurrentTrials": 1, + "trialTimeout": "PT1S" + }, + "earlyTermination": { + "evaluationInterval": 1, + "delayEvaluation": 1, + "policyType": "MedianStopping" + }, + "objective": { + "primaryMetric": "string", + "goal": "Minimize" + }, + "trial": { + "codeId": "string", + "command": "string", + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "distribution": { + "distributionType": "Mpi", + "processCountPerInstance": 1 + }, + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "e6b6493e-7d5e-4db3-be1e-306ec641327e": null + } + } + } + }, + "searchSpace": { + "string": {} + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Sweep", + "samplingAlgorithm": { + "samplingAlgorithmType": "Grid" + }, + "limits": { + "jobLimitsType": "Sweep", + "maxTotalTrials": 1, + "maxConcurrentTrials": 1, + "trialTimeout": "PT1S" + }, + "earlyTermination": { + "evaluationInterval": 1, + "delayEvaluation": 1, + "policyType": "MedianStopping" + }, + "objective": { + "primaryMetric": "string", + "goal": "Minimize" + }, + "trial": { + "codeId": "string", + "command": "string", + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "distribution": { + "distributionType": "Mpi", + "processCountPerInstance": 1 + }, + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "e6b6493e-7d5e-4db3-be1e-306ec641327e": null + } + } + } + }, + "searchSpace": { + "string": {} + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Sweep", + "samplingAlgorithm": { + "samplingAlgorithmType": "Grid" + }, + "limits": { + "jobLimitsType": "Sweep", + "maxTotalTrials": 1, + "maxConcurrentTrials": 1, + "trialTimeout": "PT1S" + }, + "earlyTermination": { + "evaluationInterval": 1, + "delayEvaluation": 1, + "policyType": "MedianStopping" + }, + "objective": { + "primaryMetric": "string", + "goal": "Minimize" + }, + "trial": { + "codeId": "string", + "command": "string", + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "distribution": { + "distributionType": "Mpi", + "processCountPerInstance": 1 + }, + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "e6b6493e-7d5e-4db3-be1e-306ec641327e": null + } + } + } + }, + "searchSpace": { + "string": {} + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/SweepJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/SweepJob/get.json new file mode 100644 index 000000000000..55b02a320df7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/SweepJob/get.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Sweep", + "samplingAlgorithm": { + "samplingAlgorithmType": "Grid" + }, + "limits": { + "jobLimitsType": "Sweep", + "maxTotalTrials": 1, + "maxConcurrentTrials": 1, + "trialTimeout": "PT1S" + }, + "earlyTermination": { + "evaluationInterval": 1, + "delayEvaluation": 1, + "policyType": "MedianStopping" + }, + "objective": { + "primaryMetric": "string", + "goal": "Minimize" + }, + "trial": { + "codeId": "string", + "command": "string", + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "distribution": { + "distributionType": "Mpi", + "processCountPerInstance": 1 + }, + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "e6b6493e-7d5e-4db3-be1e-306ec641327e": null + } + } + } + }, + "searchSpace": { + "string": {} + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/SweepJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/SweepJob/list.json new file mode 100644 index 000000000000..35f8b698ce97 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/SweepJob/list.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01", + "$skipToken": "string", + "jobType": "string", + "tag": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Sweep", + "samplingAlgorithm": { + "samplingAlgorithmType": "Grid" + }, + "limits": { + "jobLimitsType": "Sweep", + "maxTotalTrials": 1, + "maxConcurrentTrials": 1, + "trialTimeout": "PT1S" + }, + "earlyTermination": { + "evaluationInterval": 1, + "delayEvaluation": 1, + "policyType": "MedianStopping" + }, + "objective": { + "primaryMetric": "string", + "goal": "Minimize" + }, + "trial": { + "codeId": "string", + "command": "string", + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "distribution": { + "distributionType": "Mpi", + "processCountPerInstance": 1 + }, + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "e6b6493e-7d5e-4db3-be1e-306ec641327e": null + } + } + } + }, + "searchSpace": { + "string": {} + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/cancel.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/cancel.json new file mode 100644 index 000000000000..cbbfc8b0d1c0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/cancel.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": { + "location": "http://subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/my-favorite-aml-job" + } + }, + "202": { + "headers": { + "location": "http://subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/my-favorite-aml-job" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/delete.json new file mode 100644 index 000000000000..70cb7e1fdf9d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Job/delete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "http://subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/my-favorite-aml-job", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": { + "location": "http://subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/my-favorite-aml-job" + } + }, + "202": { + "headers": { + "location": "http://subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/my-favorite-aml-job" + } + }, + "204": { + "headers": { + "location": "http://subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/my-favorite-aml-job" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/createOrUpdateRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/createOrUpdateRule.json new file mode 100644 index 000000000000..88df01f8366a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/createOrUpdateRule.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "ruleName": "rule_name_1", + "api-version": "2024-10-01", + "body": { + "properties": { + "type": "FQDN", + "destination": "destination_endpoint", + "status": "Active", + "category": "UserDefined" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/outboundRules/rule_name_1", + "name": "rule_name_1", + "type": "workspace/outboundRules", + "properties": { + "type": "FQDN", + "destination": "destination_endpoint", + "status": "Active", + "category": "UserDefined" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/deleteRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/deleteRule.json new file mode 100644 index 000000000000..afea8bbb6d83 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/deleteRule.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "ruleName": "rule-name", + "api-version": "2024-10-01" + }, + "responses": { + "202": { + "headers": { + "Location": "location_url_to_poll_for_status" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/getRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/getRule.json new file mode 100644 index 000000000000..78d733fbc63f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/getRule.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "ruleName": "name_of_the_fqdn_rule", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/outboundRules/rule_name_1", + "name": "rule_name_1", + "type": "workspace/outboundRules", + "properties": { + "type": "FQDN", + "destination": "destination_of_the_fqdn_rule", + "status": "Active", + "category": "UserDefined" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/listRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/listRule.json new file mode 100644 index 000000000000..b6192bbf5b02 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/listRule.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/outboundRules/rule_name_1", + "name": "rule_name_1", + "type": "workspace/outboundRules", + "properties": { + "type": "FQDN", + "destination": "destination_of_the_fqdn_rule", + "status": "Inactive", + "category": "Required" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/outboundRules/rule_name_2", + "name": "rule_name_2", + "type": "workspace/outboundRules", + "properties": { + "type": "FQDN", + "destination": "destination_of_the_fqdn_rule", + "status": "Inactive", + "category": "Required" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/provision.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/provision.json new file mode 100644 index 000000000000..45c2d198c396 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/ManagedNetwork/provision.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "api-version": "2024-10-01", + "body": { + "includeSpark": false + } + }, + "responses": { + "202": { + "headers": { + "Location": "location_url_to_poll_for_status" + } + }, + "200": { + "body": { + "status": "Active", + "sparkReady": true + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Notebook/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Notebook/listKeys.json new file mode 100644 index 000000000000..a62e5e638157 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Notebook/listKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "primaryAccessKey": null, + "secondaryAccessKey": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Notebook/prepare.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Notebook/prepare.json new file mode 100644 index 000000000000..319231181015 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Notebook/prepare.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "resourceId": "aabbccddee112233445566778899", + "fqdn": "testnotebook.notebooks.azure.com", + "notebookPreparationError": { + "statusCode": 500, + "errorMessage": "general error" + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json new file mode 100644 index 000000000000..3ba93933769f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/get.json new file mode 100644 index 000000000000..78ca24b6c407 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/get.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json new file mode 100644 index 000000000000..18b26573cb9f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-10-01", + "$skipToken": "string", + "count": 1 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "Microsoft.MachineLearning.Services/endpoints/deployments", + "sku": { + "name": "string", + "tier": "Free" + }, + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "Automatic" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/update.json new file mode 100644 index 000000000000..eefee57dbf65 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/update.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-10-01", + "body": { + "tags": {}, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json new file mode 100644 index 000000000000..3a758cba6f5e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/get.json new file mode 100644 index 000000000000..818287e979a4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/get.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json new file mode 100644 index 000000000000..18b26573cb9f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-10-01", + "$skipToken": "string", + "count": 1 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "Microsoft.MachineLearning.Services/endpoints/deployments", + "sku": { + "name": "string", + "tier": "Free" + }, + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "Automatic" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/update.json new file mode 100644 index 000000000000..10c3a2f1db5e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/update.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-10-01", + "body": { + "tags": {}, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/getLogs.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/getLogs.json new file mode 100644 index 000000000000..f33dbcfc38f0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/getLogs.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-10-01", + "endpointName": "testEndpoint", + "deploymentName": "testDeployment", + "body": { + "containerType": "StorageInitializer", + "tail": 0 + } + }, + "responses": { + "200": { + "body": { + "content": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/list.json new file mode 100644 index 000000000000..3dfc2f79054b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/OnlineDeployment/list.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateEndpointConnection/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateEndpointConnection/createOrUpdate.json new file mode 100644 index 000000000000..85eb8e7e77a0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateEndpointConnection/createOrUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-10-01", + "monitor": "true", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateEndpointConnection/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateEndpointConnection/delete.json new file mode 100644 index 000000000000..7977264c3a02 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateEndpointConnection/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-10-01", + "monitor": "true" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateEndpointConnection/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateEndpointConnection/get.json new file mode 100644 index 000000000000..7d709f12af02 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateEndpointConnection/get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-10-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateEndpointConnection/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateEndpointConnection/list.json new file mode 100644 index 000000000000..9f35ab6740d1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateEndpointConnection/list.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2024-10-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateLinkResource/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateLinkResource/list.json new file mode 100644 index 000000000000..51017d26aa36 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/PrivateLinkResource/list.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "api-version": "2024-10-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateLinkResources/amlworkspace", + "name": "amlworkspace", + "type": "Microsoft.MachineLearningServices/workspaces/privateLinkResources", + "properties": { + "groupId": "amlworkspace", + "requiredMembers": [ + "default" + ] + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Quota/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Quota/list.json new file mode 100644 index 000000000000..ea10fc18f171 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Quota/list.json @@ -0,0 +1,415 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 48, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quota", + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Quota/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Quota/update.json new file mode 100644 index 000000000000..a0e74c551f6d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Quota/update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2024-10-01", + "parameters": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 100, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 200, + "unit": "Count" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 100, + "unit": "Count", + "status": "Success" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 200, + "unit": "Count", + "status": "Success" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/createOrUpdate-SystemCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/createOrUpdate-SystemCreated.json new file mode 100644 index 000000000000..8d0ee3aa5487 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/createOrUpdate-SystemCreated.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/createOrUpdate-UserCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/createOrUpdate-UserCreated.json new file mode 100644 index 000000000000..9c4eabde888c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/createOrUpdate-UserCreated.json @@ -0,0 +1,260 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:39", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:39", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:39", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:39", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/delete.json new file mode 100644 index 000000000000..8ef8a2af8693 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location", + "Retry-After": 100 + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/get-SystemCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/get-SystemCreated.json new file mode 100644 index 000000000000..63a1a2753725 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/get-SystemCreated.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:40", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:40", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/get-UserCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/get-UserCreated.json new file mode 100644 index 000000000000..1ae301756c07 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/get-UserCreated.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:45", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:45", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/list-SystemCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/list-SystemCreated.json new file mode 100644 index 000000000000..18b93d49c072 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/list-SystemCreated.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:40", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:40", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/list-UserCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/list-UserCreated.json new file mode 100644 index 000000000000..e12d2cc63f53 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/list-UserCreated.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:42", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:42", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/listBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/listBySubscription.json new file mode 100644 index 000000000000..25c75bdefc41 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/listBySubscription.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/removeRegions.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/removeRegions.json new file mode 100644 index 000000000000..aef52f469ff8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/removeRegions.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + }, + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + }, + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + }, + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + }, + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:01", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:01", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "202": { + "headers": { + "Location": "example_location", + "Retry-After": 100 + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/update-SystemCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/update-SystemCreated.json new file mode 100644 index 000000000000..d6bf753f3133 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/update-SystemCreated.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-10-01", + "body": { + "tags": {}, + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Basic", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:02", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:02", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/update-UserCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/update-UserCreated.json new file mode 100644 index 000000000000..b60c69c81d77 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registries/update-UserCreated.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2024-10-01", + "body": { + "tags": {}, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Basic", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:58", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:58", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeContainer/createOrUpdate.json new file mode 100644 index 000000000000..b0ee539b38cb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeContainer/createOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-10-01", + "codeName": "testContainer", + "body": { + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeContainer/delete.json new file mode 100644 index 000000000000..85f3c5b804c8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-10-01", + "codeName": "testContainer" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeContainer/get.json new file mode 100644 index 000000000000..6976b3677d98 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-10-01", + "codeName": "testContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeContainer/list.json new file mode 100644 index 000000000000..afcec28178f0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeContainer/list.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-10-01", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-08-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/codes/testContainer2", + "name": "testContainer2", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-08-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..cf34307afb65 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "codeName": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "pendingUploadId": "string", + "pendingUploadType": "TemporaryBlobReference" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "SAS", + "sasUri": "https://www.contoso.com/example" + } + }, + "pendingUploadId": "string", + "pendingUploadType": "None" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/createOrUpdate.json new file mode 100644 index 000000000000..dc416b61150d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/createOrUpdate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "codeName": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/delete.json new file mode 100644 index 000000000000..2b51aa8b87b1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "codeName": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/get.json new file mode 100644 index 000000000000..8c780e4be72a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "codeName": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/list.json new file mode 100644 index 000000000000..e7e7f29a8696 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/CodeVersion/list.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "codeName": "string", + "api-version": "2024-10-01", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentContainer/createOrUpdate.json new file mode 100644 index 000000000000..c46362227551 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentContainer/createOrUpdate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentContainer/delete.json new file mode 100644 index 000000000000..1c76c6b56b03 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentContainer/get.json new file mode 100644 index 000000000000..9307a3e65fab --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentContainer/get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentContainer/list.json new file mode 100644 index 000000000000..180230cc703b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentContainer/list.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "testContainer", + "api-version": "2024-10-01", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentVersion/createOrUpdate.json new file mode 100644 index 000000000000..5f51f60c35c7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentVersion/createOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "8ced901b-d826-477d-bfef-329da9672513": null + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "2de2e74e-457d-4447-a581-933abc2b9d96": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "a6c1349d-5e45-48da-92c3-3ce176cb30e9": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentVersion/delete.json new file mode 100644 index 000000000000..604b7b737084 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentVersion/get.json new file mode 100644 index 000000000000..6d851bdc6113 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentVersion/get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "1a7c40b5-2029-4f5f-a8d6-fd0822038773": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentVersion/list.json new file mode 100644 index 000000000000..6285fb031a05 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ComponentVersion/list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "api-version": "2024-10-01", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "50acbce5-cccc-475a-8ac6-c4da402afbd8": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataContainer/createOrUpdate.json new file mode 100644 index 000000000000..8e61738a5c44 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataContainer/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "dataType": "uri_folder" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "mltable" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "uri_folder" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataContainer/delete.json new file mode 100644 index 000000000000..09e423abbc97 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataContainer/get.json new file mode 100644 index 000000000000..8bbc47e42bb3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataContainer/get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "uri_file" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:14", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:14", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataContainer/registryList.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataContainer/registryList.json new file mode 100644 index 000000000000..c87cb1e7483b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataContainer/registryList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "api-version": "2024-10-01", + "$skipToken": "string", + "listViewType": "All" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "uri_folder" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..8a43ba87d95e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "pendingUploadId": "string", + "pendingUploadType": "None" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "SAS", + "sasUri": "https://www.contoso.com/example" + } + }, + "pendingUploadId": "string", + "pendingUploadType": "None" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/createOrUpdate.json new file mode 100644 index 000000000000..b79ee7e6ee6d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/createOrUpdate.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:13", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:13", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:13", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:13", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/delete.json new file mode 100644 index 000000000000..4dc649d3d669 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/get.json new file mode 100644 index 000000000000..419ee89dc9f9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:14", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:14", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/registryList.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/registryList.json new file mode 100644 index 000000000000..06ed58428a4d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/DataVersionBase/registryList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2024-10-01", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string", + "$tags": "string", + "listViewType": "ArchivedOnly" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:48", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:48", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentContainer/createOrUpdate.json new file mode 100644 index 000000000000..0fcd75e7cec4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentContainer/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-10-01", + "environmentName": "testEnvironment", + "body": { + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/registries/environments", + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + }, + "systemData": { + "createdAt": "2020-12-04T03:39:11.300Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-04T03:39:11.300Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/registries/environments", + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + }, + "systemData": { + "createdAt": "2020-12-04T03:39:11.301Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-04T03:39:11.301Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentContainer/delete.json new file mode 100644 index 000000000000..9e51970f5072 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-10-01", + "environmentName": "testContainer" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentContainer/get.json new file mode 100644 index 000000000000..edee07583524 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2024-10-01", + "environmentName": "testEnvironment" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/registries/environments", + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentContainer/list.json new file mode 100644 index 000000000000..47b32fcf1b22 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentContainer/list.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "environmentName": "testContainer", + "api-version": "2024-10-01", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/registries/environments", + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentVersion/createOrUpdate.json new file mode 100644 index 000000000000..a2c5a0b53d86 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentVersion/createOrUpdate.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "environmentName": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentVersion/delete.json new file mode 100644 index 000000000000..340ca0d171d0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "environmentName": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentVersion/get.json new file mode 100644 index 000000000000..856f19ad8d42 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentVersion/get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "environmentName": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentVersion/list.json new file mode 100644 index 000000000000..620bf0325349 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/EnvironmentVersion/list.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-regsitry", + "environmentName": "string", + "api-version": "2024-10-01", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelContainer/createOrUpdate.json new file mode 100644 index 000000000000..aab3233506df --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelContainer/createOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "registry123", + "api-version": "2024-10-01", + "modelName": "testContainer", + "body": { + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/registry123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/registry123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelContainer/delete.json new file mode 100644 index 000000000000..2214eaee1eaa --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "registry123", + "api-version": "2024-10-01", + "modelName": "testContainer" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelContainer/get.json new file mode 100644 index 000000000000..43c71d483ee1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "registry123", + "api-version": "2024-10-01", + "modelName": "testContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/registry123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelContainer/list.json new file mode 100644 index 000000000000..e77985f321f3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelContainer/list.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "registry123", + "api-version": "2024-10-01", + "name": "testContainer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/registry123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..343fb8373530 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "modelName": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "pendingUploadId": "string", + "pendingUploadType": "TemporaryBlobReference" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "SAS", + "sasUri": "https://www.contoso.com/example" + } + }, + "pendingUploadId": "string", + "pendingUploadType": "None" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/createOrUpdate.json new file mode 100644 index 000000000000..e65fbd9da9bf --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/createOrUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/delete.json new file mode 100644 index 000000000000..6e9f1e01ebb7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/get.json new file mode 100644 index 000000000000..08005c89742f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/list.json new file mode 100644 index 000000000000..7bbec13c87bb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Registry/ModelVersion/list.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "api-version": "2024-10-01", + "$skipToken": "string", + "$orderBy": "string", + "$top": 1, + "version": "string", + "description": "string", + "offset": 1, + "tags": "string", + "properties": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Schedule/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Schedule/createOrUpdate.json new file mode 100644 index 000000000000..5e81fe42c367 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Schedule/createOrUpdate.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "9965593e-526f-4b89-bb36-761138cf2794": null + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "d77a9a9a-4bb5-4c0c-8a77-459be8b82b9f": null + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "13ea51e0-ff28-49c3-a85d-9b5199eb14e5": null + } + }, + "provisioningState": "Failed" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Schedule/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Schedule/delete.json new file mode 100644 index 000000000000..d82ab644a83e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Schedule/delete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": { + "location": "http://subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/my-favorite-aml-job" + } + }, + "202": { + "headers": { + "location": "http://subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/my-favorite-aml-job" + } + }, + "204": { + "headers": { + "location": "http://subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/my-favorite-aml-job" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Schedule/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Schedule/get.json new file mode 100644 index 000000000000..6513ef9f28dc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Schedule/get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "a108545b-def1-4c86-8e53-dbcb1de3a8bc": null + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Schedule/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Schedule/list.json new file mode 100644 index 000000000000..bfd51b0aa53b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Schedule/list.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "00cd1396-a094-4d48-8d86-14c43a55a6af": null + } + }, + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Usage/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Usage/list.json new file mode 100644 index 000000000000..47b6836e8cee --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Usage/list.json @@ -0,0 +1,400 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/totalCores/usages", + "currentValue": 7, + "limit": 100, + "name": { + "localizedValue": "Clusters", + "value": "Clusters" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/dedicatedCores/usages", + "currentValue": 14, + "limit": 24, + "name": { + "localizedValue": "Total Cluster Dedicated Regional vCPUs", + "value": "Total Cluster Dedicated Regional vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 48, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_dsv2/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster2_dsv2/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 0, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 12, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 6, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_nc/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/usages", + "currentValue": 6, + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluser1_nc/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 6, + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/lowPriorityCores/usages", + "currentValue": 18, + "limit": 50, + "name": { + "localizedValue": "Total Cluster LowPriority Regional vCPUs", + "value": "Total Cluster LowPriority Regional vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_D_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "value": "Standard D Family Cluster LowPriority vCPUs", + "localizedValue": "Standard D Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_DSv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard DSv2 Family Cluster LowPriority vCPUs", + "value": "Standard DSv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_Dv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard Dv2 Family Cluster LowPriority vCPUs", + "value": "Standard Dv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_FSv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard FSv2 Family Cluster LowPriority vCPUs", + "value": "Standard FSv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 18, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 12, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster2_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster3_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NCv2 Family Cluster LowPriority vCPUs", + "value": "Standard NCv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv3_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NCv3 Family Cluster LowPriority vCPUs", + "value": "Standard NCv3 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_ND_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard ND Family Cluster LowPriority vCPUs", + "value": "Standard ND Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NDv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NDv2 Family Cluster LowPriority vCPUs", + "value": "Standard NDv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NV_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NV Family Cluster LowPriority vCPUs", + "value": "Standard NV Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/VirtualMachineSize/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/VirtualMachineSize/list.json new file mode 100644 index 000000000000..8cd3e417dbdf --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/VirtualMachineSize/list.json @@ -0,0 +1,388 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-10-01", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_DS1_v2", + "family": "standardDSv2Family", + "vCPUs": 1, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 7168, + "memoryGB": 3.5, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.13, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.01, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.07, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.05, + "osType": "Windows", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS2_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 14336, + "memoryGB": 7.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.03, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.15, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.1, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.25, + "osType": "Windows", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS3_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.2, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.06, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.5, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.29, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS4_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.12, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.4, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 1.01, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.58, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS5_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 1.17, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.81, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 2.02, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.23, + "osType": "Linux", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS11_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.26, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.18, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.11, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.04, + "osType": "Linux", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS12_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.37, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.53, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.21, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.07, + "osType": "Linux", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS13_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.15, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.42, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.74, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 1.06, + "osType": "Windows", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS14_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 229376, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.3, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 1.48, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.84, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 2.11, + "osType": "Windows", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/createOrUpdate.json new file mode 100644 index 000000000000..52d6eb417613 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/createOrUpdate.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "cd3c37dc-2876-4ca4-8a54-21bd7619724a": null + } + } + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "4939850d-8eae-4343-8566-0826259a2ad1": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "b76755e4-16bf-45d4-b625-6634df7444cc": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/delete.json new file mode 100644 index 000000000000..c9dd3296e9d2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/get.json new file mode 100644 index 000000000000..7af802364f51 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/get.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "843c2bb4-e5f1-4267-98c8-ba22a99dbb00": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/list.json new file mode 100644 index 000000000000..5f8a351dae94 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/list.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "a3c13e2e-a213-4cac-9f5a-b49966906ad6": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/update.json new file mode 100644 index 000000000000..aff7b3e4ad84 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchDeployment/update.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string" + }, + "tags": {} + } + }, + "responses": { + "200": { + "headers": { + "Location": "example_location" + }, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "1e5e1cf9-b0ea-4cf6-9764-e750bf85c10a": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/createOrUpdate.json new file mode 100644 index 000000000000..3a02e62ac76d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/createOrUpdate.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + }, + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/delete.json new file mode 100644 index 000000000000..c17877b7887f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1234", + "workspaceName": "testworkspace", + "endpointName": "testBatchEndpoint", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/get.json new file mode 100644 index 000000000000..0fdf9ea533fd --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/get.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/list.json new file mode 100644 index 000000000000..9c28e6229021 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/list.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01", + "$skipToken": "string", + "count": 1 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/listKeys.json new file mode 100644 index 000000000000..84531d297b32 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/listKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryKey": "string", + "secondaryKey": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/update.json new file mode 100644 index 000000000000..a60b4105989f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/BatchEndpoint/update.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01", + "body": { + "tags": {}, + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + } + } + }, + "responses": { + "200": { + "headers": { + "Location": "example_location" + }, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeContainer/createOrUpdate.json new file mode 100644 index 000000000000..260baa088985 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeContainer/createOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-10-01", + "name": "testContainer", + "body": { + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeContainer/delete.json new file mode 100644 index 000000000000..5649ed093dda --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-10-01", + "name": "testContainer" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeContainer/get.json new file mode 100644 index 000000000000..2b44f7cca054 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-10-01", + "name": "testContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeContainer/list.json new file mode 100644 index 000000000000..050796cc5462 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeContainer/list.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "name": "testcode", + "api-version": "2024-10-01", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-08-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer2", + "name": "testContainer2", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-08-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..06d4f9a642c3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "pendingUploadId": "string", + "pendingUploadType": "None" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "SAS", + "sasUri": "https://www.contoso.com/example" + } + }, + "pendingUploadId": "string", + "pendingUploadType": "None" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/createOrUpdate.json new file mode 100644 index 000000000000..a3e0504dc255 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/createOrUpdate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/delete.json new file mode 100644 index 000000000000..09e46ecd67ec --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/get.json new file mode 100644 index 000000000000..9181447b0392 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/list.json new file mode 100644 index 000000000000..93ab2358ccee --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/list.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/publish.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/publish.json new file mode 100644 index 000000000000..835ed4665021 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/CodeVersion/publish.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "registryName": "string", + "destinationName": "string", + "destinationVersion": "string" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentContainer/createOrUpdate.json new file mode 100644 index 000000000000..d4ba593c8206 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentContainer/createOrUpdate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentContainer/delete.json new file mode 100644 index 000000000000..fa09d91d2bf4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentContainer/get.json new file mode 100644 index 000000000000..940197539483 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentContainer/get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentContainer/list.json new file mode 100644 index 000000000000..4e95eba6acbc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentContainer/list.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/createOrUpdate.json new file mode 100644 index 000000000000..c32c206110bc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/createOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "8ced901b-d826-477d-bfef-329da9672513": null + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "2de2e74e-457d-4447-a581-933abc2b9d96": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "a6c1349d-5e45-48da-92c3-3ce176cb30e9": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/delete.json new file mode 100644 index 000000000000..09e46ecd67ec --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/get.json new file mode 100644 index 000000000000..a96464ce9968 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "1a7c40b5-2029-4f5f-a8d6-fd0822038773": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/list.json new file mode 100644 index 000000000000..98645f53ef5e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "50acbce5-cccc-475a-8ac6-c4da402afbd8": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/publish.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/publish.json new file mode 100644 index 000000000000..835ed4665021 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ComponentVersion/publish.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "registryName": "string", + "destinationName": "string", + "destinationVersion": "string" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataContainer/createOrUpdate.json new file mode 100644 index 000000000000..ef9ee409e59a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataContainer/createOrUpdate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-10-01", + "name": "datacontainer123", + "body": { + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123", + "name": "datacontainer123", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123", + "name": "datacontainer123", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataContainer/delete.json new file mode 100644 index 000000000000..15b29dc18333 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-10-01", + "name": "datacontainer123" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataContainer/get.json new file mode 100644 index 000000000000..079c6a9106a1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataContainer/get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-10-01", + "name": "datacontainer123" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123", + "name": "datacontainer123", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataContainer/list.json new file mode 100644 index 000000000000..e6143cbb838b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataContainer/list.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "name": "data123", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123", + "name": "datastore123", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer124", + "name": "datastore124", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/createOrUpdate.json new file mode 100644 index 000000000000..5816e559bff7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/delete.json new file mode 100644 index 000000000000..09e46ecd67ec --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/get.json new file mode 100644 index 000000000000..0b2e58d687f9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/list.json new file mode 100644 index 000000000000..2947edd264bb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string", + "$tags": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/publish.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/publish.json new file mode 100644 index 000000000000..835ed4665021 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/DataVersionBase/publish.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "registryName": "string", + "destinationName": "string", + "destinationVersion": "string" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentContainer/createOrUpdate.json new file mode 100644 index 000000000000..97bda03d2bd2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentContainer/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-10-01", + "name": "testEnvironment", + "body": { + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/workspaces/environments", + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + }, + "systemData": { + "createdAt": "2020-12-04T03:39:11.300Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-04T03:39:11.300Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/workspaces/environments", + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + }, + "systemData": { + "createdAt": "2020-12-04T03:39:11.301Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-04T03:39:11.301Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentContainer/delete.json new file mode 100644 index 000000000000..5649ed093dda --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-10-01", + "name": "testContainer" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentContainer/get.json new file mode 100644 index 000000000000..32bbe107015a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-10-01", + "name": "testEnvironment" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/workspaces/environments", + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentContainer/list.json new file mode 100644 index 000000000000..1aa598fb2bfd --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentContainer/list.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2024-10-01", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/workspaces/environments", + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/createOrUpdate.json new file mode 100644 index 000000000000..d62538987843 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/createOrUpdate.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/delete.json new file mode 100644 index 000000000000..09e46ecd67ec --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/get.json new file mode 100644 index 000000000000..a1e6d3af54d7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/list.json new file mode 100644 index 000000000000..f7adee90e5cc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/list.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/publish.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/publish.json new file mode 100644 index 000000000000..835ed4665021 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/EnvironmentVersion/publish.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "registryName": "string", + "destinationName": "string", + "destinationVersion": "string" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetContainer/createOrUpdate.json new file mode 100644 index 000000000000..913fb7b582cf --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetContainer/createOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:48", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:48", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:48", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:48", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetContainer/delete.json new file mode 100644 index 000000000000..3b859bd1cbf3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetContainer/getEntity.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetContainer/getEntity.json new file mode 100644 index 000000000000..78f306d15f91 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetContainer/getEntity.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:49", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:49", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetContainer/list.json new file mode 100644 index 000000000000..84f6e2cc1def --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetContainer/list.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01", + "$skipToken": "string", + "tags": "string", + "listViewType": "ArchivedOnly" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:46", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:46", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/backfill.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/backfill.json new file mode 100644 index 000000000000..1cbb983082b4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/backfill.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "displayName": "string", + "description": "string", + "featureWindow": { + "featureWindowStart": "2020-01-01T12:34:56.999+00:51", + "featureWindowEnd": "2020-01-01T12:34:56.999+00:51" + }, + "tags": { + "string": "string" + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + }, + "jobId": "string", + "dataAvailabilityStatus": [ + "None" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobIds": [ + "string", + "string" + ] + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/createOrUpdate.json new file mode 100644 index 000000000000..b64d52043d07 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/createOrUpdate.json @@ -0,0 +1,219 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "Online", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Day", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Monday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "OnlineAndOffline", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Day", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Wednesday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "Offline", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Hour", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Wednesday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Failed" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/delete.json new file mode 100644 index 000000000000..60465e72fcb4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/get.json new file mode 100644 index 000000000000..32f895ee3aec --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/get.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "None", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Minute", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Wednesday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/list.json new file mode 100644 index 000000000000..295a9553fa6a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturesetVersion/list.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "$skipToken": "string", + "tags": "string", + "listViewType": "All" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "Offline", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Month", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Saturday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:49", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:49", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json new file mode 100644 index 000000000000..eb669093ef28 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityContainer/delete.json new file mode 100644 index 000000000000..3b859bd1cbf3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityContainer/getEntity.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityContainer/getEntity.json new file mode 100644 index 000000000000..425b8aa9612f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityContainer/getEntity.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:43", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:43", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityContainer/list.json new file mode 100644 index 000000000000..f3cde961898f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityContainer/list.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01", + "$skipToken": "string", + "tags": "string", + "listViewType": "All" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:43", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:43", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json new file mode 100644 index 000000000000..1d217db6e979 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Datetime", + "columnName": "string" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Integer", + "columnName": "string" + } + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:58", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:58", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Integer", + "columnName": "string" + } + ], + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:58", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:58", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityVersion/delete.json new file mode 100644 index 000000000000..60465e72fcb4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityVersion/get.json new file mode 100644 index 000000000000..dfcfd2ba17f7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityVersion/get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Datetime", + "columnName": "string" + } + ], + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:57", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:57", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityVersion/list.json new file mode 100644 index 000000000000..1b97697637b5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/FeaturestoreEntityVersion/list.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "$skipToken": "string", + "tags": "string", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Datetime", + "columnName": "string" + } + ], + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:55", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:55", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/MarketplaceSubscription/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/MarketplaceSubscription/createOrUpdate.json new file mode 100644 index 000000000000..a2dcbed37f30 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/MarketplaceSubscription/createOrUpdate.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "modelId": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelId": "string", + "marketplacePlan": { + "publisherId": "string", + "offerId": "string", + "planId": "string" + }, + "marketplaceSubscriptionStatus": "Suspended", + "provisioningState": "Failed" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:08", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:08", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelId": "string", + "marketplacePlan": { + "publisherId": "string", + "offerId": "string", + "planId": "string" + }, + "marketplaceSubscriptionStatus": "Suspended", + "provisioningState": "Failed" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:08", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:08", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/MarketplaceSubscription/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/MarketplaceSubscription/delete.json new file mode 100644 index 000000000000..aefa0465feca --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/MarketplaceSubscription/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/MarketplaceSubscription/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/MarketplaceSubscription/get.json new file mode 100644 index 000000000000..a541f8e19eaa --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/MarketplaceSubscription/get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelId": "string", + "marketplacePlan": { + "publisherId": "string", + "offerId": "string", + "planId": "string" + }, + "marketplaceSubscriptionStatus": "Subscribed", + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:08", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:08", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/MarketplaceSubscription/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/MarketplaceSubscription/list.json new file mode 100644 index 000000000000..757c712f8960 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/MarketplaceSubscription/list.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelId": "string", + "marketplacePlan": { + "publisherId": "string", + "offerId": "string", + "planId": "string" + }, + "marketplaceSubscriptionStatus": "Suspended", + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:06", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:06", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelContainer/createOrUpdate.json new file mode 100644 index 000000000000..cafe40afb902 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelContainer/createOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-10-01", + "name": "testContainer", + "body": { + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelContainer/delete.json new file mode 100644 index 000000000000..cf45dc888512 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-10-01", + "name": "testContainer" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelContainer/get.json new file mode 100644 index 000000000000..dff2f2735be1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-10-01", + "name": "testContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelContainer/list.json new file mode 100644 index 000000000000..54cf6c3ed619 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelContainer/list.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-10-01", + "name": "testContainer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/createOrUpdate.json new file mode 100644 index 000000000000..94d04f4ac8b9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/createOrUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/delete.json new file mode 100644 index 000000000000..09e46ecd67ec --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/get.json new file mode 100644 index 000000000000..cf9a7a4f87b9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/list.json new file mode 100644 index 000000000000..88948851fa64 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/list.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "$skipToken": "string", + "$orderBy": "string", + "$top": 1, + "version": "string", + "description": "string", + "offset": 1, + "tags": "string", + "properties": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/package.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/package.json new file mode 100644 index 000000000000..fe670d02097b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/package.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "targetEnvironmentName": "string", + "targetEnvironmentVersion": "string", + "baseEnvironmentSource": { + "baseEnvironmentSourceType": "EnvironmentAsset", + "resourceId": "string" + }, + "inferencingServer": { + "serverType": "AzureMLBatch", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + } + }, + "environmentVariables": { + "string": "string" + }, + "modelConfiguration": { + "mode": "ReadOnlyMount", + "mountPath": "string" + }, + "inputs": [ + { + "inputType": "UriFile", + "mode": "Download", + "path": { + "inputPathType": "Url", + "url": "string" + }, + "mountPath": "string" + } + ], + "tags": { + "string": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "targetEnvironmentName": "string", + "targetEnvironmentVersion": "string", + "baseEnvironmentSource": { + "baseEnvironmentSourceType": "EnvironmentAsset", + "resourceId": "string" + }, + "inferencingServer": { + "serverType": "AzureMLBatch", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + } + }, + "environmentVariables": { + "string": "string" + }, + "modelConfiguration": { + "mode": "ReadOnlyMount", + "mountPath": "string" + }, + "inputs": [ + { + "inputType": "UriFile", + "mode": "Download", + "path": { + "inputPathType": "Url", + "url": "string" + }, + "mountPath": "string" + } + ], + "tags": { + "string": "string" + }, + "targetEnvironmentId": "string", + "logUrl": "string", + "buildId": "string", + "buildState": "NotStarted" + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/publish.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/publish.json new file mode 100644 index 000000000000..835ed4665021 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ModelVersion/publish.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2024-10-01", + "body": { + "registryName": "string", + "destinationName": "string", + "destinationVersion": "string" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineDeployment/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineDeployment/delete.json new file mode 100644 index 000000000000..0efe181c4608 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineDeployment/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2024-10-01", + "endpointName": "testEndpoint", + "deploymentName": "testDeployment" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/createOrUpdate.json new file mode 100644 index 000000000000..973df80a5533 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/createOrUpdate.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "authMode": "AMLToken", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/delete.json new file mode 100644 index 000000000000..c39072019052 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/get.json new file mode 100644 index 000000000000..6e6d3b12dae2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/getToken.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/getToken.json new file mode 100644 index 000000000000..3f03cc20e54e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/getToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "accessToken": "string", + "tokenType": "string", + "expiryTimeUtc": 1, + "refreshAfterTimeUtc": 1 + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/list.json new file mode 100644 index 000000000000..5a174d3b9d62 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/list.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01", + "$skipToken": "string", + "name": "string", + "count": 1, + "computeType": "Managed", + "tags": "string", + "properties": "string", + "orderBy": "CreatedAtDesc" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/listKeys.json new file mode 100644 index 000000000000..84531d297b32 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/listKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryKey": "string", + "secondaryKey": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/regenerateKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/regenerateKeys.json new file mode 100644 index 000000000000..ef684b4651d8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/regenerateKeys.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01", + "body": { + "keyType": "Primary", + "keyValue": "string" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/update.json new file mode 100644 index 000000000000..10deb5dade68 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/OnlineEndpoint/update.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2024-10-01", + "body": { + "tags": {}, + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/createOrUpdate.json new file mode 100644 index 000000000000..b8331e39c40e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/createOrUpdate.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "body": { + "properties": { + "modelSettings": { + "modelId": "string" + }, + "authMode": "Key", + "contentSafety": { + "contentSafetyStatus": "Enabled" + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelSettings": { + "modelId": "string" + }, + "authMode": "Key", + "inferenceEndpoint": { + "uri": "https://www.contoso.com/example", + "headers": { + "string": "string" + } + }, + "provisioningState": "Updating", + "endpointState": "Deleting", + "marketplaceSubscriptionId": "string", + "contentSafety": { + "contentSafetyStatus": "Disabled" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:14", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:14", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelSettings": { + "modelId": "string" + }, + "authMode": "Key", + "inferenceEndpoint": { + "uri": "https://www.contoso.com/example", + "headers": { + "string": "string" + } + }, + "provisioningState": "Failed", + "endpointState": "Deleting", + "marketplaceSubscriptionId": "string", + "contentSafety": { + "contentSafetyStatus": "Disabled" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:14", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:14", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/delete.json new file mode 100644 index 000000000000..aefa0465feca --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/get.json new file mode 100644 index 000000000000..6aa75eb663a7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/get.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelSettings": { + "modelId": "string" + }, + "authMode": "Key", + "inferenceEndpoint": { + "uri": "https://www.contoso.com/example", + "headers": { + "string": "string" + } + }, + "provisioningState": "Succeeded", + "endpointState": "Suspending", + "marketplaceSubscriptionId": "string", + "contentSafety": { + "contentSafetyStatus": "Enabled" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:13", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:13", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Premium", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/list.json new file mode 100644 index 000000000000..e6f770291ebc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/list.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2024-10-01", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelSettings": { + "modelId": "string" + }, + "authMode": "Key", + "inferenceEndpoint": { + "uri": "https://www.contoso.com/example", + "headers": { + "string": "string" + } + }, + "provisioningState": "Updating", + "endpointState": "Reinstating", + "marketplaceSubscriptionId": "string", + "contentSafety": { + "contentSafetyStatus": "Disabled" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:12", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:12", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Basic", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/listKeys.json new file mode 100644 index 000000000000..0d401577da49 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/listKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryKey": "string", + "secondaryKey": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/regenerateKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/regenerateKeys.json new file mode 100644 index 000000000000..f9edfad97ef4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/regenerateKeys.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "body": { + "keyType": "Primary", + "keyValue": "string" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryKey": "string", + "secondaryKey": "string" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/update.json new file mode 100644 index 000000000000..cddd9c238c80 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/ServerlessEndpoint/update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2024-10-01", + "body": { + "tags": {}, + "sku": { + "name": "string", + "tier": "Premium", + "size": "string", + "family": "string", + "capacity": 1 + }, + "identity": { + "type": "None", + "userAssignedIdentities": { + "string": {} + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelSettings": { + "modelId": "string" + }, + "authMode": "Key", + "inferenceEndpoint": { + "uri": "https://www.contoso.com/example", + "headers": { + "string": "string" + } + }, + "provisioningState": "Creating", + "endpointState": "Suspended", + "marketplaceSubscriptionId": "string", + "contentSafety": { + "contentSafetyStatus": "Disabled" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:13", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:13", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/create.json new file mode 100644 index 000000000000..0604fa5138c3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/create.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-10-01", + "parameters": { + "location": "eastus2euap", + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": {} + } + }, + "properties": { + "friendlyName": "HelloName", + "description": "test description", + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "encryption": { + "status": "Enabled", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai" + }, + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai" + }, + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "allowPublicAccessWhenBehindVnet": false, + "publicNetworkAccess": "Disabled", + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/delete.json new file mode 100644 index 000000000000..b6838ae20f9e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/diagnose.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/diagnose.json new file mode 100644 index 000000000000..ac83ac3bb82a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/diagnose.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-10-01", + "parameters": { + "value": { + "udr": {}, + "nsg": {}, + "resourceLock": {}, + "dnsResolution": {}, + "storageAccount": {}, + "keyVault": {}, + "containerRegistry": {}, + "applicationInsights": {}, + "others": {} + } + } + }, + "responses": { + "200": { + "body": { + "value": { + "userDefinedRouteResults": [], + "networkSecurityRuleResults": [], + "resourceLockResults": [], + "dnsResolutionResults": [ + { + "code": "CustomDNSInUse", + "level": "Warning", + "message": "We have detected an on-premise dns server is configured. Please make sure conditional forwarding is configured correctly according to doc https://foo" + } + ], + "storageAccountResults": [], + "keyVaultResults": [], + "containerRegistryResults": [], + "applicationInsightsResults": [], + "otherResults": [] + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/get.json new file mode 100644 index 000000000000..0568e27b214b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/get.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai" + }, + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "serviceProvisionedResourceGroup": "testworkspace_0000111122223333", + "privateLinkCount": 0, + "allowPublicAccessWhenBehindVnet": false, + "publicNetworkAccess": "Disabled", + "imageBuildCompute": "testcompute", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/testprivatelinkconnection", + "name": "testprivatelinkconnection", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ], + "sharedPrivateLinkResources": [ + { + "name": "testcosmosdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testcosmosdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listByResourceGroup.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listByResourceGroup.json new file mode 100644 index 000000000000..2176e036a48b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listByResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace1", + "name": "testworkspace1", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName 1", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listBySubscription.json new file mode 100644 index 000000000000..2996dc1fdab9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listBySubscription.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-5678/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listKeys.json new file mode 100644 index 000000000000..936ddaf7a30d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listKeys.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "userStorageKey": null, + "userStorageResourceId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/ragargeastus2euap/providers/Microsoft.Storage/storageAccounts/testdemoworkazashomr", + "appInsightsInstrumentationKey": null, + "containerRegistryCredentials": { + "location": null, + "username": "testdemoworkjmjmeykp", + "passwords": [ + { + "name": "password", + "value": "" + }, + { + "name": "password2", + "value": "0KARRQoQHSUq1yViPWg7YFernOS=Ic/t" + } + ] + }, + "notebookAccessKeys": { + "primaryAccessKey": null, + "secondaryAccessKey": null + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listNotebookAccessToken.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listNotebookAccessToken.json new file mode 100644 index 000000000000..93a53010723a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listNotebookAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "notebookResourceId": "94350843095843059", + "hostName": "Host product name", + "publicDns": "resource.notebooks.azure.net", + "tokenType": "Bearer", + "expiresIn": 28800.0, + "scope": "aznb_identity" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listStorageAccountKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listStorageAccountKeys.json new file mode 100644 index 000000000000..a8e002314356 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/listStorageAccountKeys.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "userStorageKey": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/operationsList.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/operationsList.json new file mode 100644 index 000000000000..5a6dc9e923a0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/operationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.MachineLearningServices/workspaces/write", + "display": { + "provider": "Microsoft MachineLearningServices", + "resource": "workspaces", + "operation": "Create/Update Machine Learning workspaces" + } + }, + { + "name": "Microsoft.MachineLearningServices/workspaces/delete", + "display": { + "provider": "Microsoft MachineLearningServices", + "resource": "workspaces", + "operation": "Delete Machine Learning workspaces" + } + }, + { + "name": "Microsoft.MachineLearningServices/workspaces/listkeys/action", + "display": { + "provider": "Microsoft MachineLearningServices", + "resource": "workspaces", + "operation": "List workspace Keys" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/resyncKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/resyncKeys.json new file mode 100644 index 000000000000..f245d11a4789 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/resyncKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/update.json new file mode 100644 index 000000000000..009e69aad3fc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/Workspace/update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2024-10-01", + "parameters": { + "properties": { + "friendlyName": "New friendly name", + "description": "new description", + "publicNetworkAccess": "Disabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "New friendly name", + "description": "new description", + "publicNetworkAccess": "Disabled" + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/create.json new file mode 100644 index 000000000000..a607abb6e94f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/create.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2024-10-01", + "parameters": { + "properties": { + "category": "ContainerRegistry", + "target": "www.facebook.com", + "authType": "None" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ContainerRegistry", + "target": "www.facebook.com", + "authType": "None" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/delete.json new file mode 100644 index 000000000000..9ec22d361c73 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/get.json new file mode 100644 index 000000000000..0aa9a9ed4395 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ContainerRegistry", + "target": "www.facebook.com", + "authType": "None" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/list.json new file mode 100644 index 000000000000..8a86daa5d108 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/list.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "api-version": "2024-10-01", + "target": "www.facebook.com", + "category": "ContainerRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ContainerRegistry", + "target": "www.facebook.com", + "authType": "PAT" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-2", + "name": "connection-2", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ContainerRegistry", + "target": "www.facebook.com", + "authType": "PAT" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/listSecrets.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/listSecrets.json new file mode 100644 index 000000000000..68c6ffbf6d52 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/listSecrets.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "authType": "AccessKey", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "category": "CustomKeys", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + }, + "systemData": { + "createdAt": "2020-01-01T00:00:00Z", + "createdBy": "some_string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T00:00:00Z", + "lastModifiedBy": "some_string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/update.json new file mode 100644 index 000000000000..0f02402b05f9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceConnection/update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2024-10-01", + "body": { + "properties": { + "authType": "AccessKey", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "authType": "AccessKey", + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + }, + "systemData": { + "createdAt": "2020-01-01T00:00:00Z", + "createdBy": "some_string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T00:00:00Z", + "lastModifiedBy": "some_string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceFeature/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceFeature/list.json new file mode 100644 index 000000000000..6904b44d63c8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/examples/WorkspaceFeature/list.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "testworkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "automatedml_createeditexperimentsui", + "displayName": "Create edit experiments UI", + "description": "Create, edit or delete AutoML experiments in the SDK" + }, + { + "id": "workspace_upgradeworkspaceui", + "displayName": "Upgrade workspace UI", + "description": "Upgrade workspace from Basic to enterprise from the UI" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/machineLearningServices.json new file mode 100644 index 000000000000..b52f9b0b1d9b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/machineLearningServices.json @@ -0,0 +1,3775 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usages_List", + "description": "Gets the current usage information as well as limits for AML resources for given subscription and location.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Usages": { + "$ref": "./examples/Usage/list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "Returns supported VM Sizes in a location", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Sizes": { + "$ref": "./examples/VirtualMachineSize/list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/updateQuotas": { + "post": { + "tags": [ + "Quota" + ], + "operationId": "Quotas_Update", + "description": "Update quota for each VM family in workspace.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for update quota is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaUpdateParameters" + }, + "description": "Quota update parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful.", + "schema": { + "$ref": "#/definitions/UpdateWorkspaceQuotasResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "update quotas": { + "$ref": "./examples/Quota/update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/quotas": { + "get": { + "tags": [ + "Quota" + ], + "operationId": "Quotas_List", + "description": "Gets the currently assigned Workspace Quotas based on VMFamily.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListWorkspaceQuotas" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List workspace quotas by VMFamily": { + "$ref": "./examples/Quota/list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "Compute_List", + "description": "Gets computes in specified workspace.", + "x-ms-examples": { + "Get Computes": { + "$ref": "./examples/Compute/list.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Machine Learning computes and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedComputeResourcesList" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Get", + "description": "Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.", + "x-ms-examples": { + "Get a AKS Compute": { + "$ref": "./examples/Compute/get/AKSCompute.json" + }, + "Get a AML Compute": { + "$ref": "./examples/Compute/get/AmlCompute.json" + }, + "Get an ComputeInstance": { + "$ref": "./examples/Compute/get/ComputeInstance.json" + }, + "Get a Kubernetes Compute": { + "$ref": "./examples/Compute/get/KubernetesCompute.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_CreateOrUpdate", + "description": "Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a AML Compute": { + "$ref": "./examples/Compute/createOrUpdate/BasicAmlCompute.json" + }, + "Create an ComputeInstance Compute with minimal inputs": { + "$ref": "./examples/Compute/createOrUpdate/ComputeInstanceMinimal.json" + }, + "Create an ComputeInstance Compute": { + "$ref": "./examples/Compute/createOrUpdate/ComputeInstance.json" + }, + "Create an ComputeInstance Compute with Schedules": { + "$ref": "./examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json" + }, + "Create an AKS Compute": { + "$ref": "./examples/Compute/createOrUpdate/BasicAKSCompute.json" + }, + "Create a DataFactory Compute": { + "$ref": "./examples/Compute/createOrUpdate/BasicDataFactoryCompute.json" + }, + "Update a AML Compute": { + "$ref": "./examples/Compute/createOrUpdate/AmlCompute.json" + }, + "Update an AKS Compute": { + "$ref": "./examples/Compute/createOrUpdate/AKSCompute.json" + }, + "Attach a Kubernetes Compute": { + "$ref": "./examples/Compute/createOrUpdate/KubernetesCompute.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ComputeDefinitionParameter" + } + ], + "responses": { + "200": { + "description": "Compute creation or update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "201": { + "description": "Compute creation or update initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Update", + "description": "Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a AmlCompute Compute": { + "$ref": "./examples/Compute/patch.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateParameters" + }, + "description": "Additional parameters for cluster update." + } + ], + "responses": { + "200": { + "description": "Compute update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Delete", + "description": "Deletes specified Machine Learning compute.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Compute": { + "$ref": "./examples/Compute/delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UnderlyingResourceActionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "Compute deletion initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } + } + }, + "204": { + "description": "No content; The target compute does not exist." + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes": { + "post": { + "tags": [ + "MachineLearningComputes" + ], + "operationId": "Compute_ListNodes", + "description": "Get the details (e.g IP address, port etc) of all the compute nodes in the compute.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of IP addresses.", + "schema": { + "$ref": "#/definitions/AmlComputeNodesInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "nodes" + }, + "x-ms-examples": { + "Get compute nodes information for a compute": { + "$ref": "./examples/Compute/listNodes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_ListKeys", + "description": "Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).", + "x-ms-examples": { + "List AKS Compute Keys": { + "$ref": "./examples/Compute/listKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeSecrets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/start": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Start", + "description": "Posts a start action to a compute instance", + "x-ms-examples": { + "Start ComputeInstance Compute": { + "$ref": "./examples/Compute/start.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/stop": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Stop", + "description": "Posts a stop action to a compute instance", + "x-ms-examples": { + "Stop ComputeInstance Compute": { + "$ref": "./examples/Compute/stop.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/restart": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Restart", + "description": "Posts a restart action to a compute instance", + "x-ms-examples": { + "Restart ComputeInstance Compute": { + "$ref": "./examples/Compute/restart.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "parameters": { + "WorkspaceNameParameter": { + "name": "workspaceName", + "description": "Name of Azure Machine Learning workspace.", + "in": "path", + "type": "string", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$", + "x-ms-parameter-location": "method" + }, + "ComputeNameParameter": { + "name": "computeName", + "description": "Name of the Azure Machine Learning compute.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "AsyncOperationIdParameter": { + "name": "asyncOperationId", + "description": "Identifier of an asynchronous Azure Machine Learning compute operation.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "description": "The name of the Azure location/region.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "PaginationParameter": { + "in": "query", + "name": "$skip", + "type": "string", + "description": "Continuation token for pagination.", + "required": false, + "x-ms-parameter-location": "method" + }, + "ComputeDefinitionParameter": { + "in": "body", + "name": "parameters", + "description": "Payload with Machine Learning compute definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ComputeResource" + }, + "x-ms-parameter-location": "method" + }, + "ComputeTypeParameter": { + "in": "query", + "name": "compute-type", + "type": "string", + "description": "Type of compute to filter by.", + "required": false, + "x-ms-parameter-location": "method" + }, + "UnderlyingResourceActionParameter": { + "in": "query", + "name": "underlyingResourceAction", + "type": "string", + "description": "Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.", + "required": true, + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "UnderlyingResourceAction", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "UsageName": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "amlWorkspaceLocation": { + "readOnly": true, + "type": "string", + "description": "Region of the AML workspace in the id." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The current usage of the resource." + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "description": "Describes AML Resource Usage." + }, + "ListUsagesResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of AML resource usages." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML resource usage information. Call ListNext() with this to fetch the next page of AML resource usage information." + } + }, + "description": "The List Usages operation response." + }, + "VirtualMachineSize": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Virtual Machine size name", + "description": "The name of the virtual machine size.", + "readOnly": true + }, + "family": { + "type": "string", + "title": "Virtual Machine family name", + "description": "The family name of the virtual machine size.", + "readOnly": true + }, + "vCPUs": { + "type": "integer", + "format": "int32", + "title": "Number of vPUs", + "description": "The number of vCPUs supported by the virtual machine size.", + "readOnly": true + }, + "gpus": { + "type": "integer", + "format": "int32", + "title": "Number of gPUs", + "description": "The number of gPUs supported by the virtual machine size.", + "readOnly": true + }, + "osVhdSizeMB": { + "type": "integer", + "format": "int32", + "title": "OS VHD Disk size", + "description": "The OS VHD disk size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "maxResourceVolumeMB": { + "type": "integer", + "format": "int32", + "title": "Resource volume size", + "description": "The resource volume size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "memoryGB": { + "type": "number", + "format": "double", + "title": "Memory size", + "description": "The amount of memory, in GB, supported by the virtual machine size.", + "readOnly": true + }, + "lowPriorityCapable": { + "type": "boolean", + "title": "Low priority capable", + "description": "Specifies if the virtual machine size supports low priority VMs.", + "readOnly": true + }, + "premiumIO": { + "type": "boolean", + "title": "Premium IO supported", + "description": "Specifies if the virtual machine size supports premium IO.", + "readOnly": true + }, + "estimatedVMPrices": { + "title": "Estimated VM prices", + "description": "The estimated price information for using a VM.", + "$ref": "#/definitions/EstimatedVMPrices" + }, + "supportedComputeTypes": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Supported Compute Types", + "description": "Specifies the compute types supported by the virtual machine size." + } + }, + "description": "Describes the properties of a VM size." + }, + "EstimatedVMPrices": { + "type": "object", + "properties": { + "billingCurrency": { + "type": "string", + "title": "Billing currency", + "description": "Three lettered code specifying the currency of the VM price. Example: USD", + "enum": [ + "USD" + ], + "x-ms-enum": { + "name": "BillingCurrency", + "modelAsString": true + } + }, + "unitOfMeasure": { + "type": "string", + "title": "Unit of time measure", + "description": "The unit of time measurement for the specified VM price. Example: OneHour", + "enum": [ + "OneHour" + ], + "x-ms-enum": { + "name": "UnitOfMeasure", + "modelAsString": true + } + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/EstimatedVMPrice" + }, + "x-ms-identifiers": [], + "title": "List of estimated VM prices.", + "description": "The list of estimated prices for using a VM of a particular OS type, tier, etc." + } + }, + "required": [ + "billingCurrency", + "unitOfMeasure", + "values" + ], + "description": "The estimated price info for using a VM." + }, + "EstimatedVMPrice": { + "type": "object", + "properties": { + "retailPrice": { + "type": "number", + "format": "double", + "title": "Retail price", + "description": "The price charged for using the VM." + }, + "osType": { + "type": "string", + "title": "OS type", + "description": "Operating system type used by the VM.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "VMPriceOSType", + "modelAsString": true + } + }, + "vmTier": { + "type": "string", + "title": "VM tier", + "description": "The type of the VM.", + "enum": [ + "Standard", + "LowPriority", + "Spot" + ], + "x-ms-enum": { + "name": "VMTier", + "modelAsString": true + } + } + }, + "required": [ + "retailPrice", + "osType", + "vmTier" + ], + "description": "The estimated price info for using a VM of a particular OS type, tier, etc." + }, + "VirtualMachineSizeListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of virtual machine sizes supported by AmlCompute." + } + }, + "description": "The List Virtual Machine size operation response." + }, + "QuotaBaseProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "type": "string", + "description": "Specifies the resource type." + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The properties for Quota update or retrieval." + }, + "QuotaUpdateParameters": { + "type": "object", + "properties": { + "value": { + "description": "The list for update quota.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaBaseProperties" + } + }, + "location": { + "description": "Region of workspace quota to be updated.", + "type": "string" + } + }, + "description": "Quota update parameters." + }, + "UpdateWorkspaceQuotasResult": { + "type": "object", + "properties": { + "value": { + "description": "The list of workspace quota update result.", + "items": { + "$ref": "#/definitions/UpdateWorkspaceQuotas" + }, + "readOnly": true, + "type": "array" + }, + "nextLink": { + "description": "The URI to fetch the next page of workspace quota update result. Call ListNext() with this to fetch the next page of Workspace Quota update result.", + "readOnly": true, + "type": "string" + } + }, + "description": "The result of update workspace quota." + }, + "UpdateWorkspaceQuotas": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + }, + "status": { + "type": "string", + "readOnly": false, + "title": "Update Workspace Quota Status.", + "description": "Status of update workspace quota.", + "enum": [ + "Undefined", + "Success", + "Failure", + "InvalidQuotaBelowClusterMinimum", + "InvalidQuotaExceedsSubscriptionLimit", + "InvalidVMFamilyName", + "OperationNotSupportedForSku", + "OperationNotEnabledForRegion" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + } + }, + "description": "The properties for update Quota response." + }, + "ResourceName": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Resource Name." + }, + "ResourceQuota": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "amlWorkspaceLocation": { + "readOnly": true, + "type": "string", + "description": "Region of the AML workspace in the id." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "name": { + "$ref": "#/definitions/ResourceName", + "description": "Name of the resource.", + "readOnly": true + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The quota assigned to a resource." + }, + "ListWorkspaceQuotas": { + "type": "object", + "properties": { + "value": { + "description": "The list of Workspace Quotas by VM Family", + "items": { + "$ref": "#/definitions/ResourceQuota" + }, + "readOnly": true, + "type": "array" + }, + "nextLink": { + "description": "The URI to fetch the next page of workspace quota information by VM Family. Call ListNext() with this to fetch the next page of Workspace Quota information.", + "readOnly": true, + "type": "string" + } + }, + "description": "The List WorkspaceQuotasByVMFamily operation response." + }, + "ResourceId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource" + } + }, + "required": [ + "id" + ], + "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", + "x-ms-azure-resource": true + }, + "PaginatedComputeResourcesList": { + "type": "object", + "description": "Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.", + "properties": { + "value": { + "type": "array", + "description": "An array of Machine Learning compute objects wrapped in ARM resource envelope.", + "items": { + "$ref": "#/definitions/ComputeResource" + } + }, + "nextLink": { + "type": "string", + "description": "A continuation link (absolute URI) to the next page of results in the list." + } + } + }, + "ComputeResource": { + "type": "object", + "description": "Machine Learning compute object wrapped into ARM resource envelope.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + }, + { + "$ref": "#/definitions/ComputeResourceSchema" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace.", + "x-nullable": true + } + } + }, + "ComputeResourceSchema": { + "type": "object", + "properties": { + "properties": { + "description": "Compute properties", + "$ref": "#/definitions/Compute" + } + } + }, + "Compute": { + "type": "object", + "description": "Machine Learning compute object.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + }, + "computeLocation": { + "description": "Location for the underlying compute", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "type": "string", + "description": "The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of the Machine Learning compute.", + "x-nullable": true + }, + "createdOn": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time at which the compute was created." + }, + "modifiedOn": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time at which the compute was last modified." + }, + "resourceId": { + "type": "string", + "description": "ARM resource id of the underlying compute", + "x-nullable": true + }, + "provisioningErrors": { + "type": "array", + "description": "Errors during provisioning", + "items": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + }, + "x-ms-identifiers": [ + "/error/code" + ], + "readOnly": true, + "x-nullable": true + }, + "isAttachedCompute": { + "type": "boolean", + "description": "Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.", + "readOnly": true + }, + "disableLocalAuth": { + "type": "boolean", + "description": "Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "computeType" + ] + }, + "AKS": { + "description": "A Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/AKSSchema" + } + ], + "x-ms-discriminator-value": "AKS" + }, + "AKSSchema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "description": "AKS properties", + "properties": { + "clusterFqdn": { + "description": "Cluster full qualified domain name", + "type": "string", + "x-nullable": true + }, + "systemServices": { + "type": "array", + "description": "System services", + "items": { + "$ref": "#/definitions/SystemService" + }, + "x-ms-identifiers": [ + "publicIpAddress" + ], + "readOnly": true, + "x-nullable": true + }, + "agentCount": { + "description": "Number of agents", + "type": "integer", + "format": "int32", + "minimum": 0, + "x-nullable": true + }, + "agentVmSize": { + "description": "Agent virtual machine size", + "type": "string", + "x-nullable": true + }, + "clusterPurpose": { + "description": "Intended usage of the cluster", + "type": "string", + "default": "FastProd", + "enum": [ + "FastProd", + "DenseProd", + "DevTest" + ], + "x-ms-enum": { + "name": "ClusterPurpose", + "modelAsString": true + } + }, + "sslConfiguration": { + "description": "SSL configuration", + "$ref": "#/definitions/SslConfiguration", + "x-nullable": true + }, + "aksNetworkingConfiguration": { + "description": "AKS networking configuration for vnet", + "$ref": "#/definitions/AksNetworkingConfiguration", + "x-nullable": true + }, + "loadBalancerType": { + "description": "Load Balancer Type", + "type": "string", + "default": "PublicIp", + "enum": [ + "PublicIp", + "InternalLoadBalancer" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + } + }, + "loadBalancerSubnet": { + "description": "Load Balancer Subnet", + "type": "string", + "x-nullable": true + } + } + } + } + }, + "Kubernetes": { + "description": "A Machine Learning compute based on Kubernetes Compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/KubernetesSchema" + } + ], + "x-ms-discriminator-value": "Kubernetes" + }, + "KubernetesSchema": { + "type": "object", + "description": "Kubernetes Compute Schema", + "properties": { + "properties": { + "description": "Properties of Kubernetes", + "$ref": "#/definitions/KubernetesProperties" + } + } + }, + "KubernetesProperties": { + "type": "object", + "description": "Kubernetes properties", + "properties": { + "relayConnectionString": { + "description": "Relay connection string.", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + }, + "serviceBusConnectionString": { + "description": "ServiceBus connection string.", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + }, + "extensionPrincipalId": { + "description": "Extension principal-id.", + "type": "string", + "x-nullable": true + }, + "extensionInstanceReleaseTrain": { + "description": "Extension instance release train.", + "type": "string" + }, + "vcName": { + "description": "VC name.", + "type": "string" + }, + "namespace": { + "description": "Compute namespace", + "type": "string", + "default": "default" + }, + "defaultInstanceType": { + "description": "Default instance type", + "type": "string" + }, + "instanceTypes": { + "description": "Instance Type Schema", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/InstanceTypeSchema" + } + } + } + }, + "AmlComputeProperties": { + "type": "object", + "description": "AML Compute properties", + "properties": { + "osType": { + "description": "Compute OS Type", + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true + } + }, + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "vmPriority": { + "description": "Virtual Machine priority", + "type": "string", + "enum": [ + "Dedicated", + "LowPriority" + ], + "x-ms-enum": { + "name": "VmPriority", + "modelAsString": true + } + }, + "virtualMachineImage": { + "description": "Virtual Machine image for AML Compute - windows only", + "$ref": "#/definitions/VirtualMachineImage", + "x-nullable": true + }, + "isolatedNetwork": { + "description": "Network is isolated or not", + "type": "boolean" + }, + "scaleSettings": { + "description": "Scale settings for AML Compute", + "$ref": "#/definitions/ScaleSettings" + }, + "userAccountCredentials": { + "title": "User account credentials.", + "description": "Credentials for an administrator user account that will be created on each compute node.", + "$ref": "#/definitions/UserAccountCredentials", + "x-nullable": true + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId", + "x-nullable": true + }, + "remoteLoginPortPublicAccess": { + "type": "string", + "default": "NotSpecified", + "title": "Close remote Login Access Port", + "description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled", + "NotSpecified" + ], + "x-ms-enum": { + "name": "remoteLoginPortPublicAccess", + "modelAsString": true + } + }, + "allocationState": { + "type": "string", + "readOnly": true, + "title": "Allocation state.", + "description": "Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.", + "enum": [ + "Steady", + "Resizing" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": true + } + }, + "allocationStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Allocation state transition time.", + "description": "The time at which the compute entered its current allocation state." + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered by various compute nodes during node setup.", + "type": "array", + "x-nullable": true, + "items": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + }, + "x-ms-identifiers": [ + "/error/code" + ] + }, + "currentNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Current node count.", + "description": "The number of compute nodes currently assigned to the compute.", + "x-nullable": true + }, + "targetNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Target node count.", + "description": "The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation.", + "x-nullable": true + }, + "nodeStateCounts": { + "title": "Node state counts.", + "description": "Counts of various node states on the compute.", + "readOnly": true, + "$ref": "#/definitions/NodeStateCounts", + "x-nullable": true + }, + "enableNodePublicIp": { + "type": "boolean", + "default": true, + "title": "Enable node public IP.", + "description": "Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.", + "x-nullable": true + }, + "propertyBag": { + "type": "object", + "description": "A property bag containing additional properties.", + "x-nullable": true + } + } + }, + "AmlCompute": { + "description": "An Azure Machine Learning compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/AmlComputeSchema" + } + ], + "x-ms-discriminator-value": "AmlCompute" + }, + "AmlComputeSchema": { + "type": "object", + "description": "Properties(top level) of AmlCompute", + "properties": { + "properties": { + "description": "Properties of AmlCompute", + "$ref": "#/definitions/AmlComputeProperties" + } + } + }, + "ComputeInstanceProperties": { + "description": "Compute Instance properties", + "type": "object", + "properties": { + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId", + "x-nullable": true + }, + "applicationSharingPolicy": { + "type": "string", + "default": "Shared", + "title": "Sharing policy for applications on this compute instance", + "description": "Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.", + "enum": [ + "Personal", + "Shared" + ], + "x-ms-enum": { + "name": "applicationSharingPolicy", + "modelAsString": true + } + }, + "sshSettings": { + "description": "Specifies policy and settings for SSH access.", + "$ref": "#/definitions/ComputeInstanceSshSettings", + "x-nullable": true + }, + "customServices": { + "type": "array", + "description": "List of Custom Services added to the compute.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/CustomService" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "osImageMetadata": { + "readOnly": true, + "description": "Returns metadata about the operating system image for this compute instance.", + "$ref": "#/definitions/ImageMetadata" + }, + "connectivityEndpoints": { + "readOnly": true, + "description": "Describes all connectivity endpoints available for this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceConnectivityEndpoints" + }, + "applications": { + "type": "array", + "readOnly": true, + "description": "Describes available applications and their endpoints on this ComputeInstance.", + "items": { + "$ref": "#/definitions/ComputeInstanceApplication" + }, + "x-ms-identifiers": [ + "displayName" + ] + }, + "createdBy": { + "readOnly": true, + "description": "Describes information on user who created this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceCreatedBy" + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered on this ComputeInstance.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + }, + "x-ms-identifiers": [ + "/error/code" + ] + }, + "state": { + "description": "The current state of this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceState", + "readOnly": true + }, + "computeInstanceAuthorizationType": { + "type": "string", + "title": "Compute Instance Authorization type.", + "description": "The Compute Instance Authorization type. Available values are personal (default).", + "default": "personal", + "x-nullable": true, + "enum": [ + "personal" + ], + "x-ms-enum": { + "name": "ComputeInstanceAuthorizationType", + "modelAsString": true + } + }, + "personalComputeInstanceSettings": { + "title": "Personal Compute Instance settings.", + "description": "Settings for a personal compute instance.", + "$ref": "#/definitions/PersonalComputeInstanceSettings", + "x-nullable": true + }, + "setupScripts": { + "description": "Details of customized scripts to execute for setting up the cluster.", + "$ref": "#/definitions/SetupScripts", + "x-nullable": true + }, + "lastOperation": { + "description": "The last operation on ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceLastOperation", + "readOnly": true, + "x-nullable": true + }, + "schedules": { + "description": "The list of schedules to be applied on the computes.", + "$ref": "#/definitions/ComputeSchedules", + "x-nullable": true + }, + "enableNodePublicIp": { + "type": "boolean", + "title": "Enable node public IP.", + "description": "Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs." + }, + "containers": { + "type": "array", + "readOnly": true, + "description": "Describes informations of containers on this ComputeInstance.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ComputeInstanceContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "dataDisks": { + "type": "array", + "readOnly": true, + "description": "Describes informations of dataDisks on this ComputeInstance.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ComputeInstanceDataDisk" + }, + "x-ms-identifiers": [] + }, + "dataMounts": { + "type": "array", + "readOnly": true, + "description": "Describes informations of dataMounts on this ComputeInstance.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ComputeInstanceDataMount" + }, + "x-ms-identifiers": [] + }, + "versions": { + "description": "ComputeInstance version.", + "$ref": "#/definitions/ComputeInstanceVersion", + "readOnly": true + } + } + }, + "ComputeInstance": { + "description": "An Azure Machine Learning compute instance.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/ComputeInstanceSchema" + } + ], + "x-ms-discriminator-value": "ComputeInstance" + }, + "ComputeInstanceSchema": { + "type": "object", + "description": "Properties(top level) of ComputeInstance", + "properties": { + "properties": { + "description": "Properties of ComputeInstance", + "$ref": "#/definitions/ComputeInstanceProperties" + } + } + }, + "VirtualMachine": { + "description": "A Machine Learning compute based on Azure Virtual Machines.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/VirtualMachineSchema" + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "VirtualMachineSchema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "virtualMachineSize": { + "description": "Virtual Machine size", + "type": "string" + }, + "sshPort": { + "description": "Port open for ssh connections.", + "type": "integer", + "format": "int32" + }, + "notebookServerPort": { + "description": "Notebook server port open for ssh connections.", + "type": "integer", + "format": "int32" + }, + "address": { + "description": "Public IP address of the virtual machine.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for virtual machine", + "$ref": "#/definitions/VirtualMachineSshCredentials" + }, + "isNotebookInstanceCompute": { + "description": "Indicates whether this compute will be used for running notebooks.", + "type": "boolean" + } + } + } + } + }, + "HDInsightProperties": { + "type": "object", + "description": "HDInsight compute properties", + "properties": { + "sshPort": { + "description": "Port open for ssh connections on the master node of the cluster.", + "type": "integer", + "format": "int32" + }, + "address": { + "description": "Public IP address of the master node of the cluster.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for master node of the cluster", + "$ref": "#/definitions/VirtualMachineSshCredentials", + "x-nullable": true + } + } + }, + "HDInsight": { + "description": "A HDInsight compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/HDInsightSchema" + } + ], + "x-ms-discriminator-value": "HDInsight" + }, + "HDInsightSchema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/HDInsightProperties" + } + } + }, + "DataFactory": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + } + ], + "x-ms-discriminator-value": "DataFactory" + }, + "DatabricksProperties": { + "type": "object", + "description": "Properties of Databricks", + "properties": { + "databricksAccessToken": { + "description": "Databricks access token", + "type": "string" + }, + "workspaceUrl": { + "description": "Workspace Url", + "type": "string" + } + } + }, + "Databricks": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/DatabricksSchema" + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "DatabricksSchema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DatabricksProperties" + } + } + }, + "DataLakeAnalytics": { + "description": "A DataLakeAnalytics compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/DataLakeAnalyticsSchema" + } + ], + "x-ms-discriminator-value": "DataLakeAnalytics" + }, + "DataLakeAnalyticsSchema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "dataLakeStoreAccountName": { + "description": "DataLake Store Account Name", + "type": "string" + } + } + } + } + }, + "SynapseSpark": { + "type": "object", + "description": "A SynapseSpark compute.", + "properties": { + "properties": { + "type": "object", + "properties": { + "autoScaleProperties": { + "description": "Auto scale properties.", + "$ref": "#/definitions/AutoScaleProperties" + }, + "autoPauseProperties": { + "description": "Auto pause properties.", + "$ref": "#/definitions/AutoPauseProperties" + }, + "sparkVersion": { + "description": "Spark version.", + "type": "string" + }, + "nodeCount": { + "description": "The number of compute nodes currently assigned to the compute.", + "type": "integer", + "format": "int32" + }, + "nodeSize": { + "description": "Node size.", + "type": "string" + }, + "nodeSizeFamily": { + "description": "Node size family.", + "type": "string" + }, + "subscriptionId": { + "description": "Azure subscription identifier.", + "type": "string" + }, + "resourceGroup": { + "description": "Name of the resource group in which workspace is located.", + "type": "string" + }, + "workspaceName": { + "description": "Name of Azure Machine Learning workspace.", + "type": "string" + }, + "poolName": { + "description": "Pool name.", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Compute" + } + ], + "x-ms-discriminator-value": "SynapseSpark" + }, + "SystemService": { + "type": "object", + "description": "A system service running on a compute.", + "properties": { + "systemServiceType": { + "description": "The type of this system service.", + "readOnly": true, + "type": "string" + }, + "publicIpAddress": { + "type": "string", + "description": "Public IP address", + "readOnly": true + }, + "version": { + "description": "The version for this type.", + "readOnly": true, + "type": "string" + } + } + }, + "SslConfiguration": { + "type": "object", + "description": "The ssl configuration for scoring", + "properties": { + "status": { + "description": "Enable or disable ssl for scoring", + "type": "string", + "enum": [ + "Disabled", + "Enabled", + "Auto" + ], + "x-ms-enum": { + "name": "SslConfigStatus", + "modelAsString": true + } + }, + "cert": { + "description": "Cert data", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + }, + "key": { + "description": "Key data", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + }, + "cname": { + "description": "CNAME of the cert", + "type": "string", + "x-nullable": true + }, + "leafDomainLabel": { + "description": "Leaf domain label of public endpoint", + "type": "string", + "x-nullable": true + }, + "overwriteExistingDomain": { + "description": "Indicates whether to overwrite existing domain label.", + "type": "boolean" + } + } + }, + "AksNetworkingConfiguration": { + "type": "object", + "description": "Advance configuration for AKS networking", + "properties": { + "subnetId": { + "description": "Virtual network subnet resource ID the compute nodes belong to", + "type": "string" + }, + "serviceCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.", + "type": "string" + }, + "dnsServiceIP": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.", + "type": "string" + }, + "dockerBridgeCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.", + "type": "string" + } + } + }, + "UserAccountCredentials": { + "type": "object", + "properties": { + "adminUserName": { + "type": "string", + "title": "User name.", + "description": "Name of the administrator user account which can be used to SSH to nodes." + }, + "adminUserSshPublicKey": { + "type": "string", + "x-ms-secret": true, + "title": "SSH public key.", + "description": "SSH public key of the administrator user account." + }, + "adminUserPassword": { + "type": "string", + "x-ms-secret": true, + "title": "Password.", + "description": "Password of the administrator user account." + } + }, + "required": [ + "adminUserName" + ], + "description": "Settings for user account that gets created on each on the nodes of a compute." + }, + "ScaleSettings": { + "type": "object", + "description": "scale settings for AML Compute", + "properties": { + "maxNodeCount": { + "description": "Max number of nodes to use", + "type": "integer", + "format": "int32" + }, + "minNodeCount": { + "description": "Min number of nodes to use", + "type": "integer", + "format": "int32", + "default": 0 + }, + "nodeIdleTimeBeforeScaleDown": { + "type": "string", + "format": "duration", + "description": "Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format." + } + }, + "required": [ + "maxNodeCount" + ] + }, + "VirtualMachineImage": { + "type": "object", + "description": "Virtual Machine image for Windows AML Compute", + "properties": { + "id": { + "description": "Virtual Machine image path", + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "NodeStateCounts": { + "type": "object", + "properties": { + "idleNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Idle node count.", + "description": "Number of compute nodes in idle state." + }, + "runningNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Running node count.", + "description": "Number of compute nodes which are running jobs." + }, + "preparingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preparing node count.", + "description": "Number of compute nodes which are being prepared." + }, + "unusableNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Unusable node count.", + "description": "Number of compute nodes which are in unusable state." + }, + "leavingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Leaving node count.", + "description": "Number of compute nodes which are leaving the amlCompute." + }, + "preemptedNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preempted node count.", + "description": "Number of compute nodes which are in preempted state." + } + }, + "description": "Counts of various compute node states on the amlCompute." + }, + "ScaleSettingsInformation": { + "type": "object", + "properties": { + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Scale settings." + } + }, + "description": "Desired scale settings for the amlCompute." + }, + "ClusterUpdateProperties": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of ClusterUpdate", + "$ref": "#/definitions/ScaleSettingsInformation" + } + }, + "description": "The properties of a amlCompute that need to be updated." + }, + "ClusterUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterUpdateProperties", + "description": "The properties of the amlCompute." + } + }, + "description": "AmlCompute update parameters." + }, + "AmlComputeNodesInformation": { + "type": "object", + "description": "Result of AmlCompute Nodes", + "properties": { + "nodes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlComputeNodeInformation" + }, + "x-ms-identifiers": [ + "nodeId" + ], + "description": "The collection of returned AmlCompute nodes details." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + } + }, + "AmlComputeNodeInformation": { + "type": "object", + "description": "Compute node information related to a AmlCompute.", + "properties": { + "nodeId": { + "readOnly": true, + "type": "string", + "title": "Node ID.", + "description": "ID of the compute node." + }, + "privateIpAddress": { + "readOnly": true, + "type": "string", + "title": "Private IP address.", + "description": "Private IP address of the compute node.", + "x-nullable": true + }, + "publicIpAddress": { + "readOnly": true, + "type": "string", + "title": "Public IP address.", + "description": "Public IP address of the compute node.", + "x-nullable": true + }, + "port": { + "readOnly": true, + "type": "number", + "format": "int32", + "title": "Port.", + "description": "SSH port number of the node." + }, + "nodeState": { + "readOnly": true, + "type": "string", + "enum": [ + "idle", + "running", + "preparing", + "unusable", + "leaving", + "preempted" + ], + "description": "State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.", + "x-ms-enum": { + "name": "nodeState", + "modelAsString": true + } + }, + "runId": { + "readOnly": true, + "type": "string", + "title": "Run ID.", + "description": "ID of the Experiment running on the node, if any else null.", + "x-nullable": true + } + } + }, + "VirtualMachineSshCredentials": { + "type": "object", + "description": "Admin credentials for virtual machine", + "properties": { + "username": { + "description": "Username of admin account", + "type": "string" + }, + "password": { + "description": "Password of admin account", + "type": "string" + }, + "publicKeyData": { + "description": "Public key data", + "type": "string", + "x-ms-secret": true + }, + "privateKeyData": { + "description": "Private key data", + "type": "string", + "x-ms-secret": true + } + } + }, + "ComputeSecrets": { + "type": "object", + "description": "Secrets related to a Machine Learning compute. Might differ for every type of compute.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + } + }, + "required": [ + "computeType" + ] + }, + "AksComputeSecretsProperties": { + "type": "object", + "description": "Properties of AksComputeSecrets", + "properties": { + "userKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "adminKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "imagePullSecretName": { + "type": "string", + "description": "Image registry pull secret.", + "x-nullable": true + } + } + }, + "AksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "$ref": "#/definitions/AksComputeSecretsProperties" + } + ], + "x-ms-discriminator-value": "AKS" + }, + "VirtualMachineSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "$ref": "#/definitions/VirtualMachineSecretsSchema" + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "VirtualMachineSecretsSchema": { + "type": "object", + "properties": { + "administratorAccount": { + "description": "Admin credentials for virtual machine.", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + }, + "DatabricksComputeSecretsProperties": { + "type": "object", + "description": "Properties of Databricks Compute Secrets", + "properties": { + "databricksAccessToken": { + "description": "access token for databricks account.", + "type": "string" + } + } + }, + "DatabricksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on Databricks.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "$ref": "#/definitions/DatabricksComputeSecretsProperties" + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "ComputeType": { + "type": "string", + "description": "The type of compute", + "enum": [ + "AKS", + "Kubernetes", + "AmlCompute", + "ComputeInstance", + "DataFactory", + "VirtualMachine", + "HDInsight", + "Databricks", + "DataLakeAnalytics", + "SynapseSpark" + ], + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": true + } + }, + "ImageMetadata": { + "type": "object", + "description": "Returns metadata about the operating system image for this compute instance.", + "properties": { + "currentImageVersion": { + "type": "string", + "description": "Specifies the current operating system image version this compute instance is running on." + }, + "latestImageVersion": { + "type": "string", + "description": "Specifies the latest available operating system image version." + }, + "isLatestOsImageVersion": { + "type": "boolean", + "description": "Specifies whether this compute instance is running on the latest operating system image." + } + } + }, + "CustomService": { + "type": "object", + "description": "Specifies the custom service configuration", + "properties": { + "name": { + "type": "string", + "description": "Name of the Custom Service" + }, + "image": { + "$ref": "#/definitions/Image", + "description": "Describes the Image Specifications" + }, + "environmentVariables": { + "type": "object", + "description": "Environment Variable for the container", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + "docker": { + "description": "Describes the docker settings for the image", + "$ref": "#/definitions/Docker", + "x-nullable": true + }, + "endpoints": { + "type": "array", + "description": "Configuring the endpoints for the container", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "volumes": { + "type": "array", + "description": "Configuring the volumes for the container", + "items": { + "$ref": "#/definitions/VolumeDefinition" + }, + "x-ms-identifiers": [ + "source", + "target" + ] + } + }, + "additionalProperties": true + }, + "Image": { + "type": "object", + "description": "Describes the Image Specifications", + "properties": { + "type": { + "default": "docker", + "enum": [ + "docker", + "azureml" + ], + "type": "string", + "title": "Type of the image", + "description": "Type of the image. Possible values are: docker - For docker images. azureml - For AzureML images", + "x-ms-enum": { + "name": "ImageType", + "modelAsString": true + } + }, + "reference": { + "type": "string", + "description": "Image reference" + } + }, + "additionalProperties": true + }, + "EnvironmentVariable": { + "type": "object", + "description": "Environment Variables for the container", + "properties": { + "type": { + "enum": [ + "local" + ], + "default": "local", + "title": "Type of Environment Variable", + "description": "Type of the Environment Variable. Possible values are: local - For local variable", + "type": "string", + "x-ms-enum": { + "name": "EnvironmentVariableType", + "modelAsString": true + } + }, + "value": { + "type": "string", + "description": "Value of the Environment variable" + } + }, + "additionalProperties": true + }, + "Docker": { + "type": "object", + "description": "Docker container configuration", + "properties": { + "privileged": { + "type": "boolean", + "description": "Indicate whether container shall run in privileged or non-privileged mode.", + "x-nullable": true + } + }, + "additionalProperties": true + }, + "Endpoint": { + "type": "object", + "description": "Describes the endpoint configuration for the container", + "properties": { + "protocol": { + "enum": [ + "tcp", + "udp", + "http" + ], + "default": "tcp", + "title": "Endpoint Communication Protocol", + "description": "Protocol over which communication will happen over this endpoint", + "x-ms-enum": { + "name": "protocol", + "modelAsString": true + }, + "type": "string" + }, + "name": { + "type": "string", + "description": "Name of the Endpoint" + }, + "target": { + "format": "int32", + "type": "integer", + "description": "Application port inside the container." + }, + "published": { + "format": "int32", + "type": "integer", + "description": "Port over which the application is exposed from container.", + "x-nullable": true + }, + "hostIp": { + "description": "Host IP over which the application is exposed from the container", + "type": "string", + "x-nullable": true + } + } + }, + "VolumeDefinition": { + "type": "object", + "description": "Describes the volume configuration for the container", + "properties": { + "type": { + "enum": [ + "bind", + "volume", + "tmpfs", + "npipe" + ], + "default": "bind", + "title": "Type of Volume Definition", + "description": "Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe", + "x-ms-enum": { + "name": "VolumeDefinitionType", + "modelAsString": true + }, + "type": "string" + }, + "readOnly": { + "type": "boolean", + "description": "Indicate whether to mount volume as readOnly. Default value for this is false.", + "x-nullable": true + }, + "source": { + "type": "string", + "description": "Source of the mount. For bind mounts this is the host path." + }, + "target": { + "type": "string", + "description": "Target of the mount. For bind mounts this is the path in the container." + }, + "consistency": { + "type": "string", + "description": "Consistency of the volume" + }, + "bind": { + "$ref": "#/definitions/BindOptions", + "description": "Bind Options of the mount" + }, + "volume": { + "$ref": "#/definitions/VolumeOptions", + "description": "Volume Options of the mount" + }, + "tmpfs": { + "$ref": "#/definitions/TmpfsOptions", + "description": "tmpfs option of the mount" + } + } + }, + "VolumeOptions": { + "type": "object", + "description": "Describes the volume options for the container", + "properties": { + "nocopy": { + "type": "boolean", + "description": "Indicate whether volume is nocopy", + "x-nullable": true + } + } + }, + "BindOptions": { + "type": "object", + "description": "Describes the bind options for the container", + "properties": { + "propagation": { + "type": "string", + "description": "Type of Bind Option", + "x-nullable": true + }, + "createHostPath": { + "type": "boolean", + "description": "Indicate whether to create host path.", + "x-nullable": true + }, + "selinux": { + "type": "string", + "description": "Mention the selinux options.", + "x-nullable": true + } + } + }, + "TmpfsOptions": { + "description": "Describes the tmpfs options for the container", + "type": "object", + "properties": { + "size": { + "format": "int32", + "type": "integer", + "description": "Mention the Tmpfs size" + } + } + }, + "ComputeInstanceSshSettings": { + "type": "object", + "description": "Specifies policy and settings for SSH access.", + "properties": { + "sshPublicAccess": { + "type": "string", + "default": "Disabled", + "title": "Access policy for SSH", + "description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "sshPublicAccess", + "modelAsString": true + } + }, + "adminUserName": { + "type": "string", + "readOnly": true, + "description": "Describes the admin user name." + }, + "sshPort": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Describes the port for connecting through SSH." + }, + "adminPublicKey": { + "type": "string", + "description": "Specifies the SSH rsa public key file as a string. Use \"ssh-keygen -t rsa -b 2048\" to generate your SSH key pairs." + } + } + }, + "ComputeInstanceState": { + "type": "string", + "description": "Current state of an ComputeInstance.", + "enum": [ + "Creating", + "CreateFailed", + "Deleting", + "Running", + "Restarting", + "JobRunning", + "SettingUp", + "SetupFailed", + "Starting", + "Stopped", + "Stopping", + "UserSettingUp", + "UserSetupFailed", + "Unknown", + "Unusable" + ], + "x-ms-enum": { + "name": "ComputeInstanceState", + "modelAsString": true + } + }, + "ComputeInstanceLastOperation": { + "type": "object", + "description": "The last operation on ComputeInstance.", + "properties": { + "operationName": { + "type": "string", + "description": "Name of the last operation.", + "enum": [ + "Create", + "Start", + "Stop", + "Restart", + "Reimage", + "Delete" + ], + "x-ms-enum": { + "name": "OperationName", + "modelAsString": true + } + }, + "operationTime": { + "type": "string", + "format": "date-time", + "description": "Time of the last operation." + }, + "operationStatus": { + "type": "string", + "description": "Operation status.", + "enum": [ + "InProgress", + "Succeeded", + "CreateFailed", + "StartFailed", + "StopFailed", + "RestartFailed", + "ReimageFailed", + "DeleteFailed" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": true + } + }, + "operationTrigger": { + "type": "string", + "description": "Trigger of operation.", + "enum": [ + "User", + "Schedule", + "IdleShutdown" + ], + "x-ms-enum": { + "name": "operationTrigger", + "modelAsString": true + } + } + } + }, + "ComputeInstanceVersion": { + "type": "object", + "description": "Version of computeInstance.", + "properties": { + "runtime": { + "type": "string", + "description": "Runtime of compute instance.", + "x-nullable": true + } + } + }, + "ComputeSchedules": { + "type": "object", + "description": "The list of schedules to be applied on the computes", + "properties": { + "computeStartStop": { + "type": "array", + "items": { + "$ref": "#/definitions/ComputeStartStopSchedule" + }, + "description": "The list of compute start stop schedules to be applied." + } + } + }, + "ComputeStartStopSchedule": { + "type": "object", + "description": "Compute start stop schedule properties", + "properties": { + "id": { + "description": "A system assigned id for the schedule.", + "type": "string", + "x-nullable": true, + "readOnly": true + }, + "provisioningStatus": { + "description": "The current deployment state of schedule.", + "type": "string", + "enum": [ + "Completed", + "Provisioning", + "Failed" + ], + "x-ms-enum": { + "name": "provisioningStatus", + "modelAsString": true, + "values": [ + { + "value": "Completed" + }, + { + "value": "Provisioning" + }, + { + "value": "Failed" + } + ] + }, + "readOnly": true + }, + "status": { + "$ref": "#/definitions/ScheduleStatus" + }, + "action": { + "description": "[Required] The compute power action.", + "$ref": "#/definitions/ComputePowerAction" + }, + "triggerType": { + "description": "[Required] The schedule trigger type.", + "$ref": "#/definitions/ComputeTriggerType" + }, + "recurrence": { + "description": "Required if triggerType is Recurrence.", + "$ref": "#/definitions/Recurrence" + }, + "cron": { + "description": "Required if triggerType is Cron.", + "$ref": "#/definitions/Cron" + }, + "schedule": { + "description": "[Deprecated] Not used any more.", + "$ref": "#/definitions/ScheduleBase" + } + } + }, + "ComputeTriggerType": { + "enum": [ + "Recurrence", + "Cron" + ], + "description": "Is the trigger type recurrence or cron.", + "type": "string", + "x-ms-enum": { + "name": "ComputeTriggerType", + "modelAsString": true, + "values": [ + { + "value": "Recurrence" + }, + { + "value": "Cron" + } + ] + }, + "additionalProperties": false + }, + "ScheduleBase": { + "type": "object", + "properties": { + "id": { + "description": "A system assigned id for the schedule.", + "type": "string", + "x-nullable": true + }, + "provisioningStatus": { + "$ref": "#/definitions/ScheduleProvisioningState" + }, + "status": { + "$ref": "#/definitions/ScheduleStatus" + } + }, + "additionalProperties": false + }, + "ScheduleProvisioningState": { + "enum": [ + "Completed", + "Provisioning", + "Failed" + ], + "description": "The current deployment state of schedule.", + "type": "string", + "x-ms-enum": { + "name": "ScheduleProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Completed" + }, + { + "value": "Provisioning" + }, + { + "value": "Failed" + } + ] + }, + "additionalProperties": false + }, + "ScheduleStatus": { + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Is the schedule enabled or disabled?", + "type": "string", + "x-ms-enum": { + "name": "ScheduleStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "ComputePowerAction": { + "type": "string", + "description": "The compute power action.", + "enum": [ + "Start", + "Stop" + ], + "x-ms-enum": { + "name": "ComputePowerAction", + "modelAsString": true + } + }, + "Recurrence": { + "type": "object", + "description": "The workflow trigger recurrence for ComputeStartStop schedule type.", + "properties": { + "frequency": { + "description": "[Required] The frequency to trigger schedule.", + "$ref": "#/definitions/ComputeRecurrenceFrequency" + }, + "interval": { + "description": "[Required] Specifies schedule interval in conjunction with frequency", + "type": "integer", + "format": "int32" + }, + "startTime": { + "description": "The start time in yyyy-MM-ddTHH:mm:ss format.", + "type": "string", + "x-nullable": true + }, + "timeZone": { + "description": "Specifies time zone in which the schedule runs.\r\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11", + "default": "UTC", + "type": "string" + }, + "schedule": { + "description": "[Required] The recurrence schedule.", + "$ref": "#/definitions/ComputeRecurrenceSchedule" + } + } + }, + "ComputeRecurrenceFrequency": { + "description": "Enum to describe the frequency of a compute recurrence schedule", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "type": "string", + "x-ms-enum": { + "name": "ComputeRecurrenceFrequency", + "modelAsString": true, + "values": [ + { + "value": "Minute", + "description": "Minute frequency" + }, + { + "value": "Hour", + "description": "Hour frequency" + }, + { + "value": "Day", + "description": "Day frequency" + }, + { + "value": "Week", + "description": "Week frequency" + }, + { + "value": "Month", + "description": "Month frequency" + } + ] + }, + "additionalProperties": false + }, + "ComputeRecurrenceSchedule": { + "required": [ + "hours", + "minutes" + ], + "type": "object", + "properties": { + "hours": { + "description": "[Required] List of hours for the schedule.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "minutes": { + "description": "[Required] List of minutes for the schedule.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "monthDays": { + "description": "List of month days for the schedule", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true + }, + "weekDays": { + "description": "List of days for the schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/ComputeWeekDay" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ComputeWeekDay": { + "description": "Enum of weekday", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "ComputeWeekDay", + "modelAsString": true, + "values": [ + { + "value": "Monday", + "description": "Monday weekday" + }, + { + "value": "Tuesday", + "description": "Tuesday weekday" + }, + { + "value": "Wednesday", + "description": "Wednesday weekday" + }, + { + "value": "Thursday", + "description": "Thursday weekday" + }, + { + "value": "Friday", + "description": "Friday weekday" + }, + { + "value": "Saturday", + "description": "Saturday weekday" + }, + { + "value": "Sunday", + "description": "Sunday weekday" + } + ] + }, + "additionalProperties": false + }, + "Cron": { + "type": "object", + "description": "The workflow trigger cron for ComputeStartStop schedule type.", + "properties": { + "startTime": { + "description": "The start time in yyyy-MM-ddTHH:mm:ss format.", + "type": "string", + "x-nullable": true + }, + "timeZone": { + "description": "Specifies time zone in which the schedule runs.\r\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11", + "type": "string", + "default": "UTC" + }, + "expression": { + "description": "[Required] Specifies cron expression of schedule.\r\nThe expression should follow NCronTab format.", + "type": "string" + } + } + }, + "IdleShutdownSetting": { + "type": "object", + "description": "Stops compute instance after user defined period of inactivity.", + "properties": { + "idleTimeBeforeShutdown": { + "type": "string", + "description": "Time is defined in ISO8601 format. Minimum is 15 min, maximum is 3 days." + } + } + }, + "ComputeInstanceDataMount": { + "type": "object", + "description": "Defines an Aml Instance DataMount.", + "properties": { + "source": { + "type": "string", + "description": "Source of the ComputeInstance data mount." + }, + "sourceType": { + "description": "Data source type.", + "type": "string", + "enum": [ + "Dataset", + "Datastore", + "URI" + ], + "x-ms-enum": { + "name": "sourceType", + "modelAsString": true + } + }, + "mountName": { + "type": "string", + "description": "name of the ComputeInstance data mount." + }, + "mountAction": { + "description": "Mount Action.", + "type": "string", + "enum": [ + "Mount", + "Unmount" + ], + "x-ms-enum": { + "name": "mountAction", + "modelAsString": true + } + }, + "createdBy": { + "type": "string", + "description": "who this data mount created by." + }, + "mountPath": { + "type": "string", + "description": "Path of this data mount." + }, + "mountState": { + "description": "Mount state.", + "type": "string", + "enum": [ + "MountRequested", + "Mounted", + "MountFailed", + "UnmountRequested", + "UnmountFailed", + "Unmounted" + ], + "x-ms-enum": { + "name": "mountState", + "modelAsString": true + } + }, + "mountedOn": { + "type": "string", + "format": "date-time", + "title": "Mounted time.", + "description": "The time when the disk mounted." + }, + "error": { + "type": "string", + "description": "Error of this data mount." + } + } + }, + "ComputeInstanceDataDisk": { + "type": "object", + "description": "Defines an Aml Instance DataDisk.", + "properties": { + "caching": { + "description": "Caching type of Data Disk.", + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "caching", + "modelAsString": true + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in gigabytes.", + "description": "The initial disk size in gigabytes." + }, + "lun": { + "type": "integer", + "format": "int32", + "title": "The logical unit number.", + "description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun." + }, + "storageAccountType": { + "description": "type of this storage account.", + "type": "string", + "default": "Standard_LRS", + "enum": [ + "Standard_LRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "storageAccountType", + "modelAsString": true + } + } + } + }, + "ComputeInstanceContainer": { + "type": "object", + "description": "Defines an Aml Instance container.", + "properties": { + "name": { + "type": "string", + "description": "Name of the ComputeInstance container." + }, + "autosave": { + "description": "Auto save settings.", + "type": "string", + "enum": [ + "None", + "Local", + "Remote" + ], + "x-ms-enum": { + "name": "autosave", + "modelAsString": true + } + }, + "gpu": { + "type": "string", + "description": "Information of GPU." + }, + "network": { + "description": "network of this container.", + "type": "string", + "enum": [ + "Bridge", + "Host" + ], + "x-ms-enum": { + "name": "network", + "modelAsString": true + } + }, + "environment": { + "description": "Environment information of this container.", + "$ref": "#/definitions/ComputeInstanceEnvironmentInfo" + }, + "services": { + "type": "array", + "readOnly": true, + "description": "services of this containers.", + "items": { + "type": "object" + }, + "x-ms-identifiers": [] + } + } + }, + "ComputeInstanceEnvironmentInfo": { + "type": "object", + "description": "Environment information", + "properties": { + "name": { + "description": "name of environment.", + "type": "string" + }, + "version": { + "description": "version of environment.", + "type": "string" + } + } + }, + "ComputeInstanceApplication": { + "type": "object", + "description": "Defines an Aml Instance application and its connectivity endpoint URI.", + "properties": { + "displayName": { + "type": "string", + "description": "Name of the ComputeInstance application." + }, + "endpointUri": { + "type": "string", + "description": "Application' endpoint URI." + } + } + }, + "ComputeInstanceConnectivityEndpoints": { + "type": "object", + "readOnly": true, + "description": "Defines all connectivity endpoints and properties for an ComputeInstance.", + "properties": { + "publicIpAddress": { + "type": "string", + "readOnly": true, + "description": "Public IP Address of this ComputeInstance.", + "x-nullable": true + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed).", + "x-nullable": true + } + } + }, + "ComputeInstanceCreatedBy": { + "type": "object", + "readOnly": true, + "description": "Describes information on user who created this ComputeInstance.", + "properties": { + "userName": { + "type": "string", + "readOnly": true, + "description": "Name of the user.", + "x-nullable": true + }, + "userOrgId": { + "type": "string", + "readOnly": true, + "description": "Uniquely identifies user' Azure Active Directory organization." + }, + "userId": { + "type": "string", + "readOnly": true, + "description": "Uniquely identifies the user within his/her organization.", + "x-nullable": true + } + } + }, + "PersonalComputeInstanceSettings": { + "type": "object", + "properties": { + "assignedUser": { + "$ref": "#/definitions/AssignedUser", + "title": "Assigned User.", + "description": "A user explicitly assigned to a personal compute instance." + } + }, + "description": "Settings for a personal compute instance." + }, + "AssignedUser": { + "type": "object", + "description": "A user that can be assigned to a compute instance.", + "properties": { + "objectId": { + "type": "string", + "description": "User’s AAD Object Id." + }, + "tenantId": { + "type": "string", + "description": "User’s AAD Tenant Id." + } + }, + "required": [ + "objectId", + "tenantId" + ] + }, + "SetupScripts": { + "type": "object", + "description": "Details of customized scripts to execute for setting up the cluster.", + "properties": { + "scripts": { + "description": "Customized setup scripts", + "$ref": "#/definitions/ScriptsToExecute" + } + } + }, + "ScriptsToExecute": { + "type": "object", + "description": "Customized setup scripts", + "properties": { + "startupScript": { + "description": "Script that's run every time the machine starts.", + "$ref": "#/definitions/ScriptReference" + }, + "creationScript": { + "description": "Script that's run only once during provision of the compute.", + "$ref": "#/definitions/ScriptReference" + } + } + }, + "ScriptReference": { + "type": "object", + "description": "Script reference", + "properties": { + "scriptSource": { + "description": "The storage source of the script: workspace.", + "type": "string" + }, + "scriptData": { + "description": "The location of scripts in the mounted volume.", + "type": "string" + }, + "scriptArguments": { + "description": "Optional command line arguments passed to the script to run.", + "type": "string" + }, + "timeout": { + "description": "Optional time period passed to timeout command.", + "type": "string" + } + } + }, + "AutoScaleProperties": { + "type": "object", + "description": "Auto scale properties", + "properties": { + "minNodeCount": { + "format": "int32", + "type": "integer" + }, + "enabled": { + "type": "boolean" + }, + "maxNodeCount": { + "format": "int32", + "type": "integer" + } + } + }, + "AutoPauseProperties": { + "type": "object", + "description": "Auto pause properties", + "properties": { + "delayInMinutes": { + "format": "int32", + "type": "integer" + }, + "enabled": { + "type": "boolean" + } + } + }, + "InstanceTypeSchema": { + "type": "object", + "description": "Instance type schema.", + "properties": { + "nodeSelector": { + "type": "object", + "description": "Node Selector", + "x-nullable": true, + "additionalProperties": { + "type": "string", + "x-nullable": true + } + }, + "resources": { + "type": "object", + "description": "Resource requests/limits for this instance type", + "properties": { + "requests": { + "description": "Resource requests for this instance type", + "$ref": "#/definitions/InstanceResourceSchema" + }, + "limits": { + "description": "Resource limits for this instance type", + "$ref": "#/definitions/InstanceResourceSchema" + } + } + } + } + }, + "InstanceResourceSchema": { + "type": "object", + "description": "Resource requests/limits for this instance type", + "additionalProperties": { + "type": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/mfe.json new file mode 100644 index 000000000000..6df0f3105fab --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/mfe.json @@ -0,0 +1,24110 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes": { + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "List containers.", + "operationId": "RegistryCodeContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Code Container.": { + "$ref": "./examples/Registry/CodeContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}": { + "delete": { + "tags": [ + "CodeContainer" + ], + "summary": "Delete Code container.", + "operationId": "RegistryCodeContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Code Container.": { + "$ref": "./examples/Registry/CodeContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "Get Code container.", + "operationId": "RegistryCodeContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Code Container.": { + "$ref": "./examples/Registry/CodeContainer/get.json" + } + } + }, + "put": { + "tags": [ + "CodeContainer" + ], + "summary": "Create or update Code container.", + "operationId": "RegistryCodeContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Code Container.": { + "$ref": "./examples/Registry/CodeContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions": { + "get": { + "tags": [ + "CodeVersion" + ], + "summary": "List versions.", + "operationId": "RegistryCodeVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}": { + "delete": { + "tags": [ + "CodeVersion" + ], + "summary": "Delete version.", + "operationId": "RegistryCodeVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "CodeVersion" + ], + "summary": "Get version.", + "operationId": "RegistryCodeVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/get.json" + } + } + }, + "put": { + "tags": [ + "CodeVersion" + ], + "summary": "Create or update version.", + "operationId": "RegistryCodeVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}/startPendingUpload": { + "post": { + "tags": [ + "CodeVersion" + ], + "summary": "Generate a storage location and credential for the client to upload a code asset to.", + "operationId": "RegistryCodeVersions_CreateOrGetStartPendingUpload", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Pending upload name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/createOrGetStartPendingUpload.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components": { + "get": { + "tags": [ + "ComponentContainer" + ], + "summary": "List containers.", + "operationId": "RegistryComponentContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Component Container.": { + "$ref": "./examples/Registry/ComponentContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}": { + "delete": { + "tags": [ + "ComponentContainer" + ], + "summary": "Delete container.", + "operationId": "RegistryComponentContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Component Container.": { + "$ref": "./examples/Registry/ComponentContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ComponentContainer" + ], + "summary": "Get container.", + "operationId": "RegistryComponentContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Component Container.": { + "$ref": "./examples/Registry/ComponentContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ComponentContainer" + ], + "summary": "Create or update container.", + "operationId": "RegistryComponentContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Component Container.": { + "$ref": "./examples/Registry/ComponentContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions": { + "get": { + "tags": [ + "ComponentVersion" + ], + "summary": "List versions.", + "operationId": "RegistryComponentVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Component Version.": { + "$ref": "./examples/Registry/ComponentVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions/{version}": { + "delete": { + "tags": [ + "ComponentVersion" + ], + "summary": "Delete version.", + "operationId": "RegistryComponentVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Component Version.": { + "$ref": "./examples/Registry/ComponentVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ComponentVersion" + ], + "summary": "Get version.", + "operationId": "RegistryComponentVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Component Version.": { + "$ref": "./examples/Registry/ComponentVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ComponentVersion" + ], + "summary": "Create or update version.", + "operationId": "RegistryComponentVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Component Version.": { + "$ref": "./examples/Registry/ComponentVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data": { + "get": { + "tags": [ + "DataContainerRegistry" + ], + "summary": "List Data containers.", + "operationId": "RegistryDataContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegistryList Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/registryList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}": { + "delete": { + "tags": [ + "DataContainerRegistry" + ], + "summary": "Delete container.", + "operationId": "RegistryDataContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "DataContainerRegistry" + ], + "summary": "Get container.", + "operationId": "RegistryDataContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/get.json" + } + } + }, + "put": { + "tags": [ + "DataContainerRegistry" + ], + "summary": "Create or update container.", + "operationId": "RegistryDataContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions": { + "get": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "List data versions in the data container", + "operationId": "RegistryDataVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Data container's name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegistryList Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/registryList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}": { + "delete": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "Delete version.", + "operationId": "RegistryDataVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "Get version.", + "operationId": "RegistryDataVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/get.json" + } + } + }, + "put": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "Create or update version.", + "operationId": "RegistryDataVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}/startPendingUpload": { + "post": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "Generate a storage location and credential for the client to upload a data asset to.", + "operationId": "RegistryDataVersions_CreateOrGetStartPendingUpload", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Data asset name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/datareferences/{name}/versions/{version}": { + "post": { + "tags": [ + "DataReference" + ], + "summary": "Get blob reference SAS Uri.", + "operationId": "RegistryDataReferences_GetBlobReferenceSAS", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Data reference name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Asset id and blob uri.", + "required": true, + "schema": { + "$ref": "#/definitions/GetBlobReferenceSASRequestDto" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/GetBlobReferenceSASResponseDto" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetBlobReferenceSAS Data Reference.": { + "$ref": "./examples/DataReference/getBlobReferenceSAS.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments": { + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "List environment containers.", + "operationId": "RegistryEnvironmentContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}": { + "delete": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Delete container.", + "operationId": "RegistryEnvironmentContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Get container.", + "operationId": "RegistryEnvironmentContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/get.json" + } + } + }, + "put": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Create or update container.", + "operationId": "RegistryEnvironmentContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions": { + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "List versions.", + "operationId": "RegistryEnvironmentVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}": { + "delete": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Delete version.", + "operationId": "RegistryEnvironmentVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Get version.", + "operationId": "RegistryEnvironmentVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/get.json" + } + } + }, + "put": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Create or update version.", + "operationId": "RegistryEnvironmentVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models": { + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "List model containers.", + "operationId": "RegistryModelContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}": { + "delete": { + "tags": [ + "ModelContainer" + ], + "summary": "Delete container.", + "operationId": "RegistryModelContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "Get container.", + "operationId": "RegistryModelContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ModelContainer" + ], + "summary": "Create or update model container.", + "operationId": "RegistryModelContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions": { + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "List versions.", + "operationId": "RegistryModelVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "version", + "description": "Version identifier.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Model description.", + "type": "string" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}": { + "delete": { + "tags": [ + "ModelVersion" + ], + "summary": "Delete version.", + "operationId": "RegistryModelVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "Get version.", + "operationId": "RegistryModelVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ModelVersion" + ], + "summary": "Create or update version.", + "operationId": "RegistryModelVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}/startPendingUpload": { + "post": { + "tags": [ + "ModelVersion" + ], + "summary": "Generate a storage location and credential for the client to upload a model asset to.", + "operationId": "RegistryModelVersions_CreateOrGetStartPendingUpload", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Model name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/createOrGetStartPendingUpload.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": { + "get": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Lists Batch inference endpoint in the workspace.", + "operationId": "BatchEndpoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": { + "delete": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Delete Batch Inference Endpoint (asynchronous).", + "operationId": "BatchEndpoints_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Gets a batch inference endpoint by name.", + "operationId": "BatchEndpoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Name for the Batch Endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/get.json" + } + } + }, + "patch": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Update a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Name for the Batch inference endpoint.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Mutable batch inference endpoint definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Creates a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Name for the Batch inference endpoint.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Batch inference endpoint definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": { + "get": { + "tags": [ + "BatchDeployment" + ], + "summary": "Lists Batch inference deployments in the workspace.", + "operationId": "BatchDeployments_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top of list.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": { + "delete": { + "tags": [ + "BatchDeployment" + ], + "summary": "Delete Batch Inference deployment (asynchronous).", + "operationId": "BatchDeployments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference deployment identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "BatchDeployment" + ], + "summary": "Gets a batch inference deployment by id.", + "operationId": "BatchDeployments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch deployments.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/get.json" + } + } + }, + "patch": { + "tags": [ + "BatchDeployment" + ], + "summary": "Update a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Batch inference deployment definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "BatchDeployment" + ], + "summary": "Creates/updates a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Batch inference deployment definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": { + "post": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Lists batch Inference Endpoint keys.", + "operationId": "BatchEndpoints_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListKeys Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": { + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "List containers.", + "operationId": "CodeContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": { + "delete": { + "tags": [ + "CodeContainer" + ], + "summary": "Delete container.", + "operationId": "CodeContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "Get container.", + "operationId": "CodeContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/get.json" + } + } + }, + "put": { + "tags": [ + "CodeContainer" + ], + "summary": "Create or update container.", + "operationId": "CodeContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": { + "get": { + "tags": [ + "CodeVersion" + ], + "summary": "List versions.", + "operationId": "CodeVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "hash", + "description": "If specified, return CodeVersion assets with specified content hash value, regardless of name", + "type": "string" + }, + { + "in": "query", + "name": "hashVersion", + "description": "Hash algorithm version when listing by hash", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": { + "delete": { + "tags": [ + "CodeVersion" + ], + "summary": "Delete version.", + "operationId": "CodeVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "CodeVersion" + ], + "summary": "Get version.", + "operationId": "CodeVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/get.json" + } + } + }, + "put": { + "tags": [ + "CodeVersion" + ], + "summary": "Create or update version.", + "operationId": "CodeVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/publish": { + "post": { + "tags": [ + "CodeVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "CodeVersions_Publish", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Publish Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/startPendingUpload": { + "post": { + "tags": [ + "CodeVersion" + ], + "summary": "Generate a storage location and credential for the client to upload a code asset to.", + "operationId": "CodeVersions_CreateOrGetStartPendingUpload", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components": { + "get": { + "tags": [ + "ComponentContainer" + ], + "summary": "List component containers.", + "operationId": "ComponentContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}": { + "delete": { + "tags": [ + "ComponentContainer" + ], + "summary": "Delete container.", + "operationId": "ComponentContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "ComponentContainer" + ], + "summary": "Get container.", + "operationId": "ComponentContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ComponentContainer" + ], + "summary": "Create or update container.", + "operationId": "ComponentContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions": { + "get": { + "tags": [ + "ComponentVersion" + ], + "summary": "List component versions.", + "operationId": "ComponentVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Component name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}": { + "delete": { + "tags": [ + "ComponentVersion" + ], + "summary": "Delete version.", + "operationId": "ComponentVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "ComponentVersion" + ], + "summary": "Get version.", + "operationId": "ComponentVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ComponentVersion" + ], + "summary": "Create or update version.", + "operationId": "ComponentVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}/publish": { + "post": { + "tags": [ + "ComponentVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "ComponentVersions_Publish", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Publish Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": { + "get": { + "tags": [ + "DataContainer" + ], + "summary": "List data containers.", + "operationId": "DataContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": { + "delete": { + "tags": [ + "DataContainer" + ], + "summary": "Delete container.", + "operationId": "DataContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "DataContainer" + ], + "summary": "Get container.", + "operationId": "DataContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/get.json" + } + } + }, + "put": { + "tags": [ + "DataContainer" + ], + "summary": "Create or update container.", + "operationId": "DataContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": { + "get": { + "tags": [ + "DataVersion" + ], + "summary": "List data versions in the data container", + "operationId": "DataVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Data container's name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": { + "delete": { + "tags": [ + "DataVersion" + ], + "summary": "Delete version.", + "operationId": "DataVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/delete.json" + } + } + }, + "get": { + "tags": [ + "DataVersion" + ], + "summary": "Get version.", + "operationId": "DataVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/get.json" + } + } + }, + "put": { + "tags": [ + "DataVersion" + ], + "summary": "Create or update version.", + "operationId": "DataVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}/publish": { + "post": { + "tags": [ + "DataVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "DataVersions_Publish", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Publish Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { + "get": { + "tags": [ + "Datastore" + ], + "summary": "List datastores.", + "operationId": "Datastores_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "count", + "description": "Maximum number of results to return.", + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "in": "query", + "name": "isDefault", + "description": "Filter down to the workspace default datastore.", + "type": "boolean" + }, + { + "in": "query", + "name": "names", + "description": "Names of datastores to return.", + "type": "array", + "items": { + "type": "string" + } + }, + { + "in": "query", + "name": "searchText", + "description": "Text to search for in the datastore names.", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "Order by property (createdtime | modifiedtime | name).", + "type": "string" + }, + { + "in": "query", + "name": "orderByAsc", + "description": "Order by property in ascending order.", + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatastoreResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List datastores.": { + "$ref": "./examples/Datastore/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": { + "delete": { + "tags": [ + "Datastore" + ], + "summary": "Delete datastore.", + "operationId": "Datastores_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Datastore name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete datastore.": { + "$ref": "./examples/Datastore/delete.json" + } + } + }, + "get": { + "tags": [ + "Datastore" + ], + "summary": "Get datastore.", + "operationId": "Datastores_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Datastore name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get datastore.": { + "$ref": "./examples/Datastore/get.json" + } + } + }, + "put": { + "tags": [ + "Datastore" + ], + "summary": "Create or update datastore.", + "operationId": "Datastores_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Datastore name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "skipValidation", + "description": "Flag to skip validation.", + "type": "boolean", + "default": false + }, + { + "in": "body", + "name": "body", + "description": "Datastore entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate datastore (AzureBlob w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen1 w/ ServicePrincipal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen2 w/ Service Principal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure File store w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureFileWAccountKey/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": { + "post": { + "tags": [ + "Datastore" + ], + "summary": "Get datastore secrets.", + "operationId": "Datastores_ListSecrets", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Datastore name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "description": "Base definition for datastore secrets.", + "$ref": "#/definitions/DatastoreSecrets" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get datastore secrets.": { + "$ref": "./examples/Datastore/listSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": { + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "List environment containers.", + "operationId": "EnvironmentContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": { + "delete": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Delete container.", + "operationId": "EnvironmentContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Get container.", + "operationId": "EnvironmentContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/get.json" + } + } + }, + "put": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Create or update container.", + "operationId": "EnvironmentContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": { + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "List versions.", + "operationId": "EnvironmentVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": { + "delete": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Delete version.", + "operationId": "EnvironmentVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Get version.", + "operationId": "EnvironmentVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/get.json" + } + } + }, + "put": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Creates or updates an EnvironmentVersion.", + "operationId": "EnvironmentVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Name of EnvironmentVersion. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version of EnvironmentVersion.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Definition of EnvironmentVersion.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}/publish": { + "post": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "EnvironmentVersions_Publish", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Publish Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets": { + "get": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "List featurestore entity containers.", + "operationId": "FeaturesetContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "name", + "description": "name for the featureset", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature set", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features": { + "get": { + "tags": [ + "Feature" + ], + "summary": "List Features.", + "operationId": "Features_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "featuresetName", + "description": "Featureset name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "featuresetVersion", + "description": "Featureset Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "featureName", + "description": "feature name.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Description of the featureset.", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "Page size.", + "type": "integer", + "format": "int32", + "default": 1000 + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeatureResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Feature.": { + "$ref": "./examples/Feature/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}": { + "get": { + "tags": [ + "Feature" + ], + "summary": "Get feature.", + "operationId": "Features_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "featuresetName", + "description": "Feature set name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "featuresetVersion", + "description": "Feature set version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "featureName", + "description": "Feature Name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeatureResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Feature.": { + "$ref": "./examples/Feature/get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": { + "delete": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "Delete container.", + "operationId": "FeaturesetContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "Get container.", + "operationId": "FeaturesetContainers_GetEntity", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetEntity Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/getEntity.json" + } + } + }, + "put": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "Create or update container.", + "operationId": "FeaturesetContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions": { + "get": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "List versions.", + "operationId": "FeaturesetVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Featureset name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "versionName", + "description": "name for the featureset version", + "type": "string" + }, + { + "in": "query", + "name": "version", + "description": "featureset version", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature set version", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" + }, + { + "in": "query", + "name": "stage", + "description": "Specifies the featurestore stage", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}": { + "delete": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "Delete version.", + "operationId": "FeaturesetVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "Get version.", + "operationId": "FeaturesetVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/get.json" + } + } + }, + "put": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "Create or update version.", + "operationId": "FeaturesetVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill": { + "post": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "Backfill.", + "operationId": "FeaturesetVersions_Backfill", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Feature set version backfill request entity.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetVersionBackfillRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionBackfillResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backfill Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/backfill.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities": { + "get": { + "tags": [ + "FeaturestoreEntityContainer" + ], + "summary": "List featurestore entity containers.", + "operationId": "FeaturestoreEntityContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "name", + "description": "name for the featurestore entity", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the featurestore entity", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}": { + "delete": { + "tags": [ + "FeaturestoreEntityContainer" + ], + "summary": "Delete container.", + "operationId": "FeaturestoreEntityContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FeaturestoreEntityContainer" + ], + "summary": "Get container.", + "operationId": "FeaturestoreEntityContainers_GetEntity", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetEntity Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/getEntity.json" + } + } + }, + "put": { + "tags": [ + "FeaturestoreEntityContainer" + ], + "summary": "Create or update container.", + "operationId": "FeaturestoreEntityContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions": { + "get": { + "tags": [ + "FeaturestoreEntityVersion" + ], + "summary": "List versions.", + "operationId": "FeaturestoreEntityVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Feature entity name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "versionName", + "description": "name for the featurestore entity version", + "type": "string" + }, + { + "in": "query", + "name": "version", + "description": "featurestore entity version", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature entity version", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" + }, + { + "in": "query", + "name": "stage", + "description": "Specifies the featurestore stage", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}": { + "delete": { + "tags": [ + "FeaturestoreEntityVersion" + ], + "summary": "Delete version.", + "operationId": "FeaturestoreEntityVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FeaturestoreEntityVersion" + ], + "summary": "Get version.", + "operationId": "FeaturestoreEntityVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/get.json" + } + } + }, + "put": { + "tags": [ + "FeaturestoreEntityVersion" + ], + "summary": "Create or update version.", + "operationId": "FeaturestoreEntityVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": { + "get": { + "tags": [ + "Job" + ], + "summary": "Lists Jobs in the workspace.", + "operationId": "Jobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "jobType", + "description": "Type of job to be returned.", + "type": "string" + }, + { + "in": "query", + "name": "tag", + "description": "Jobs returned will have this tag key.", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of user property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Command Job.": { + "$ref": "./examples/Job/CommandJob/list.json" + }, + "List AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/list.json" + }, + "List Sweep Job.": { + "$ref": "./examples/Job/SweepJob/list.json" + }, + "List Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { + "delete": { + "tags": [ + "Job" + ], + "summary": "Deletes a Job (asynchronous).", + "operationId": "Jobs_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Job.": { + "$ref": "./examples/Job/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Job" + ], + "summary": "Gets a Job by name/id.", + "operationId": "Jobs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Command Job.": { + "$ref": "./examples/Job/CommandJob/get.json" + }, + "Get AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/get.json" + }, + "Get Sweep Job.": { + "$ref": "./examples/Job/SweepJob/get.json" + }, + "Get Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/get.json" + } + } + }, + "put": { + "tags": [ + "Job" + ], + "summary": "Creates and executes a Job.\r\nFor update case, the Tags in the definition passed in will replace Tags in the existing job.", + "operationId": "Jobs_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Job definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Command Job.": { + "$ref": "./examples/Job/CommandJob/createOrUpdate.json" + }, + "CreateOrUpdate AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/createOrUpdate.json" + }, + "CreateOrUpdate Sweep Job.": { + "$ref": "./examples/Job/SweepJob/createOrUpdate.json" + }, + "CreateOrUpdate Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { + "post": { + "tags": [ + "Job" + ], + "summary": "Cancels a Job (asynchronous).", + "operationId": "Jobs_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Cancel Job.": { + "$ref": "./examples/Job/cancel.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions": { + "get": { + "tags": [ + "MarketplaceSubscription" + ], + "summary": "List containers.", + "operationId": "MarketplaceSubscriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MarketplaceSubscriptionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}": { + "delete": { + "tags": [ + "MarketplaceSubscription" + ], + "summary": "Delete Marketplace Subscription (asynchronous).", + "operationId": "MarketplaceSubscriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Marketplace Subscription name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "MarketplaceSubscription" + ], + "summary": "Get container.", + "operationId": "MarketplaceSubscriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MarketplaceSubscriptionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/get.json" + } + } + }, + "put": { + "tags": [ + "MarketplaceSubscription" + ], + "summary": "Create or update Marketplace Subscription (asynchronous).", + "operationId": "MarketplaceSubscriptions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Marketplace Subscription name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Marketplace Subscription entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/MarketplaceSubscriptionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/MarketplaceSubscriptionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/MarketplaceSubscriptionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models": { + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "List model containers.", + "operationId": "ModelContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "count", + "description": "Maximum number of results to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": { + "delete": { + "tags": [ + "ModelContainer" + ], + "summary": "Delete container.", + "operationId": "ModelContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "Get container.", + "operationId": "ModelContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ModelContainer" + ], + "summary": "Create or update container.", + "operationId": "ModelContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions": { + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "List model versions.", + "operationId": "ModelVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Model name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "version", + "description": "Model version.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Model description.", + "type": "string" + }, + { + "in": "query", + "name": "offset", + "description": "Number of initial results to skip.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + }, + { + "in": "query", + "name": "feed", + "description": "Name of the feed.", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": { + "delete": { + "tags": [ + "ModelVersion" + ], + "summary": "Delete version.", + "operationId": "ModelVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "Get version.", + "operationId": "ModelVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ModelVersion" + ], + "summary": "Create or update version.", + "operationId": "ModelVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}/publish": { + "post": { + "tags": [ + "ModelVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "ModelVersions_Publish", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Publish Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/publish.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": { + "get": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "List Online Endpoints.", + "operationId": "OnlineEndpoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "name", + "description": "Name of the endpoint.", + "type": "string" + }, + { + "in": "query", + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "computeType", + "description": "EndpointComputeType to be filtered by.", + "type": "string", + "enum": [ + "Managed", + "Kubernetes", + "AzureMLCompute" + ], + "x-ms-enum": { + "name": "EndpointComputeType", + "modelAsString": true + } + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "The option to order the response.", + "type": "string", + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}": { + "delete": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Delete Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Get Online Endpoint.", + "operationId": "OnlineEndpoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/get.json" + } + } + }, + "patch": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Update Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Create or update Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": { + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "List Inference Endpoint Deployments.", + "operationId": "OnlineDeployments_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top of list.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Online Deployments.": { + "$ref": "./examples/OnlineDeployment/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": { + "delete": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Delete Inference Endpoint Deployment (asynchronous).", + "operationId": "OnlineDeployments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Online Deployment.": { + "$ref": "./examples/Workspace/OnlineDeployment/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Get Inference Deployment Deployment.", + "operationId": "OnlineDeployments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/get.json" + }, + "Get Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/get.json" + } + } + }, + "patch": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Update Online Deployment (asynchronous).", + "operationId": "OnlineDeployments_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSku" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/update.json" + }, + "Update Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Create or update Inference Endpoint Deployment (asynchronous).", + "operationId": "OnlineDeployments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Inference Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json" + }, + "CreateOrUpdate Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": { + "post": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Polls an Endpoint operation.", + "operationId": "OnlineDeployments_GetLogs", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The name and identifier for the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The request containing parameters for retrieving logs.", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentLogsRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentLogs" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Online Deployment Logs.": { + "$ref": "./examples/OnlineDeployment/getLogs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/skus": { + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "List Inference Endpoint Deployment Skus.", + "operationId": "OnlineDeployments_ListSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of Skus to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SkuResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Managed Online Deployment Skus.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json" + }, + "List Kubernetes Online Deployment Skus.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/listKeys": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", + "operationId": "OnlineEndpoints_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListKeys Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", + "operationId": "OnlineEndpoints_RegenerateKeys", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "RegenerateKeys request .", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateEndpointKeysRequest" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegenerateKeys Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/regenerateKeys.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/token": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.", + "operationId": "OnlineEndpoints_GetToken", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthToken" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetToken Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/getToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules": { + "get": { + "tags": [ + "Schedule" + ], + "summary": "List schedules in specified workspace.", + "operationId": "Schedules_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "Status filter for schedule.", + "type": "string", + "default": "EnabledOnly", + "enum": [ + "EnabledOnly", + "DisabledOnly", + "All" + ], + "x-ms-enum": { + "name": "ScheduleListViewType", + "modelAsString": true, + "values": [ + { + "value": "EnabledOnly" + }, + { + "value": "DisabledOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Schedules.": { + "$ref": "./examples/Schedule/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}": { + "delete": { + "tags": [ + "Schedule" + ], + "summary": "Delete schedule.", + "operationId": "Schedules_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Schedule.": { + "$ref": "./examples/Schedule/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Schedule" + ], + "summary": "Get schedule.", + "operationId": "Schedules_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Schedule.": { + "$ref": "./examples/Schedule/get.json" + } + } + }, + "put": { + "tags": [ + "Schedule" + ], + "summary": "Create or update schedule.", + "operationId": "Schedules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Schedule definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ScheduleResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Schedule.": { + "$ref": "./examples/Schedule/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints": { + "get": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "List Serverless Endpoints.", + "operationId": "ServerlessEndpoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}": { + "delete": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Delete Serverless Endpoint (asynchronous).", + "operationId": "ServerlessEndpoints_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Get Serverless Endpoint.", + "operationId": "ServerlessEndpoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/get.json" + } + } + }, + "patch": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Update Serverless Endpoint (asynchronous).", + "operationId": "ServerlessEndpoints_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Serverless Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSkuAndIdentity" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Create or update Serverless Endpoint (asynchronous).", + "operationId": "ServerlessEndpoints_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{0,51}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Serverless Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + } + ], + "responses": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/listKeys": { + "post": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", + "operationId": "ServerlessEndpoints_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListKeys Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/regenerateKeys": { + "post": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", + "operationId": "ServerlessEndpoints_RegenerateKeys", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "RegenerateKeys request .", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateEndpointKeysRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegenerateKeys Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/regenerateKeys.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "AccountKeyDatastoreCredentials": { + "description": "Account key datastore credentials configuration.", + "required": [ + "secrets" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "secrets": { + "description": "[Required] Storage account secrets.", + "$ref": "#/definitions/AccountKeyDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "AccountKey", + "additionalProperties": false + }, + "AccountKeyDatastoreSecrets": { + "description": "Datastore account key secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "key": { + "description": "Storage account key.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "AccountKey", + "additionalProperties": false + }, + "AllFeatures": { + "required": [ + "filterType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringFeatureFilterBase" + } + ], + "x-ms-discriminator-value": "AllFeatures", + "additionalProperties": false + }, + "AllNodes": { + "description": "All nodes means the service will be running on all of the nodes of the job", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Nodes" + } + ], + "x-ms-discriminator-value": "All", + "additionalProperties": false + }, + "AmlToken": { + "description": "AML Token identity configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IdentityConfiguration" + } + ], + "x-ms-discriminator-value": "AMLToken", + "additionalProperties": false + }, + "AmlTokenComputeIdentity": { + "description": "AML token compute identity definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitorComputeIdentityBase" + } + ], + "x-ms-discriminator-value": "AmlToken", + "additionalProperties": false + }, + "AnonymousAccessCredential": { + "description": "Access credential with no credentials", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataReferenceCredential" + } + ], + "x-ms-discriminator-value": "NoCredentials", + "additionalProperties": false + }, + "AssetBase": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "isAnonymous": { + "description": "If the name version are system generated (anonymous registration).", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "isArchived": { + "description": "Is the asset archived?", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "additionalProperties": false + }, + "AssetContainer": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "isArchived": { + "description": "Is the asset archived?", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "latestVersion": { + "description": "The latest version inside this container.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "nextVersion": { + "description": "The next auto incremental version", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AssetJobInput": { + "description": "Asset input type.", + "required": [ + "uri" + ], + "type": "object", + "properties": { + "mode": { + "description": "Input Asset Delivery Mode.", + "default": "ReadOnlyMount", + "$ref": "#/definitions/InputDeliveryMode", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "uri": { + "description": "[Required] Input Asset URI.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, + "AssetJobOutput": { + "description": "Asset output type.", + "type": "object", + "properties": { + "mode": { + "description": "Output Asset Delivery Mode.", + "default": "ReadWriteMount", + "$ref": "#/definitions/OutputDeliveryMode", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "uri": { + "description": "Output Asset URI.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AssetProvisioningState": { + "description": "Provisioning state of registry asset.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "AssetProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + }, + { + "value": "Creating" + }, + { + "value": "Updating" + }, + { + "value": "Deleting" + } + ] + }, + "additionalProperties": false + }, + "AssetReferenceBase": { + "description": "Base definition for asset references.", + "required": [ + "referenceType" + ], + "type": "object", + "properties": { + "referenceType": { + "description": "[Required] Specifies the type of asset reference.", + "$ref": "#/definitions/ReferenceType" + } + }, + "discriminator": "referenceType" + }, + "AutoForecastHorizon": { + "description": "Forecast horizon determined automatically by system.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ForecastHorizon" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoMLJob": { + "description": "AutoMLJob class.\r\nUse this class for executing AutoML tasks like Classification/Regression etc.\r\nSee TaskType enum for all the tasks supported.", + "required": [ + "taskDetails" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "environmentId": { + "description": "The ARM resource ID of the Environment specification for the job.\r\nThis is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "taskDetails": { + "description": "[Required] This represents scenario which can be one of Tables/NLP/Image", + "$ref": "#/definitions/AutoMLVertical" + } + }, + "x-ms-discriminator-value": "AutoML", + "additionalProperties": false + }, + "AutoMLVertical": { + "description": "AutoML vertical class.\r\nBase class for AutoML verticals - TableVertical/ImageVertical/NLPVertical", + "required": [ + "taskType", + "trainingData" + ], + "type": "object", + "properties": { + "logVerbosity": { + "description": "Log verbosity for the job.", + "default": "Info", + "$ref": "#/definitions/LogVerbosity" + }, + "targetColumnName": { + "description": "Target column name: This is prediction values column.\r\nAlso known as label column name in context of classification tasks.", + "type": "string", + "x-nullable": true + }, + "taskType": { + "description": "[Required] Task type for AutoMLJob.", + "$ref": "#/definitions/TaskType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "trainingData": { + "description": "[Required] Training data input.", + "$ref": "#/definitions/MLTableJobInput" + } + }, + "discriminator": "taskType" + }, + "AutoNCrossValidations": { + "description": "N-Cross validations determined automatically.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NCrossValidations" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoRebuildSetting": { + "description": "AutoRebuild setting for the derived image", + "enum": [ + "Disabled", + "OnBaseImageUpdate" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoRebuildSetting", + "modelAsString": true, + "values": [ + { + "value": "Disabled" + }, + { + "value": "OnBaseImageUpdate" + } + ] + }, + "additionalProperties": false + }, + "AutoSeasonality": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Seasonality" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoTargetLags": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetLags" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoTargetRollingWindowSize": { + "description": "Target lags rolling window determined automatically.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetRollingWindowSize" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AzureBlobDatastore": { + "description": "Azure Blob datastore configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "accountName": { + "description": "Storage account name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "containerName": { + "description": "Storage account container name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "protocol": { + "description": "Protocol used to communicate with the storage account.", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureBlob", + "additionalProperties": false + }, + "AzureDataLakeGen1Datastore": { + "description": "Azure Data Lake Gen1 datastore configuration.", + "required": [ + "storeName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "storeName": { + "description": "[Required] Azure Data Lake store name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureDataLakeGen1", + "additionalProperties": false + }, + "AzureDataLakeGen2Datastore": { + "description": "Azure Data Lake Gen2 datastore configuration.", + "required": [ + "accountName", + "filesystem" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "accountName": { + "description": "[Required] Storage account name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "filesystem": { + "description": "[Required] The name of the Data Lake Gen2 filesystem.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "protocol": { + "description": "Protocol used to communicate with the storage account.", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureDataLakeGen2", + "additionalProperties": false + }, + "AzureDatastore": { + "description": "Base definition for Azure datastore contents configuration.", + "type": "object", + "properties": { + "resourceGroup": { + "description": "Azure Resource Group name", + "type": "string", + "x-nullable": true + }, + "subscriptionId": { + "description": "Azure Subscription Id", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AzureDevOpsWebhook": { + "description": "Webhook details specific for Azure DevOps", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Webhook" + } + ], + "x-ms-discriminator-value": "AzureDevOps", + "additionalProperties": false + }, + "AzureFileDatastore": { + "description": "Azure File datastore configuration.", + "required": [ + "accountName", + "fileShareName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "accountName": { + "description": "[Required] Storage account name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "fileShareName": { + "description": "[Required] The name of the Azure file share that the datastore points to.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "protocol": { + "description": "Protocol used to communicate with the storage account.", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureFile", + "additionalProperties": false + }, + "BanditPolicy": { + "description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EarlyTerminationPolicy" + } + ], + "properties": { + "slackAmount": { + "format": "float", + "description": "Absolute distance allowed from the best performing run.", + "default": 0, + "type": "number" + }, + "slackFactor": { + "format": "float", + "description": "Ratio of the allowed distance from the best performing run.", + "default": 0, + "type": "number" + } + }, + "x-ms-discriminator-value": "Bandit", + "additionalProperties": false + }, + "BatchDeployment": { + "description": "Batch inference settings per deployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointDeploymentPropertiesBase" + } + ], + "properties": { + "compute": { + "description": "Compute target for batch inference operation.", + "type": "string", + "x-nullable": true + }, + "deploymentConfiguration": { + "description": "Properties relevant to different deployment types.", + "$ref": "#/definitions/BatchDeploymentConfiguration", + "x-nullable": true + }, + "errorThreshold": { + "format": "int32", + "description": "Error threshold, if the error count for the entire input goes above this value,\r\nthe batch inference will be aborted. Range is [-1, int.MaxValue].\r\nFor FileDataset, this value is the count of file failures.\r\nFor TabularDataset, this value is the count of record failures.\r\nIf set to -1 (the lower bound), all failures during batch inference will be ignored.", + "default": -1, + "type": "integer" + }, + "loggingLevel": { + "description": "Logging level for batch inference operation.", + "default": "Info", + "$ref": "#/definitions/BatchLoggingLevel" + }, + "maxConcurrencyPerInstance": { + "format": "int32", + "description": "Indicates maximum number of parallelism per instance.", + "default": 1, + "type": "integer" + }, + "miniBatchSize": { + "format": "int64", + "description": "Size of the mini-batch passed to each batch invocation.\r\nFor FileDataset, this is the number of files per mini-batch.\r\nFor TabularDataset, this is the size of the records in bytes, per mini-batch.", + "default": 10, + "type": "integer" + }, + "model": { + "description": "Reference to the model asset for the endpoint deployment.", + "$ref": "#/definitions/AssetReferenceBase", + "x-nullable": true + }, + "outputAction": { + "description": "Indicates how the output will be organized.", + "default": "AppendRow", + "$ref": "#/definitions/BatchOutputAction" + }, + "outputFileName": { + "description": "Customized output file name for append_row output action.", + "default": "predictions.csv", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state for the endpoint deployment.", + "$ref": "#/definitions/DeploymentProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "resources": { + "description": "Indicates compute configuration for the job.\r\nIf not provided, will default to the defaults defined in ResourceConfiguration.", + "$ref": "#/definitions/DeploymentResourceConfiguration", + "x-nullable": true + }, + "retrySettings": { + "description": "Retry Settings for the batch inference operation.\r\nIf not provided, will default to the defaults defined in BatchRetrySettings.", + "$ref": "#/definitions/BatchRetrySettings", + "x-nullable": true + } + }, + "x-ms-client-name": "BatchDeploymentProperties", + "additionalProperties": false + }, + "BatchDeploymentConfiguration": { + "description": "Properties relevant to different deployment types.", + "required": [ + "deploymentConfigurationType" + ], + "type": "object", + "properties": { + "deploymentConfigurationType": { + "description": "[Required] The type of the deployment", + "$ref": "#/definitions/BatchDeploymentConfigurationType" + } + }, + "discriminator": "deploymentConfigurationType" + }, + "BatchDeploymentConfigurationType": { + "description": "The enumerated property types for batch deployments.", + "enum": [ + "Model", + "PipelineComponent" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchDeploymentConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Model" + }, + { + "value": "PipelineComponent" + } + ] + }, + "additionalProperties": false + }, + "BatchDeploymentTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/BatchDeployment" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "BatchDeployment", + "additionalProperties": false + }, + "BatchDeploymentTrackedResourceArmPaginatedResult": { + "description": "A paginated list of BatchDeployment entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of BatchDeployment objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type BatchDeployment.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + } + }, + "additionalProperties": false + }, + "BatchEndpoint": { + "description": "Batch endpoint configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesBase" + } + ], + "properties": { + "defaults": { + "description": "Default values for Batch Endpoint", + "$ref": "#/definitions/BatchEndpointDefaults", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "BatchEndpointProperties", + "additionalProperties": false + }, + "BatchEndpointDefaults": { + "description": "Batch endpoint default values", + "type": "object", + "properties": { + "deploymentName": { + "description": "Name of the deployment that will be default for the endpoint.\r\nThis deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "BatchEndpointTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/BatchEndpoint" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "BatchEndpoint", + "additionalProperties": false + }, + "BatchEndpointTrackedResourceArmPaginatedResult": { + "description": "A paginated list of BatchEndpoint entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of BatchEndpoint objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type BatchEndpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + } + }, + "additionalProperties": false + }, + "BatchLoggingLevel": { + "description": "Log verbosity for batch inferencing.\r\nIncreasing verbosity order for logging is : Warning, Info and Debug.\r\nThe default value is Info.", + "enum": [ + "Info", + "Warning", + "Debug" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchLoggingLevel", + "modelAsString": true, + "values": [ + { + "value": "Info" + }, + { + "value": "Warning" + }, + { + "value": "Debug" + } + ] + }, + "additionalProperties": false + }, + "BatchOutputAction": { + "description": "Enum to determine how batch inferencing will handle output", + "enum": [ + "SummaryOnly", + "AppendRow" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchOutputAction", + "modelAsString": true, + "values": [ + { + "value": "SummaryOnly" + }, + { + "value": "AppendRow" + } + ] + }, + "additionalProperties": false + }, + "BatchPipelineComponentDeploymentConfiguration": { + "description": "Properties for a Batch Pipeline Component Deployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BatchDeploymentConfiguration" + } + ], + "properties": { + "componentId": { + "description": "The ARM id of the component to be run.", + "$ref": "#/definitions/IdAssetReference", + "x-nullable": true + }, + "description": { + "description": "The description which will be applied to the job.", + "type": "string", + "x-nullable": true + }, + "settings": { + "description": "Run-time settings for the pipeline job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "tags": { + "description": "The tags which will be applied to the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PipelineComponent", + "additionalProperties": false + }, + "BatchRetrySettings": { + "description": "Retry settings for a batch inference operation.", + "type": "object", + "properties": { + "maxRetries": { + "format": "int32", + "description": "Maximum retry count for a mini-batch", + "default": 3, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "Invocation timeout for a mini-batch, in ISO 8601 format.", + "default": "PT30S", + "type": "string" + } + }, + "additionalProperties": false + }, + "BayesianSamplingAlgorithm": { + "description": "Defines a Sampling Algorithm that generates values based on previous values", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SamplingAlgorithm" + } + ], + "x-ms-discriminator-value": "Bayesian", + "additionalProperties": false + }, + "BlobReferenceForConsumptionDto": { + "type": "object", + "properties": { + "blobUri": { + "format": "uri", + "description": "Blob URI path for client to upload data.\r\nExample: https://blob.windows.core.net/Container/Path", + "type": "string", + "x-nullable": true + }, + "credential": { + "description": "Credential info to access storage account", + "$ref": "#/definitions/PendingUploadCredentialDto", + "x-nullable": true + }, + "storageAccountArmId": { + "description": "Arm ID of the storage account to use", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "BlockedTransformers": { + "description": "Enum for all classification models supported by AutoML.", + "enum": [ + "TextTargetEncoder", + "OneHotEncoder", + "CatTargetEncoder", + "TfIdf", + "WoETargetEncoder", + "LabelEncoder", + "WordEmbedding", + "NaiveBayes", + "CountVectorizer", + "HashOneHotEncoder" + ], + "type": "string", + "x-ms-enum": { + "name": "BlockedTransformers", + "modelAsString": true, + "values": [ + { + "value": "TextTargetEncoder", + "description": "Target encoding for text data." + }, + { + "value": "OneHotEncoder", + "description": "Ohe hot encoding creates a binary feature transformation." + }, + { + "value": "CatTargetEncoder", + "description": "Target encoding for categorical data." + }, + { + "value": "TfIdf", + "description": "Tf-Idf stands for, term-frequency times inverse document-frequency. This is a common term weighting scheme for identifying information from documents." + }, + { + "value": "WoETargetEncoder", + "description": "Weight of Evidence encoding is a technique used to encode categorical variables. It uses the natural log of the P(1)/P(0) to create weights." + }, + { + "value": "LabelEncoder", + "description": "Label encoder converts labels/categorical variables in a numerical form." + }, + { + "value": "WordEmbedding", + "description": "Word embedding helps represents words or phrases as a vector, or a series of numbers." + }, + { + "value": "NaiveBayes", + "description": "Naive Bayes is a classified that is used for classification of discrete features that are categorically distributed." + }, + { + "value": "CountVectorizer", + "description": "Count Vectorizer converts a collection of text documents to a matrix of token counts." + }, + { + "value": "HashOneHotEncoder", + "description": "Hashing One Hot Encoder can turn categorical variables into a limited number of new features. This is often used for high-cardinality categorical features." + } + ] + }, + "additionalProperties": false + }, + "BuildContext": { + "description": "Configuration settings for Docker build context", + "required": [ + "contextUri" + ], + "type": "object", + "properties": { + "contextUri": { + "description": "[Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs.\r\n", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dockerfilePath": { + "description": "Path to the Dockerfile in the build context.\r\n", + "default": "Dockerfile", + "type": "string", + "example": "prod/Dockerfile", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "CategoricalDataDriftMetric": { + "enum": [ + "JensenShannonDistance", + "PopulationStabilityIndex", + "PearsonsChiSquaredTest" + ], + "type": "string", + "x-ms-enum": { + "name": "CategoricalDataDriftMetric", + "modelAsString": true, + "values": [ + { + "value": "JensenShannonDistance", + "description": "The Jensen Shannon Distance (JSD) metric." + }, + { + "value": "PopulationStabilityIndex", + "description": "The Population Stability Index (PSI) metric." + }, + { + "value": "PearsonsChiSquaredTest", + "description": "The Pearsons Chi Squared Test metric." + } + ] + }, + "additionalProperties": false + }, + "CategoricalDataDriftMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataDriftMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The categorical data drift metric to calculate.", + "$ref": "#/definitions/CategoricalDataDriftMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Categorical", + "additionalProperties": false + }, + "CategoricalDataQualityMetric": { + "enum": [ + "NullValueRate", + "DataTypeErrorRate", + "OutOfBoundsRate" + ], + "type": "string", + "x-ms-enum": { + "name": "CategoricalDataQualityMetric", + "modelAsString": true, + "values": [ + { + "value": "NullValueRate", + "description": "Calculates the rate of null values." + }, + { + "value": "DataTypeErrorRate", + "description": "Calculates the rate of data type errors." + }, + { + "value": "OutOfBoundsRate", + "description": "Calculates the rate values are out of bounds." + } + ] + }, + "additionalProperties": false + }, + "CategoricalDataQualityMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataQualityMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The categorical data quality metric to calculate.", + "$ref": "#/definitions/CategoricalDataQualityMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Categorical", + "additionalProperties": false + }, + "CategoricalPredictionDriftMetric": { + "enum": [ + "JensenShannonDistance", + "PopulationStabilityIndex", + "PearsonsChiSquaredTest" + ], + "type": "string", + "x-ms-enum": { + "name": "CategoricalPredictionDriftMetric", + "modelAsString": true, + "values": [ + { + "value": "JensenShannonDistance", + "description": "The Jensen Shannon Distance (JSD) metric." + }, + { + "value": "PopulationStabilityIndex", + "description": "The Population Stability Index (PSI) metric." + }, + { + "value": "PearsonsChiSquaredTest", + "description": "The Pearsons Chi Squared Test metric." + } + ] + }, + "additionalProperties": false + }, + "CategoricalPredictionDriftMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PredictionDriftMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The categorical prediction drift metric to calculate.", + "$ref": "#/definitions/CategoricalPredictionDriftMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Categorical", + "additionalProperties": false + }, + "CertificateDatastoreCredentials": { + "description": "Certificate datastore credentials configuration.", + "required": [ + "clientId", + "secrets", + "tenantId", + "thumbprint" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "authorityUrl": { + "description": "Authority URL used for authentication.", + "type": "string", + "x-nullable": true + }, + "clientId": { + "format": "uuid", + "description": "[Required] Service principal client ID.", + "type": "string" + }, + "resourceUrl": { + "description": "Resource the service principal has access to.", + "type": "string", + "x-nullable": true + }, + "secrets": { + "description": "[Required] Service principal secrets.", + "$ref": "#/definitions/CertificateDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "tenantId": { + "format": "uuid", + "description": "[Required] ID of the tenant to which the service principal belongs.", + "type": "string" + }, + "thumbprint": { + "description": "[Required] Thumbprint of the certificate used for authentication.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "Certificate", + "additionalProperties": false + }, + "CertificateDatastoreSecrets": { + "description": "Datastore certificate secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "certificate": { + "description": "Service principal certificate.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Certificate", + "additionalProperties": false + }, + "Classification": { + "description": "Classification task in AutoML Table vertical.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TableVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "positiveLabel": { + "description": "Positive label for binary metrics calculation.", + "type": "string", + "x-nullable": true + }, + "primaryMetric": { + "description": "Primary metric for the task.", + "default": "AUCWeighted", + "$ref": "#/definitions/ClassificationPrimaryMetrics" + }, + "trainingSettings": { + "description": "Inputs for training phase for an AutoML Job.", + "$ref": "#/definitions/ClassificationTrainingSettings", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Classification", + "additionalProperties": false + }, + "ClassificationModels": { + "description": "Enum for all classification models supported by AutoML.", + "enum": [ + "LogisticRegression", + "SGD", + "MultinomialNaiveBayes", + "BernoulliNaiveBayes", + "SVM", + "LinearSVM", + "KNN", + "DecisionTree", + "RandomForest", + "ExtremeRandomTrees", + "LightGBM", + "GradientBoosting", + "XGBoostClassifier" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationModels", + "modelAsString": true, + "values": [ + { + "value": "LogisticRegression", + "description": "Logistic regression is a fundamental classification technique.\nIt belongs to the group of linear classifiers and is somewhat similar to polynomial and linear regression.\nLogistic regression is fast and relatively uncomplicated, and it's convenient for you to interpret the results.\nAlthough it's essentially a method for binary classification, it can also be applied to multiclass problems." + }, + { + "value": "SGD", + "description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs." + }, + { + "value": "MultinomialNaiveBayes", + "description": "The multinomial Naive Bayes classifier is suitable for classification with discrete features (e.g., word counts for text classification).\nThe multinomial distribution normally requires integer feature counts. However, in practice, fractional counts such as tf-idf may also work." + }, + { + "value": "BernoulliNaiveBayes", + "description": "Naive Bayes classifier for multivariate Bernoulli models." + }, + { + "value": "SVM", + "description": "A support vector machine (SVM) is a supervised machine learning model that uses classification algorithms for two-group classification problems.\nAfter giving an SVM model sets of labeled training data for each category, they're able to categorize new text." + }, + { + "value": "LinearSVM", + "description": "A support vector machine (SVM) is a supervised machine learning model that uses classification algorithms for two-group classification problems.\nAfter giving an SVM model sets of labeled training data for each category, they're able to categorize new text.\nLinear SVM performs best when input data is linear, i.e., data can be easily classified by drawing the straight line between classified values on a plotted graph." + }, + { + "value": "KNN", + "description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set." + }, + { + "value": "DecisionTree", + "description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features." + }, + { + "value": "RandomForest", + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the \"bagging\" method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + }, + { + "value": "ExtremeRandomTrees", + "description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm." + }, + { + "value": "LightGBM", + "description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms." + }, + { + "value": "GradientBoosting", + "description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution." + }, + { + "value": "XGBoostClassifier", + "description": "XGBoost: Extreme Gradient Boosting Algorithm. This algorithm is used for structured data where target column values can be divided into distinct class values." + } + ] + }, + "additionalProperties": false + }, + "ClassificationMultilabelPrimaryMetrics": { + "description": "Primary metrics for classification multilabel tasks.", + "enum": [ + "AUCWeighted", + "Accuracy", + "NormMacroRecall", + "AveragePrecisionScoreWeighted", + "PrecisionScoreWeighted", + "IOU" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationMultilabelPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "AUCWeighted", + "description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class." + }, + { + "value": "Accuracy", + "description": "Accuracy is the ratio of predictions that exactly match the true class labels." + }, + { + "value": "NormMacroRecall", + "description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1." + }, + { + "value": "AveragePrecisionScoreWeighted", + "description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class." + }, + { + "value": "PrecisionScoreWeighted", + "description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class." + }, + { + "value": "IOU", + "description": "Intersection Over Union. Intersection of predictions divided by union of predictions." + } + ] + }, + "additionalProperties": false + }, + "ClassificationPrimaryMetrics": { + "description": "Primary metrics for classification tasks.", + "enum": [ + "AUCWeighted", + "Accuracy", + "NormMacroRecall", + "AveragePrecisionScoreWeighted", + "PrecisionScoreWeighted" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "AUCWeighted", + "description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class." + }, + { + "value": "Accuracy", + "description": "Accuracy is the ratio of predictions that exactly match the true class labels." + }, + { + "value": "NormMacroRecall", + "description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1." + }, + { + "value": "AveragePrecisionScoreWeighted", + "description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class." + }, + { + "value": "PrecisionScoreWeighted", + "description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class." + } + ] + }, + "additionalProperties": false + }, + "ClassificationTrainingSettings": { + "description": "Classification Training related configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrainingSettings" + } + ], + "properties": { + "allowedTrainingAlgorithms": { + "description": "Allowed models for classification task.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationModels" + }, + "x-nullable": true + }, + "blockedTrainingAlgorithms": { + "description": "Blocked models for classification task.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationModels" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "CodeConfiguration": { + "description": "Configuration for a scoring code asset.", + "required": [ + "scoringScript" + ], + "type": "object", + "properties": { + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "scoringScript": { + "description": "[Required] The script to execute on startup. eg. \"score.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "CodeContainer": { + "description": "Container for code asset versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the code container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "CodeContainerProperties", + "additionalProperties": false + }, + "CodeContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/CodeContainer" + } + }, + "x-ms-client-name": "CodeContainer", + "additionalProperties": false + }, + "CodeContainerResourceArmPaginatedResult": { + "description": "A paginated list of CodeContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type CodeContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/CodeContainerResource" + } + } + }, + "additionalProperties": false + }, + "CodeVersion": { + "description": "Code asset version details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "codeUri": { + "description": "Uri where code is located", + "type": "string", + "example": "https://blobStorage/folderName", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the code version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "CodeVersionProperties", + "additionalProperties": false + }, + "CodeVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/CodeVersion" + } + }, + "x-ms-client-name": "CodeVersion", + "additionalProperties": false + }, + "CodeVersionResourceArmPaginatedResult": { + "description": "A paginated list of CodeVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type CodeVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/CodeVersionResource" + } + } + }, + "additionalProperties": false + }, + "Collection": { + "type": "object", + "properties": { + "clientId": { + "description": "The msi client id used to collect logging to blob storage. If it's null,backend will pick a registered endpoint identity to auth.", + "type": "string", + "x-nullable": true + }, + "dataCollectionMode": { + "description": "Enable or disable data collection.", + "default": "Disabled", + "$ref": "#/definitions/DataCollectionMode" + }, + "dataId": { + "description": "The data asset arm resource id. Client side will ensure data asset is pointing to the blob storage, and backend will collect data to the blob storage.", + "type": "string", + "x-nullable": true + }, + "samplingRate": { + "format": "double", + "description": "The sampling rate for collection. Sampling rate 1.0 means we collect 100% of data by default.", + "default": 1, + "type": "number" + } + }, + "additionalProperties": false + }, + "ColumnTransformer": { + "description": "Column transformer parameters.", + "type": "object", + "properties": { + "fields": { + "description": "Fields to apply transformer logic on.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "parameters": { + "description": "Different properties to be passed to transformer.\r\nInput expected is dictionary of key,value pairs in JSON format.", + "type": "object", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "CommandJob": { + "description": "Command job definition.", + "required": [ + "command", + "environmentId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "command": { + "description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "distribution": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "$ref": "#/definitions/DistributionConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentId": { + "description": "[Required] The ARM resource ID of the Environment specification for the job.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Mapping of input data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "limits": { + "description": "Command Job limit.", + "$ref": "#/definitions/CommandJobLimits", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "parameters": { + "description": "Input parameters.", + "type": "object", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Command", + "additionalProperties": false + }, + "CommandJobLimits": { + "description": "Command Job limit class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobLimits" + } + ], + "x-ms-discriminator-value": "Command", + "additionalProperties": false + }, + "ComponentContainer": { + "description": "Component container definition.\r\n", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the component container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "ComponentContainerProperties", + "additionalProperties": false + }, + "ComponentContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ComponentContainer" + } + }, + "x-ms-client-name": "ComponentContainer", + "additionalProperties": false + }, + "ComponentContainerResourceArmPaginatedResult": { + "description": "A paginated list of ComponentContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ComponentContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ComponentContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/ComponentContainerResource" + } + } + }, + "additionalProperties": false + }, + "ComponentVersion": { + "description": "Definition of a component version: defines resources that span component types.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "componentSpec": { + "description": "Defines Component definition details.\r\n", + "type": "object", + "example": { + "name": "Hello_Python_World", + "display_name": "Hello_Python_World", + "version": 1, + "type": "command", + "code": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/mycode/versions/1", + "environment": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/AzureML-Tutorial/versions/1", + "command": "python hello.py" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the component version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "ComponentVersionProperties", + "additionalProperties": false + }, + "ComponentVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ComponentVersion" + } + }, + "x-ms-client-name": "ComponentVersion", + "additionalProperties": false + }, + "ComponentVersionResourceArmPaginatedResult": { + "description": "A paginated list of ComponentVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ComponentVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ComponentVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + }, + "additionalProperties": false + }, + "ContainerResourceRequirements": { + "description": "Resource requirements for each container instance within an online deployment.", + "type": "object", + "properties": { + "containerResourceLimits": { + "description": "Container resource limit info:", + "$ref": "#/definitions/ContainerResourceSettings", + "x-nullable": true + }, + "containerResourceRequests": { + "description": "Container resource request info:", + "$ref": "#/definitions/ContainerResourceSettings", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ContainerResourceSettings": { + "type": "object", + "properties": { + "cpu": { + "description": "Number of vCPUs request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "1", + "x-nullable": true + }, + "gpu": { + "description": "Number of Nvidia GPU cards request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "1", + "x-nullable": true + }, + "memory": { + "description": "Memory size request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "2Gi", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ContainerType": { + "enum": [ + "StorageInitializer", + "InferenceServer" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true, + "values": [ + { + "value": "StorageInitializer" + }, + { + "value": "InferenceServer" + } + ] + }, + "additionalProperties": false + }, + "ContentSafety": { + "required": [ + "contentSafetyStatus" + ], + "type": "object", + "properties": { + "contentSafetyStatus": { + "description": "[Required] Specifies the status of content safety.", + "$ref": "#/definitions/ContentSafetyStatus" + } + }, + "additionalProperties": false + }, + "ContentSafetyStatus": { + "description": "Specifies the status of content safety.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ContentSafetyStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "CreateMonitorAction": { + "required": [ + "monitorDefinition" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], + "properties": { + "monitorDefinition": { + "description": "[Required] Defines the monitor.", + "$ref": "#/definitions/MonitorDefinition", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "CreateMonitor", + "additionalProperties": false + }, + "CredentialsType": { + "description": "Enum to determine the datastore credentials type.", + "enum": [ + "AccountKey", + "Certificate", + "None", + "Sas", + "ServicePrincipal" + ], + "type": "string", + "x-ms-enum": { + "name": "CredentialsType", + "modelAsString": true, + "values": [ + { + "value": "AccountKey" + }, + { + "value": "Certificate" + }, + { + "value": "None" + }, + { + "value": "Sas" + }, + { + "value": "ServicePrincipal" + } + ] + }, + "additionalProperties": false + }, + "CronTrigger": { + "required": [ + "expression" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerBase" + } + ], + "properties": { + "expression": { + "description": "[Required] Specifies cron expression of schedule.\r\nThe expression should follow NCronTab format.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "Cron", + "additionalProperties": false + }, + "CustomForecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ForecastHorizon" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] Forecast horizon value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "properties": { + "metric": { + "description": "[Required] The user-defined metric to calculate.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "CustomModelJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "custom_model", + "additionalProperties": false + }, + "CustomModelJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "custom_model", + "additionalProperties": false + }, + "CustomMonitoringSignal": { + "required": [ + "componentId", + "metricThresholds" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "componentId": { + "description": "[Required] Reference to the component asset used to calculate the custom metrics.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "inputAssets": { + "description": "Monitoring assets to take as input. Key is the component input port name, value is the data asset.", + "type": "object", + "additionalProperties": { + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Extra component parameters to take as input. Key is the component literal input port name, value is the parameter value.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomMetricThreshold" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomNCrossValidations": { + "description": "N-Cross validations are specified by user.", + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NCrossValidations" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] N-Cross validations value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomSeasonality": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Seasonality" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] Seasonality value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomTargetLags": { + "required": [ + "values" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetLags" + } + ], + "properties": { + "values": { + "description": "[Required] Set target lags values.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomTargetRollingWindowSize": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetRollingWindowSize" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] TargetRollingWindowSize value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "DataAvailabilityStatus": { + "enum": [ + "None", + "Pending", + "Incomplete", + "Complete" + ], + "type": "string", + "x-ms-enum": { + "name": "DataAvailabilityStatus", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "Pending" + }, + { + "value": "Incomplete" + }, + { + "value": "Complete" + } + ] + }, + "additionalProperties": false + }, + "DataCollectionMode": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DataCollectionMode", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "DataCollector": { + "required": [ + "collections" + ], + "type": "object", + "properties": { + "collections": { + "description": "[Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string.\r\nModel data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Collection", + "x-nullable": true + } + }, + "requestLogging": { + "description": "The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional.", + "$ref": "#/definitions/RequestLogging", + "x-nullable": true + }, + "rollingRate": { + "description": "When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file.\r\nIf the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/.\r\nIf it's day, all data will be collected in blob path /yyyy/MM/dd/.\r\nThe other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly.", + "default": "Hour", + "$ref": "#/definitions/RollingRateType" + } + }, + "additionalProperties": false + }, + "DataContainer": { + "description": "Container for data asset versions.", + "required": [ + "dataType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "dataType": { + "description": "[Required] Specifies the type of data.", + "$ref": "#/definitions/DataType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-client-name": "DataContainerProperties", + "additionalProperties": false + }, + "DataContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/DataContainer" + } + }, + "x-ms-client-name": "DataContainer", + "additionalProperties": false + }, + "DataContainerResourceArmPaginatedResult": { + "description": "A paginated list of DataContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type DataContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/DataContainerResource" + } + } + }, + "additionalProperties": false + }, + "DataDriftMetricThresholdBase": { + "required": [ + "dataType" + ], + "type": "object", + "properties": { + "dataType": { + "description": "[Required] Specifies the data type of the metric threshold.", + "$ref": "#/definitions/MonitoringFeatureDataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "discriminator": "dataType" + }, + "DataDriftMonitoringSignal": { + "required": [ + "metricThresholds", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "featureImportanceSettings": { + "description": "The settings for computing feature importance.", + "$ref": "#/definitions/FeatureImportanceSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "features": { + "description": "The feature filter which identifies which feature to calculate drift over.", + "$ref": "#/definitions/MonitoringFeatureFilterBase", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/DataDriftMetricThresholdBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "[Required] The data which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "DataDrift", + "additionalProperties": false + }, + "DataPathAssetReference": { + "description": "Reference to an asset via its path in a datastore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "datastoreId": { + "description": "ARM resource ID of the datastore where the asset is located.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "The path of the file/directory in the datastore.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "DataPath", + "additionalProperties": false + }, + "DataQualityMetricThresholdBase": { + "required": [ + "dataType" + ], + "type": "object", + "properties": { + "dataType": { + "description": "[Required] Specifies the data type of the metric threshold.", + "$ref": "#/definitions/MonitoringFeatureDataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "discriminator": "dataType" + }, + "DataQualityMonitoringSignal": { + "required": [ + "metricThresholds", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "featureImportanceSettings": { + "description": "The settings for computing feature importance.", + "$ref": "#/definitions/FeatureImportanceSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "features": { + "description": "The features to calculate drift over.", + "$ref": "#/definitions/MonitoringFeatureFilterBase", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/DataQualityMetricThresholdBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "[Required] The data produced by the production service which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "DataQuality", + "additionalProperties": false + }, + "DataReferenceCredential": { + "description": "DataReferenceCredential base class", + "required": [ + "credentialType" + ], + "type": "object", + "properties": { + "credentialType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/DataReferenceCredentialType" + } + }, + "discriminator": "credentialType" + }, + "DataReferenceCredentialType": { + "description": "Enum to determine the DataReference credentials type.", + "enum": [ + "SAS", + "DockerCredentials", + "ManagedIdentity", + "NoCredentials" + ], + "type": "string", + "x-ms-enum": { + "name": "DataReferenceCredentialType", + "modelAsString": true, + "values": [ + { + "value": "SAS" + }, + { + "value": "DockerCredentials" + }, + { + "value": "ManagedIdentity" + }, + { + "value": "NoCredentials" + } + ] + }, + "additionalProperties": false + }, + "DataType": { + "description": "Enum to determine the type of data.", + "enum": [ + "uri_file", + "uri_folder", + "mltable" + ], + "type": "string", + "x-ms-enum": { + "name": "DataType", + "modelAsString": true, + "values": [ + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + } + ] + }, + "additionalProperties": false + }, + "DataVersionBase": { + "description": "Data version base definition", + "required": [ + "dataType", + "dataUri" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "dataType": { + "description": "[Required] Specifies the type of data.", + "$ref": "#/definitions/DataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dataUri": { + "description": "[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "dataType", + "x-ms-client-name": "DataVersionBaseProperties" + }, + "DataVersionBaseResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/DataVersionBase" + } + }, + "x-ms-client-name": "DataVersionBase", + "additionalProperties": false + }, + "DataVersionBaseResourceArmPaginatedResult": { + "description": "A paginated list of DataVersionBase entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of DataVersionBase objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type DataVersionBase.", + "type": "array", + "items": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + }, + "additionalProperties": false + }, + "Datastore": { + "description": "Base definition for datastore contents configuration.", + "required": [ + "credentials", + "datastoreType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "credentials": { + "description": "[Required] Account credentials.", + "$ref": "#/definitions/DatastoreCredentials" + }, + "datastoreType": { + "description": "[Required] Storage type backing the datastore.", + "$ref": "#/definitions/DatastoreType" + }, + "isDefault": { + "description": "Readonly property to indicate if datastore is the workspace default datastore", + "type": "boolean", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "discriminator": "datastoreType", + "x-ms-client-name": "DatastoreProperties" + }, + "DatastoreCredentials": { + "description": "Base definition for datastore credentials.", + "required": [ + "credentialsType" + ], + "type": "object", + "properties": { + "credentialsType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/CredentialsType" + } + }, + "discriminator": "credentialsType" + }, + "DatastoreResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Datastore" + } + }, + "x-ms-client-name": "Datastore", + "additionalProperties": false + }, + "DatastoreResourceArmPaginatedResult": { + "description": "A paginated list of Datastore entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Datastore objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Datastore.", + "type": "array", + "items": { + "$ref": "#/definitions/DatastoreResource" + } + } + }, + "additionalProperties": false + }, + "DatastoreSecrets": { + "description": "Base definition for datastore secrets.", + "required": [ + "secretsType" + ], + "type": "object", + "properties": { + "secretsType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/SecretsType" + } + }, + "discriminator": "secretsType" + }, + "DatastoreType": { + "description": "Enum to determine the datastore contents type.", + "enum": [ + "AzureBlob", + "AzureDataLakeGen1", + "AzureDataLakeGen2", + "AzureFile", + "OneLake" + ], + "type": "string", + "x-ms-enum": { + "name": "DatastoreType", + "modelAsString": true, + "values": [ + { + "value": "AzureBlob" + }, + { + "value": "AzureDataLakeGen1" + }, + { + "value": "AzureDataLakeGen2" + }, + { + "value": "AzureFile" + }, + { + "value": "OneLake" + } + ] + }, + "additionalProperties": false + }, + "DefaultScaleSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineScaleSettings" + } + ], + "x-ms-discriminator-value": "Default", + "additionalProperties": false + }, + "DeploymentLogs": { + "type": "object", + "properties": { + "content": { + "description": "The retrieved online deployment logs.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "DeploymentLogsRequest": { + "type": "object", + "properties": { + "containerType": { + "description": "The type of container to retrieve logs from.", + "default": "InferenceServer", + "$ref": "#/definitions/ContainerType" + }, + "tail": { + "format": "int32", + "description": "The maximum number of lines to tail.", + "type": "integer", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "DeploymentProvisioningState": { + "description": "Possible values for DeploymentProvisioningState.", + "enum": [ + "Creating", + "Deleting", + "Scaling", + "Updating", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "DeploymentProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Scaling" + }, + { + "value": "Updating" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "DeploymentResourceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceConfiguration" + } + ], + "additionalProperties": false + }, + "DestinationAsset": { + "description": "Publishing destination registry asset information", + "type": "object", + "properties": { + "destinationName": { + "description": "Destination asset name", + "type": "string", + "x-nullable": true + }, + "destinationVersion": { + "description": "Destination asset version", + "type": "string", + "x-nullable": true + }, + "registryName": { + "description": "Destination registry name", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "DistributionConfiguration": { + "description": "Base definition for job distribution configuration.", + "required": [ + "distributionType" + ], + "type": "object", + "properties": { + "distributionType": { + "description": "[Required] Specifies the type of distribution framework.", + "$ref": "#/definitions/DistributionType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "distributionType" + }, + "DistributionType": { + "description": "Enum to determine the job distribution type.", + "enum": [ + "PyTorch", + "TensorFlow", + "Mpi" + ], + "type": "string", + "x-ms-enum": { + "name": "DistributionType", + "modelAsString": true, + "values": [ + { + "value": "PyTorch" + }, + { + "value": "TensorFlow" + }, + { + "value": "Mpi" + } + ] + }, + "additionalProperties": false + }, + "DockerCredential": { + "description": "Credential for docker with username and password", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataReferenceCredential" + } + ], + "properties": { + "password": { + "description": "DockerCredential user password", + "type": "string", + "x-nullable": true + }, + "userName": { + "description": "DockerCredential user name", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "DockerCredentials", + "additionalProperties": false + }, + "EarlyTerminationPolicy": { + "description": "Early termination policies enable canceling poor-performing runs before they complete", + "required": [ + "policyType" + ], + "type": "object", + "properties": { + "delayEvaluation": { + "format": "int32", + "description": "Number of intervals by which to delay the first evaluation.", + "default": 0, + "type": "integer" + }, + "evaluationInterval": { + "format": "int32", + "description": "Interval (number of runs) between policy evaluations.", + "default": 0, + "type": "integer" + }, + "policyType": { + "description": "[Required] Name of policy configuration", + "$ref": "#/definitions/EarlyTerminationPolicyType" + } + }, + "discriminator": "policyType" + }, + "EarlyTerminationPolicyType": { + "enum": [ + "Bandit", + "MedianStopping", + "TruncationSelection" + ], + "type": "string", + "x-ms-enum": { + "name": "EarlyTerminationPolicyType", + "modelAsString": true, + "values": [ + { + "value": "Bandit" + }, + { + "value": "MedianStopping" + }, + { + "value": "TruncationSelection" + } + ] + }, + "additionalProperties": false + }, + "EgressPublicNetworkAccessType": { + "description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled for egress of a deployment.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EgressPublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "EmailNotificationEnableType": { + "description": "Enum to determine the email notification type.", + "enum": [ + "JobCompleted", + "JobFailed", + "JobCancelled" + ], + "type": "string", + "x-ms-enum": { + "name": "EmailNotificationEnableType", + "modelAsString": true, + "values": [ + { + "value": "JobCompleted" + }, + { + "value": "JobFailed" + }, + { + "value": "JobCancelled" + } + ] + }, + "additionalProperties": false + }, + "EndpointAuthKeys": { + "description": "Keys for endpoint authentication.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary key.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "secondaryKey": { + "description": "The secondary key.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointAuthMode": { + "description": "Enum to determine endpoint authentication mode.", + "enum": [ + "AMLToken", + "Key", + "AADToken" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointAuthMode", + "modelAsString": true, + "values": [ + { + "value": "AMLToken" + }, + { + "value": "Key" + }, + { + "value": "AADToken" + } + ] + }, + "additionalProperties": false + }, + "EndpointAuthToken": { + "description": "Service Token", + "type": "object", + "properties": { + "accessToken": { + "description": "Access token for endpoint authentication.", + "type": "string", + "x-nullable": true + }, + "expiryTimeUtc": { + "format": "int64", + "description": "Access token expiry time (UTC).", + "default": 0, + "type": "integer" + }, + "refreshAfterTimeUtc": { + "format": "int64", + "description": "Refresh access token after time (UTC).", + "default": 0, + "type": "integer" + }, + "tokenType": { + "description": "Access token type.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointComputeType": { + "description": "Enum to determine endpoint compute type.", + "enum": [ + "Managed", + "Kubernetes", + "AzureMLCompute" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointComputeType", + "modelAsString": true, + "values": [ + { + "value": "Managed" + }, + { + "value": "Kubernetes" + }, + { + "value": "AzureMLCompute" + } + ] + }, + "additionalProperties": false + }, + "EndpointDeploymentPropertiesBase": { + "description": "Base definition for endpoint deployment.", + "type": "object", + "properties": { + "codeConfiguration": { + "description": "Code configuration for the endpoint deployment.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + }, + "description": { + "description": "Description of the endpoint deployment.", + "type": "string", + "x-nullable": true + }, + "environmentId": { + "description": "ARM resource ID or AssetId of the environment specification for the endpoint deployment.", + "type": "string", + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables configuration for the deployment.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointPropertiesBase": { + "description": "Inference Endpoint base definition", + "required": [ + "authMode" + ], + "type": "object", + "properties": { + "authMode": { + "description": "[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.", + "$ref": "#/definitions/EndpointAuthMode" + }, + "description": { + "description": "Description of the inference endpoint.", + "type": "string", + "x-nullable": true + }, + "keys": { + "description": "EndpointAuthKeys to set initially on an Endpoint.\r\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.", + "$ref": "#/definitions/EndpointAuthKeys", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true, + "x-nullable": true + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "scoringUri": { + "format": "uri", + "description": "Endpoint URI.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "swaggerUri": { + "format": "uri", + "description": "Endpoint Swagger URI.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointProvisioningState": { + "description": "State of endpoint provisioning.", + "enum": [ + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Updating", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Updating" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "EndpointScheduleAction": { + "required": [ + "actionType", + "endpointInvocationDefinition" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], + "properties": { + "endpointInvocationDefinition": { + "description": "[Required] Defines Schedule action definition details.\r\n", + "type": "object", + "example": { + "endpoint": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/batchEndpoints/hello-pipeline", + "inputs": { + "create_time": "${{creation_context.trigger_time}}" + } + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-discriminator-value": "InvokeBatchEndpoint", + "additionalProperties": false + }, + "EnvironmentContainer": { + "description": "Container for environment specification versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the environment container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "EnvironmentContainerProperties", + "additionalProperties": false + }, + "EnvironmentContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/EnvironmentContainer" + } + }, + "x-ms-client-name": "EnvironmentContainer", + "additionalProperties": false + }, + "EnvironmentContainerResourceArmPaginatedResult": { + "description": "A paginated list of EnvironmentContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type EnvironmentContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + } + }, + "additionalProperties": false + }, + "EnvironmentType": { + "description": "Environment type is either user created or curated by Azure ML service", + "enum": [ + "Curated", + "UserCreated" + ], + "type": "string", + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true, + "values": [ + { + "value": "Curated" + }, + { + "value": "UserCreated" + } + ] + }, + "additionalProperties": false + }, + "EnvironmentVersion": { + "description": "Environment version details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "autoRebuild": { + "description": "Defines if image needs to be rebuilt based on base image changes.", + "default": "Disabled", + "$ref": "#/definitions/AutoRebuildSetting", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "build": { + "description": "Configuration settings for Docker build context.", + "$ref": "#/definitions/BuildContext", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "condaFile": { + "description": "Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.\r\n", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentType": { + "description": "Environment type is either user managed or curated by the Azure ML service\r\n", + "$ref": "#/definitions/EnvironmentType", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "image": { + "description": "Name of the image that will be used for the environment.\r\n", + "type": "string", + "example": "docker.io/tensorflow/serving:latest", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "inferenceConfig": { + "description": "Defines configuration specific to inference.", + "$ref": "#/definitions/InferenceContainerProperties", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "osType": { + "description": "The OS type of the environment.", + "default": "Linux", + "$ref": "#/definitions/OperatingSystemType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "provisioningState": { + "description": "Provisioning state for the environment version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "stage": { + "description": "Stage in the environment lifecycle assigned to this environment", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "EnvironmentVersionProperties", + "additionalProperties": false + }, + "EnvironmentVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/EnvironmentVersion" + } + }, + "x-ms-client-name": "EnvironmentVersion", + "additionalProperties": false + }, + "EnvironmentVersionResourceArmPaginatedResult": { + "description": "A paginated list of EnvironmentVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type EnvironmentVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + }, + "additionalProperties": false + }, + "Feature": { + "description": "DTO object representing feature", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "dataType": { + "description": "Specifies type", + "default": "String", + "$ref": "#/definitions/FeatureDataType" + }, + "featureName": { + "description": "Specifies name", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "FeatureProperties", + "additionalProperties": false + }, + "FeatureAttributionDriftMonitoringSignal": { + "required": [ + "featureImportanceSettings", + "metricThreshold", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "featureImportanceSettings": { + "description": "[Required] The settings for computing feature importance.", + "$ref": "#/definitions/FeatureImportanceSettings", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "metricThreshold": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "$ref": "#/definitions/FeatureAttributionMetricThreshold", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "productionData": { + "description": "[Required] The data which drift will be calculated for.", + "type": "array", + "items": { + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "FeatureAttributionDrift", + "additionalProperties": false + }, + "FeatureAttributionMetric": { + "enum": [ + "NormalizedDiscountedCumulativeGain" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureAttributionMetric", + "modelAsString": true, + "values": [ + { + "value": "NormalizedDiscountedCumulativeGain", + "description": "The Normalized Discounted Cumulative Gain metric." + } + ] + }, + "additionalProperties": false + }, + "FeatureAttributionMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "properties": { + "metric": { + "description": "[Required] The feature attribution metric to calculate.", + "$ref": "#/definitions/FeatureAttributionMetric", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FeatureDataType": { + "enum": [ + "String", + "Integer", + "Long", + "Float", + "Double", + "Binary", + "Datetime", + "Boolean" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureDataType", + "modelAsString": true, + "values": [ + { + "value": "String" + }, + { + "value": "Integer" + }, + { + "value": "Long" + }, + { + "value": "Float" + }, + { + "value": "Double" + }, + { + "value": "Binary" + }, + { + "value": "Datetime" + }, + { + "value": "Boolean" + } + ] + }, + "additionalProperties": false + }, + "FeatureImportanceMode": { + "description": "The mode of operation for computing feature importance.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureImportanceMode", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "Disables computing feature importance within a signal." + }, + { + "value": "Enabled", + "description": "Enables computing feature importance within a signal." + } + ] + }, + "additionalProperties": false + }, + "FeatureImportanceSettings": { + "type": "object", + "properties": { + "mode": { + "description": "The mode of operation for computing feature importance.", + "default": "Disabled", + "$ref": "#/definitions/FeatureImportanceMode" + }, + "targetColumn": { + "description": "The name of the target column within the input data asset.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FeatureLags": { + "description": "Flag for generating lags for the numeric features.", + "enum": [ + "None", + "Auto" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureLags", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No feature lags generated." + }, + { + "value": "Auto", + "description": "System auto-generates feature lags." + } + ] + }, + "additionalProperties": false + }, + "FeatureResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Feature" + } + }, + "x-ms-client-name": "Feature", + "additionalProperties": false + }, + "FeatureResourceArmPaginatedResult": { + "description": "A paginated list of Feature entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Feature objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Feature.", + "type": "array", + "items": { + "$ref": "#/definitions/FeatureResource" + } + } + }, + "additionalProperties": false + }, + "FeatureSubset": { + "required": [ + "features", + "filterType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringFeatureFilterBase" + } + ], + "properties": { + "features": { + "description": "[Required] The list of features to include.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "FeatureSubset", + "additionalProperties": false + }, + "FeatureWindow": { + "description": "Specifies the feature window", + "type": "object", + "properties": { + "featureWindowEnd": { + "format": "date-time", + "description": "Specifies the feature window end time", + "type": "string", + "x-nullable": true + }, + "featureWindowStart": { + "format": "date-time", + "description": "Specifies the feature window start time", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FeaturesetContainer": { + "description": "DTO object representing feature set", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the featureset container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "FeaturesetContainerProperties", + "additionalProperties": false + }, + "FeaturesetContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturesetContainer" + } + }, + "x-ms-client-name": "FeaturesetContainer", + "additionalProperties": false + }, + "FeaturesetContainerResourceArmPaginatedResult": { + "description": "A paginated list of FeaturesetContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturesetContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturesetContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + } + }, + "additionalProperties": false + }, + "FeaturesetSpecification": { + "description": "DTO object representing specification", + "type": "object", + "properties": { + "path": { + "description": "Specifies the spec path", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FeaturesetVersion": { + "description": "DTO object representing feature set version", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "entities": { + "description": "Specifies list of entities", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "materializationSettings": { + "description": "Specifies the materialization settings", + "$ref": "#/definitions/MaterializationSettings", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the featureset version container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "specification": { + "description": "Specifies the feature spec details", + "$ref": "#/definitions/FeaturesetSpecification", + "x-nullable": true + }, + "stage": { + "description": "Specifies the asset stage", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "FeaturesetVersionProperties", + "additionalProperties": false + }, + "FeaturesetVersionBackfillRequest": { + "description": "Request payload for creating a backfill request for a given feature set version", + "type": "object", + "properties": { + "dataAvailabilityStatus": { + "description": "Specified the data availability status that you want to backfill", + "type": "array", + "items": { + "$ref": "#/definitions/DataAvailabilityStatus" + } + }, + "description": { + "description": "Specifies description", + "type": "string" + }, + "displayName": { + "description": "Specifies description", + "type": "string" + }, + "featureWindow": { + "description": "Specifies the backfill feature window to be materialized", + "$ref": "#/definitions/FeatureWindow", + "x-nullable": true + }, + "jobId": { + "description": "Specify the jobId to retry the failed materialization", + "type": "string" + }, + "properties": { + "description": "Specifies the properties", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + }, + "resource": { + "description": "Specifies the compute resource settings", + "$ref": "#/definitions/MaterializationComputeResource" + }, + "sparkConfiguration": { + "description": "Specifies the spark compute settings", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + }, + "tags": { + "description": "Specifies the tags", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "FeaturesetVersionBackfillResponse": { + "description": "Response payload for creating a backfill request for a given feature set version", + "type": "object", + "properties": { + "jobIds": { + "description": "List of jobs submitted as part of the backfill request.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FeaturesetVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturesetVersion" + } + }, + "x-ms-client-name": "FeaturesetVersion", + "additionalProperties": false + }, + "FeaturesetVersionResourceArmPaginatedResult": { + "description": "A paginated list of FeaturesetVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturesetVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturesetVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturesetVersionResource" + } + } + }, + "additionalProperties": false + }, + "FeaturestoreEntityContainer": { + "description": "DTO object representing feature entity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the featurestore entity container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "FeaturestoreEntityContainerProperties", + "additionalProperties": false + }, + "FeaturestoreEntityContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturestoreEntityContainer" + } + }, + "x-ms-client-name": "FeaturestoreEntityContainer", + "additionalProperties": false + }, + "FeaturestoreEntityContainerResourceArmPaginatedResult": { + "description": "A paginated list of FeaturestoreEntityContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturestoreEntityContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturestoreEntityContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } + } + }, + "additionalProperties": false + }, + "FeaturestoreEntityVersion": { + "description": "DTO object representing feature entity version", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "indexColumns": { + "description": "Specifies index columns", + "type": "array", + "items": { + "$ref": "#/definitions/IndexColumn" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "provisioningState": { + "description": "Provisioning state for the featurestore entity version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "stage": { + "description": "Specifies the asset stage", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "FeaturestoreEntityVersionProperties", + "additionalProperties": false + }, + "FeaturestoreEntityVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturestoreEntityVersion" + } + }, + "x-ms-client-name": "FeaturestoreEntityVersion", + "additionalProperties": false + }, + "FeaturestoreEntityVersionResourceArmPaginatedResult": { + "description": "A paginated list of FeaturestoreEntityVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturestoreEntityVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturestoreEntityVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } + } + }, + "additionalProperties": false + }, + "FeaturizationMode": { + "description": "Featurization mode - determines data featurization mode.", + "enum": [ + "Auto", + "Custom", + "Off" + ], + "type": "string", + "x-ms-enum": { + "name": "FeaturizationMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Auto mode, system performs featurization without any custom featurization inputs." + }, + { + "value": "Custom", + "description": "Custom featurization." + }, + { + "value": "Off", + "description": "Featurization off. 'Forecasting' task cannot use this value." + } + ] + }, + "additionalProperties": false + }, + "FeaturizationSettings": { + "description": "Featurization Configuration.", + "type": "object", + "properties": { + "datasetLanguage": { + "description": "Dataset language, useful for the text data.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FixedInputData": { + "description": "Fixed input data definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringInputDataBase" + } + ], + "x-ms-discriminator-value": "Fixed", + "additionalProperties": false + }, + "FlavorData": { + "type": "object", + "properties": { + "data": { + "description": "Model flavor-specific data.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ForecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Set forecast horizon value selection mode.", + "$ref": "#/definitions/ForecastHorizonMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "ForecastHorizonMode": { + "description": "Enum to determine forecast horizon selection mode.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ForecastHorizonMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Forecast horizon to be determined automatically." + }, + { + "value": "Custom", + "description": "Use the custom forecast horizon." + } + ] + }, + "additionalProperties": false + }, + "Forecasting": { + "description": "Forecasting task in AutoML Table vertical.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TableVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "forecastingSettings": { + "description": "Forecasting task specific inputs.", + "$ref": "#/definitions/ForecastingSettings", + "x-nullable": true + }, + "primaryMetric": { + "description": "Primary metric for forecasting task.", + "default": "NormalizedRootMeanSquaredError", + "$ref": "#/definitions/ForecastingPrimaryMetrics" + }, + "trainingSettings": { + "description": "Inputs for training phase for an AutoML Job.", + "$ref": "#/definitions/ForecastingTrainingSettings", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Forecasting", + "additionalProperties": false + }, + "ForecastingModels": { + "description": "Enum for all forecasting models supported by AutoML.", + "enum": [ + "AutoArima", + "Prophet", + "Naive", + "SeasonalNaive", + "Average", + "SeasonalAverage", + "ExponentialSmoothing", + "Arimax", + "TCNForecaster", + "ElasticNet", + "GradientBoosting", + "DecisionTree", + "KNN", + "LassoLars", + "SGD", + "RandomForest", + "ExtremeRandomTrees", + "LightGBM", + "XGBoostRegressor" + ], + "type": "string", + "x-ms-enum": { + "name": "ForecastingModels", + "modelAsString": true, + "values": [ + { + "value": "AutoArima", + "description": "Auto-Autoregressive Integrated Moving Average (ARIMA) model uses time-series data and statistical analysis to interpret the data and make future predictions.\nThis model aims to explain data by using time series data on its past values and uses linear regression to make predictions." + }, + { + "value": "Prophet", + "description": "Prophet is a procedure for forecasting time series data based on an additive model where non-linear trends are fit with yearly, weekly, and daily seasonality, plus holiday effects.\nIt works best with time series that have strong seasonal effects and several seasons of historical data. Prophet is robust to missing data and shifts in the trend, and typically handles outliers well." + }, + { + "value": "Naive", + "description": "The Naive forecasting model makes predictions by carrying forward the latest target value for each time-series in the training data." + }, + { + "value": "SeasonalNaive", + "description": "The Seasonal Naive forecasting model makes predictions by carrying forward the latest season of target values for each time-series in the training data." + }, + { + "value": "Average", + "description": "The Average forecasting model makes predictions by carrying forward the average of the target values for each time-series in the training data." + }, + { + "value": "SeasonalAverage", + "description": "The Seasonal Average forecasting model makes predictions by carrying forward the average value of the latest season of data for each time-series in the training data." + }, + { + "value": "ExponentialSmoothing", + "description": "Exponential smoothing is a time series forecasting method for univariate data that can be extended to support data with a systematic trend or seasonal component." + }, + { + "value": "Arimax", + "description": "An Autoregressive Integrated Moving Average with Explanatory Variable (ARIMAX) model can be viewed as a multiple regression model with one or more autoregressive (AR) terms and/or one or more moving average (MA) terms.\nThis method is suitable for forecasting when data is stationary/non stationary, and multivariate with any type of data pattern, i.e., level/trend /seasonality/cyclicity." + }, + { + "value": "TCNForecaster", + "description": "TCNForecaster: Temporal Convolutional Networks Forecaster. //TODO: Ask forecasting team for brief intro." + }, + { + "value": "ElasticNet", + "description": "Elastic net is a popular type of regularized linear regression that combines two popular penalties, specifically the L1 and L2 penalty functions." + }, + { + "value": "GradientBoosting", + "description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution." + }, + { + "value": "DecisionTree", + "description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features." + }, + { + "value": "KNN", + "description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set." + }, + { + "value": "LassoLars", + "description": "Lasso model fit with Least Angle Regression a.k.a. Lars. It is a Linear Model trained with an L1 prior as regularizer." + }, + { + "value": "SGD", + "description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs.\nIt's an inexact but powerful technique." + }, + { + "value": "RandomForest", + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the \"bagging\" method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + }, + { + "value": "ExtremeRandomTrees", + "description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm." + }, + { + "value": "LightGBM", + "description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms." + }, + { + "value": "XGBoostRegressor", + "description": "XGBoostRegressor: Extreme Gradient Boosting Regressor is a supervised machine learning model using ensemble of base learners." + } + ] + }, + "additionalProperties": false + }, + "ForecastingPrimaryMetrics": { + "description": "Primary metrics for Forecasting task.", + "enum": [ + "SpearmanCorrelation", + "NormalizedRootMeanSquaredError", + "R2Score", + "NormalizedMeanAbsoluteError" + ], + "type": "string", + "x-ms-enum": { + "name": "ForecastingPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "SpearmanCorrelation", + "description": "The Spearman's rank coefficient of correlation is a non-parametric measure of rank correlation." + }, + { + "value": "NormalizedRootMeanSquaredError", + "description": "The Normalized Root Mean Squared Error (NRMSE) the RMSE facilitates the comparison between models with different scales." + }, + { + "value": "R2Score", + "description": "The R2 score is one of the performance evaluation measures for forecasting-based machine learning models." + }, + { + "value": "NormalizedMeanAbsoluteError", + "description": "The Normalized Mean Absolute Error (NMAE) is a validation metric to compare the Mean Absolute Error (MAE) of (time) series with different scales." + } + ] + }, + "additionalProperties": false + }, + "ForecastingSettings": { + "description": "Forecasting specific parameters.", + "type": "object", + "properties": { + "countryOrRegionForHolidays": { + "description": "Country or region for holidays for forecasting tasks.\r\nThese should be ISO 3166 two-letter country/region codes, for example 'US' or 'GB'.", + "type": "string", + "x-nullable": true + }, + "cvStepSize": { + "format": "int32", + "description": "Number of periods between the origin time of one CV fold and the next fold. For\r\nexample, if `CVStepSize` = 3 for daily data, the origin time for each fold will be\r\nthree days apart.", + "type": "integer", + "x-nullable": true + }, + "featureLags": { + "description": "Flag for generating lags for the numeric features with 'auto' or null.", + "default": "None", + "$ref": "#/definitions/FeatureLags" + }, + "forecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", + "default": "{\"Mode\": \"Custom\", \"Value\": 1}", + "$ref": "#/definitions/ForecastHorizon" + }, + "frequency": { + "description": "When forecasting, this parameter represents the period with which the forecast is desired, for example daily, weekly, yearly, etc. The forecast frequency is dataset frequency by default.", + "type": "string", + "x-nullable": true + }, + "seasonality": { + "description": "Set time series seasonality as an integer multiple of the series frequency.\r\nIf seasonality is set to 'auto', it will be inferred.", + "default": "{\"Mode\": \"Auto\"}", + "$ref": "#/definitions/Seasonality" + }, + "shortSeriesHandlingConfig": { + "description": "The parameter defining how if AutoML should handle short time series.", + "default": "Auto", + "$ref": "#/definitions/ShortSeriesHandlingConfiguration" + }, + "targetAggregateFunction": { + "description": "The function to be used to aggregate the time series target column to conform to a user specified frequency.\r\nIf the TargetAggregateFunction is set i.e. not 'None', but the freq parameter is not set, the error is raised. The possible target aggregation functions are: \"sum\", \"max\", \"min\" and \"mean\".", + "default": "None", + "$ref": "#/definitions/TargetAggregationFunction" + }, + "targetLags": { + "description": "The number of past periods to lag from the target column.", + "$ref": "#/definitions/TargetLags", + "x-nullable": true + }, + "targetRollingWindowSize": { + "description": "The number of past periods used to create a rolling window average of the target column.", + "$ref": "#/definitions/TargetRollingWindowSize", + "x-nullable": true + }, + "timeColumnName": { + "description": "The name of the time column. This parameter is required when forecasting to specify the datetime column in the input data used for building the time series and inferring its frequency.", + "type": "string", + "x-nullable": true + }, + "timeSeriesIdColumnNames": { + "description": "The names of columns used to group a timeseries. It can be used to create multiple series.\r\nIf grain is not defined, the data set is assumed to be one time-series. This parameter is used with task type forecasting.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "useStl": { + "description": "Configure STL Decomposition of the time-series target column.", + "default": "None", + "$ref": "#/definitions/UseStl" + } + }, + "additionalProperties": false + }, + "ForecastingTrainingSettings": { + "description": "Forecasting Training related configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrainingSettings" + } + ], + "properties": { + "allowedTrainingAlgorithms": { + "description": "Allowed models for forecasting task.", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastingModels" + }, + "x-nullable": true + }, + "blockedTrainingAlgorithms": { + "description": "Blocked models for forecasting task.", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastingModels" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "GetBlobReferenceForConsumptionDto": { + "type": "object", + "properties": { + "blobUri": { + "format": "uri", + "description": "Blob uri, example: https://blob.windows.core.net/Container/Path", + "type": "string", + "x-nullable": true + }, + "credential": { + "description": "Credential info to access storage account", + "$ref": "#/definitions/DataReferenceCredential", + "x-nullable": true + }, + "storageAccountArmId": { + "description": "The ARM id of the storage account", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "GetBlobReferenceSASRequestDto": { + "description": "BlobReferenceSASRequest for getBlobReferenceSAS API", + "type": "object", + "properties": { + "assetId": { + "description": "Id of the asset to be accessed", + "type": "string", + "x-nullable": true + }, + "blobUri": { + "format": "uri", + "description": "Blob uri of the asset to be accessed", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "GetBlobReferenceSASResponseDto": { + "description": "BlobReferenceSASResponse for getBlobReferenceSAS API", + "type": "object", + "properties": { + "blobReferenceForConsumption": { + "description": "Blob reference for consumption details", + "$ref": "#/definitions/GetBlobReferenceForConsumptionDto", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "Goal": { + "description": "Defines supported metric goals for hyperparameter tuning", + "enum": [ + "Minimize", + "Maximize" + ], + "type": "string", + "x-ms-enum": { + "name": "Goal", + "modelAsString": true, + "values": [ + { + "value": "Minimize" + }, + { + "value": "Maximize" + } + ] + }, + "additionalProperties": false + }, + "GridSamplingAlgorithm": { + "description": "Defines a Sampling Algorithm that exhaustively generates every value combination in the space", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SamplingAlgorithm" + } + ], + "x-ms-discriminator-value": "Grid", + "additionalProperties": false + }, + "IdAssetReference": { + "description": "Reference to an asset via its ARM resource ID.", + "required": [ + "assetId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "assetId": { + "description": "[Required] ARM resource ID of the asset.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "Id", + "additionalProperties": false + }, + "IdentityConfiguration": { + "description": "Base definition for identity configuration.", + "required": [ + "identityType" + ], + "type": "object", + "properties": { + "identityType": { + "description": "[Required] Specifies the type of identity framework.", + "$ref": "#/definitions/IdentityConfigurationType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "identityType" + }, + "IdentityConfigurationType": { + "description": "Enum to determine identity framework.", + "enum": [ + "Managed", + "AMLToken", + "UserIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "IdentityConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Managed" + }, + { + "value": "AMLToken" + }, + { + "value": "UserIdentity" + } + ] + }, + "additionalProperties": false + }, + "ImageClassification": { + "description": "Image Classification. Multi-class image classification is used when an image is classified with only a single label\r\nfrom a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageClassificationBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "Accuracy", + "$ref": "#/definitions/ClassificationPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageClassification", + "additionalProperties": false + }, + "ImageClassificationBase": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageVertical" + } + ], + "properties": { + "modelSettings": { + "description": "Settings used for training the model.", + "$ref": "#/definitions/ImageModelSettingsClassification", + "x-nullable": true + }, + "searchSpace": { + "description": "Search space for sampling different combinations of models and their hyperparameters.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageModelDistributionSettingsClassification" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "ImageClassificationMultilabel": { + "description": "Image Classification Multilabel. Multi-label image classification is used when an image could have one or more labels\r\nfrom a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageClassificationBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "IOU", + "$ref": "#/definitions/ClassificationMultilabelPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageClassificationMultilabel", + "additionalProperties": false + }, + "ImageInstanceSegmentation": { + "description": "Image Instance Segmentation. Instance segmentation is used to identify objects in an image at the pixel level,\r\ndrawing a polygon around each object in the image.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageObjectDetectionBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "MeanAveragePrecision", + "$ref": "#/definitions/InstanceSegmentationPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageInstanceSegmentation", + "additionalProperties": false + }, + "ImageLimitSettings": { + "description": "Limit settings for the AutoML job.", + "type": "object", + "properties": { + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum number of concurrent AutoML iterations.", + "default": 1, + "type": "integer" + }, + "maxTrials": { + "format": "int32", + "description": "Maximum number of AutoML iterations.", + "default": 1, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "P7D", + "type": "string" + } + }, + "additionalProperties": false + }, + "ImageModelDistributionSettings": { + "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n```\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n```\r\nAll distributions can be specified as distribution_name(min, max) or choice(val1, val2, ..., valn)\r\nwhere distribution name can be: uniform, quniform, loguniform, etc\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "properties": { + "amsGradient": { + "description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "augmentations": { + "description": "Settings for using Augmentations.", + "type": "string", + "example": "choice('hflip;mosaic;random_crop', 'mosaic')", + "x-nullable": true + }, + "beta1": { + "description": "Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + }, + "beta2": { + "description": "Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + }, + "distributed": { + "description": "Whether to use distributer training.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "earlyStopping": { + "description": "Enable early stopping logic during training.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "earlyStoppingDelay": { + "description": "Minimum number of epochs or validation evaluations to wait before primary metric improvement\r\nis tracked for early stopping. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "earlyStoppingPatience": { + "description": "Minimum number of epochs or validation evaluations with no primary metric improvement before\r\nthe run is stopped. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "enableOnnxNormalization": { + "description": "Enable normalization when exporting ONNX model.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "evaluationFrequency": { + "description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "gradientAccumulationStep": { + "description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\r\nupdating the model weights while accumulating the gradients of those steps, and then using\r\nthe accumulated gradients to compute the weight updates. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "layersToFreeze": { + "description": "Number of layers to freeze for the model. Must be a positive integer.\r\nFor instance, passing 2 as value for 'seresnext' means\r\nfreezing layer0 and layer1. For a full list of models supported and details on layer freeze, please\r\nsee: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "string", + "example": "choice(1, 2)", + "x-nullable": true + }, + "learningRate": { + "description": "Initial learning rate. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0.0005, 0.005)", + "x-nullable": true + }, + "learningRateScheduler": { + "description": "Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.", + "type": "string", + "example": "choice('warmup_cosine', 'step')", + "x-nullable": true + }, + "modelName": { + "description": "Name of the model to use for training.\r\nFor more information on the available models please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "string", + "example": "choice('seresnext', 'resnest50')", + "x-nullable": true + }, + "momentum": { + "description": "Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].", + "type": "string", + "example": "quniform(0, 1)", + "x-nullable": true + }, + "nesterov": { + "description": "Enable nesterov when optimizer is 'sgd'.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "numberOfEpochs": { + "description": "Number of training epochs. Must be a positive integer.", + "type": "string", + "example": "choice(15, 30)", + "x-nullable": true + }, + "numberOfWorkers": { + "description": "Number of data loader workers. Must be a non-negative integer.", + "type": "string", + "example": "uniform(8, 16)", + "x-nullable": true + }, + "optimizer": { + "description": "Type of optimizer. Must be either 'sgd', 'adam', or 'adamw'.", + "type": "string", + "example": "choice('sgd', 'adam', 'adamw')", + "x-nullable": true + }, + "randomSeed": { + "description": "Random seed to be used when using deterministic training.", + "type": "string", + "example": "loguniform(0, 1)", + "x-nullable": true + }, + "stepLRGamma": { + "description": "Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].", + "type": "string", + "example": "choice(0.1, 0.2, 0.25)", + "x-nullable": true + }, + "stepLRStepSize": { + "description": "Value of step size when learning rate scheduler is 'step'. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "trainingBatchSize": { + "description": "Training batch size. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "validationBatchSize": { + "description": "Validation batch size. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "warmupCosineLRCycles": { + "description": "Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + }, + "warmupCosineLRWarmupEpochs": { + "description": "Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "weightDecay": { + "description": "Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelDistributionSettingsClassification": { + "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n```\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n```\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageModelDistributionSettings" + } + ], + "properties": { + "trainingCropSize": { + "description": "Image crop size that is input to the neural network for the training dataset. Must be a positive integer.", + "type": "string", + "example": "choice(224, 360)", + "x-nullable": true + }, + "validationCropSize": { + "description": "Image crop size that is input to the neural network for the validation dataset. Must be a positive integer.", + "type": "string", + "example": "choice(224, 360)", + "x-nullable": true + }, + "validationResizeSize": { + "description": "Image size to which to resize before cropping for validation dataset. Must be a positive integer.", + "type": "string", + "example": "choice(128, 256)", + "x-nullable": true + }, + "weightedLoss": { + "description": "Weighted loss. The accepted values are 0 for no weighted loss.\r\n1 for weighted loss with sqrt.(class_weights). 2 for weighted loss with class_weights. Must be 0 or 1 or 2.", + "type": "string", + "example": "choice(0, 1, 2)", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelDistributionSettingsObjectDetection": { + "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n```\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n```\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageModelDistributionSettings" + } + ], + "properties": { + "boxDetectionsPerImage": { + "description": "Maximum number of detections per image, for all classes. Must be a positive integer.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(50, 100)", + "x-nullable": true + }, + "boxScoreThreshold": { + "description": "During inference, only return proposals with a classification score greater than\r\nBoxScoreThreshold. Must be a float in the range[0, 1].", + "type": "string", + "example": "uniform(0.1, 0.2)", + "x-nullable": true + }, + "imageSize": { + "description": "Image size for train and validation. Must be a positive integer.\r\nNote: The training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(224, 640)", + "x-nullable": true + }, + "maxSize": { + "description": "Maximum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(640, 1333)", + "x-nullable": true + }, + "minSize": { + "description": "Minimum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(300, 600)", + "x-nullable": true + }, + "modelSize": { + "description": "Model size. Must be 'small', 'medium', 'large', or 'xlarge'.\r\nNote: training run may get into CUDA OOM if the model size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice('small', 'medium', 'large', 'xlarge')", + "x-nullable": true + }, + "multiScale": { + "description": "Enable multi-scale image by varying image size by +/- 50%.\r\nNote: training run may get into CUDA OOM if no sufficient GPU memory.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "nmsIouThreshold": { + "description": "IOU threshold used during inference in NMS post processing. Must be float in the range [0, 1].", + "type": "string", + "example": "uniform(0.1, 0.2)", + "x-nullable": true + }, + "tileGridSize": { + "description": "The grid size to use for tiling each image. Note: TileGridSize must not be\r\nNone to enable small object detection logic. A string containing two integers in mxn format.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice('3x2', '2x2')", + "x-nullable": true + }, + "tileOverlapRatio": { + "description": "Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1).\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "uniform(0.1, 0.2)", + "x-nullable": true + }, + "tilePredictionsNmsThreshold": { + "description": "The IOU threshold to use to perform NMS while merging predictions from tiles and image.\r\nUsed in validation/ inference. Must be float in the range [0, 1].\r\nNote: This settings is not supported for the 'yolov5' algorithm.\r\nNMS: Non-maximum suppression", + "type": "string", + "example": "uniform(0.2, 0.3)", + "x-nullable": true + }, + "validationIouThreshold": { + "description": "IOU threshold to use when computing validation metric. Must be float in the range [0, 1].", + "type": "string", + "example": "uniform(0.2, 0.3)", + "x-nullable": true + }, + "validationMetricType": { + "description": "Metric computation method to use for validation metrics. Must be 'none', 'coco', 'voc', or 'coco_voc'.", + "type": "string", + "example": "choice('none', 'coco', 'voc', 'coco_voc')", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelSettings": { + "description": "Settings used for training the model.\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "properties": { + "advancedSettings": { + "description": "Settings for advanced scenarios.", + "type": "string", + "example": "key1:val1;key2;key3:val3;key4", + "x-nullable": true + }, + "amsGradient": { + "description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.", + "type": "boolean", + "x-nullable": true + }, + "augmentations": { + "description": "Settings for using Augmentations.", + "type": "string", + "example": "hflip;mosaic;random_crop", + "x-nullable": true + }, + "beta1": { + "format": "float", + "description": "Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "beta2": { + "format": "float", + "description": "Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "checkpointFrequency": { + "format": "int32", + "description": "Frequency to store model checkpoints. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "checkpointModel": { + "description": "The pretrained checkpoint model for incremental training.", + "$ref": "#/definitions/MLFlowModelJobInput", + "x-nullable": true + }, + "checkpointRunId": { + "description": "The id of a previous run that has a pretrained checkpoint for incremental training.", + "type": "string", + "x-nullable": true + }, + "distributed": { + "description": "Whether to use distributed training.", + "type": "boolean", + "x-nullable": true + }, + "earlyStopping": { + "description": "Enable early stopping logic during training.", + "type": "boolean", + "x-nullable": true + }, + "earlyStoppingDelay": { + "format": "int32", + "description": "Minimum number of epochs or validation evaluations to wait before primary metric improvement\r\nis tracked for early stopping. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "earlyStoppingPatience": { + "format": "int32", + "description": "Minimum number of epochs or validation evaluations with no primary metric improvement before\r\nthe run is stopped. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "enableOnnxNormalization": { + "description": "Enable normalization when exporting ONNX model.", + "type": "boolean", + "x-nullable": true + }, + "evaluationFrequency": { + "format": "int32", + "description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "gradientAccumulationStep": { + "format": "int32", + "description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\r\nupdating the model weights while accumulating the gradients of those steps, and then using\r\nthe accumulated gradients to compute the weight updates. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "layersToFreeze": { + "format": "int32", + "description": "Number of layers to freeze for the model. Must be a positive integer.\r\nFor instance, passing 2 as value for 'seresnext' means\r\nfreezing layer0 and layer1. For a full list of models supported and details on layer freeze, please\r\nsee: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "integer", + "x-nullable": true + }, + "learningRate": { + "format": "float", + "description": "Initial learning rate. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "learningRateScheduler": { + "description": "Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.", + "default": "None", + "$ref": "#/definitions/LearningRateScheduler" + }, + "modelName": { + "description": "Name of the model to use for training.\r\nFor more information on the available models please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "string", + "x-nullable": true + }, + "momentum": { + "format": "float", + "description": "Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "nesterov": { + "description": "Enable nesterov when optimizer is 'sgd'.", + "type": "boolean", + "x-nullable": true + }, + "numberOfEpochs": { + "format": "int32", + "description": "Number of training epochs. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "numberOfWorkers": { + "format": "int32", + "description": "Number of data loader workers. Must be a non-negative integer.", + "type": "integer", + "x-nullable": true + }, + "optimizer": { + "description": "Type of optimizer.", + "default": "None", + "$ref": "#/definitions/StochasticOptimizer" + }, + "randomSeed": { + "format": "int32", + "description": "Random seed to be used when using deterministic training.", + "type": "integer", + "x-nullable": true + }, + "stepLRGamma": { + "format": "float", + "description": "Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "stepLRStepSize": { + "format": "int32", + "description": "Value of step size when learning rate scheduler is 'step'. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "trainingBatchSize": { + "format": "int32", + "description": "Training batch size. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "validationBatchSize": { + "format": "int32", + "description": "Validation batch size. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "warmupCosineLRCycles": { + "format": "float", + "description": "Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "warmupCosineLRWarmupEpochs": { + "format": "int32", + "description": "Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "weightDecay": { + "format": "float", + "description": "Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].", + "type": "number", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelSettingsClassification": { + "description": "Settings used for training the model.\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageModelSettings" + } + ], + "properties": { + "trainingCropSize": { + "format": "int32", + "description": "Image crop size that is input to the neural network for the training dataset. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "validationCropSize": { + "format": "int32", + "description": "Image crop size that is input to the neural network for the validation dataset. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "validationResizeSize": { + "format": "int32", + "description": "Image size to which to resize before cropping for validation dataset. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "weightedLoss": { + "format": "int32", + "description": "Weighted loss. The accepted values are 0 for no weighted loss.\r\n1 for weighted loss with sqrt.(class_weights). 2 for weighted loss with class_weights. Must be 0 or 1 or 2.", + "type": "integer", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelSettingsObjectDetection": { + "description": "Settings used for training the model.\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageModelSettings" + } + ], + "properties": { + "boxDetectionsPerImage": { + "format": "int32", + "description": "Maximum number of detections per image, for all classes. Must be a positive integer.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "boxScoreThreshold": { + "format": "float", + "description": "During inference, only return proposals with a classification score greater than\r\nBoxScoreThreshold. Must be a float in the range[0, 1].", + "type": "number", + "x-nullable": true + }, + "imageSize": { + "format": "int32", + "description": "Image size for train and validation. Must be a positive integer.\r\nNote: The training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "maxSize": { + "format": "int32", + "description": "Maximum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "minSize": { + "format": "int32", + "description": "Minimum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "modelSize": { + "description": "Model size. Must be 'small', 'medium', 'large', or 'xlarge'.\r\nNote: training run may get into CUDA OOM if the model size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "default": "None", + "$ref": "#/definitions/ModelSize" + }, + "multiScale": { + "description": "Enable multi-scale image by varying image size by +/- 50%.\r\nNote: training run may get into CUDA OOM if no sufficient GPU memory.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "boolean", + "x-nullable": true + }, + "nmsIouThreshold": { + "format": "float", + "description": "IOU threshold used during inference in NMS post processing. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "tileGridSize": { + "description": "The grid size to use for tiling each image. Note: TileGridSize must not be\r\nNone to enable small object detection logic. A string containing two integers in mxn format.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "3x2", + "x-nullable": true + }, + "tileOverlapRatio": { + "format": "float", + "description": "Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1).\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "number", + "x-nullable": true + }, + "tilePredictionsNmsThreshold": { + "format": "float", + "description": "The IOU threshold to use to perform NMS while merging predictions from tiles and image.\r\nUsed in validation/ inference. Must be float in the range [0, 1].\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "number", + "x-nullable": true + }, + "validationIouThreshold": { + "format": "float", + "description": "IOU threshold to use when computing validation metric. Must be float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "validationMetricType": { + "description": "Metric computation method to use for validation metrics.", + "default": "None", + "$ref": "#/definitions/ValidationMetricType" + } + }, + "additionalProperties": false + }, + "ImageObjectDetection": { + "description": "Image Object Detection. Object detection is used to identify objects in an image and locate each object with a\r\nbounding box e.g. locate all dogs and cats in an image and draw a bounding box around each.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageObjectDetectionBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "MeanAveragePrecision", + "$ref": "#/definitions/ObjectDetectionPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageObjectDetection", + "additionalProperties": false + }, + "ImageObjectDetectionBase": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageVertical" + } + ], + "properties": { + "modelSettings": { + "description": "Settings used for training the model.", + "$ref": "#/definitions/ImageModelSettingsObjectDetection", + "x-nullable": true + }, + "searchSpace": { + "description": "Search space for sampling different combinations of models and their hyperparameters.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageModelDistributionSettingsObjectDetection" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "ImageSweepSettings": { + "description": "Model sweeping and hyperparameter sweeping related settings.", + "required": [ + "samplingAlgorithm" + ], + "type": "object", + "properties": { + "earlyTermination": { + "description": "Type of early termination policy.", + "$ref": "#/definitions/EarlyTerminationPolicy", + "x-nullable": true + }, + "samplingAlgorithm": { + "description": "[Required] Type of the hyperparameter sampling algorithms.", + "$ref": "#/definitions/SamplingAlgorithmType" + } + }, + "additionalProperties": false + }, + "ImageVertical": { + "description": "Abstract class for AutoML tasks that train image (computer vision) models -\r\nsuch as Image Classification / Image Classification Multilabel / Image Object Detection / Image Instance Segmentation.", + "required": [ + "limitSettings" + ], + "type": "object", + "properties": { + "limitSettings": { + "description": "[Required] Limit settings for the AutoML job.", + "$ref": "#/definitions/ImageLimitSettings" + }, + "sweepSettings": { + "description": "Model sweeping and hyperparameter sweeping related settings.", + "$ref": "#/definitions/ImageSweepSettings", + "x-nullable": true + }, + "validationData": { + "description": "Validation data inputs.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, + "validationDataSize": { + "format": "double", + "description": "The fraction of training dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "IndexColumn": { + "description": "DTO object representing index column", + "type": "object", + "properties": { + "columnName": { + "description": "Specifies the column name", + "type": "string", + "x-nullable": true + }, + "dataType": { + "description": "Specifies the data type", + "default": "String", + "$ref": "#/definitions/FeatureDataType" + } + }, + "additionalProperties": false + }, + "InferenceContainerProperties": { + "type": "object", + "properties": { + "livenessRoute": { + "description": "The route to check the liveness of the inference server container.", + "$ref": "#/definitions/Route" + }, + "readinessRoute": { + "description": "The route to check the readiness of the inference server container.", + "$ref": "#/definitions/Route" + }, + "scoringRoute": { + "description": "The port to send the scoring requests to, within the inference server container.", + "$ref": "#/definitions/Route" + } + }, + "additionalProperties": false + }, + "InputDeliveryMode": { + "description": "Enum to determine the input data delivery mode.", + "enum": [ + "ReadOnlyMount", + "ReadWriteMount", + "Download", + "Direct", + "EvalMount", + "EvalDownload" + ], + "type": "string", + "x-ms-enum": { + "name": "InputDeliveryMode", + "modelAsString": true, + "values": [ + { + "value": "ReadOnlyMount" + }, + { + "value": "ReadWriteMount" + }, + { + "value": "Download" + }, + { + "value": "Direct" + }, + { + "value": "EvalMount" + }, + { + "value": "EvalDownload" + } + ] + }, + "additionalProperties": false + }, + "InstanceSegmentationPrimaryMetrics": { + "description": "Primary metrics for InstanceSegmentation tasks.", + "enum": [ + "MeanAveragePrecision" + ], + "type": "string", + "x-ms-enum": { + "name": "InstanceSegmentationPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "MeanAveragePrecision", + "description": "Mean Average Precision (MAP) is the average of AP (Average Precision).\nAP is calculated for each class and averaged to get the MAP." + } + ] + }, + "additionalProperties": false + }, + "JobBase": { + "description": "Base definition for a job.", + "required": [ + "jobType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "componentId": { + "description": "ARM resource ID of the component resource.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "computeId": { + "description": "ARM resource ID of the compute resource.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "displayName": { + "description": "Display name of job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "experimentName": { + "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.", + "default": "Default", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "identity": { + "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null.\r\nDefaults to AmlToken if null.", + "$ref": "#/definitions/IdentityConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "isArchived": { + "description": "Is the asset archived?", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "jobType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "notificationSetting": { + "description": "Notification setting for the job", + "$ref": "#/definitions/NotificationSetting", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "services": { + "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/JobService", + "x-nullable": true + }, + "x-nullable": true + }, + "status": { + "description": "Status of the job.", + "$ref": "#/definitions/JobStatus", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "discriminator": "jobType", + "x-ms-client-name": "JobBaseProperties" + }, + "JobBaseResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/JobBase" + } + }, + "x-ms-client-name": "JobBase", + "additionalProperties": false + }, + "JobBaseResourceArmPaginatedResult": { + "description": "A paginated list of JobBase entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of JobBase objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type JobBase.", + "type": "array", + "items": { + "$ref": "#/definitions/JobBaseResource" + } + } + }, + "additionalProperties": false + }, + "JobInput": { + "description": "Command job definition.", + "required": [ + "jobInputType" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the input.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobInputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobInputType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "jobInputType" + }, + "JobInputType": { + "description": "Enum to determine the Job Input Type.", + "enum": [ + "literal", + "uri_file", + "uri_folder", + "mltable", + "custom_model", + "mlflow_model", + "triton_model" + ], + "type": "string", + "x-ms-enum": { + "name": "JobInputType", + "modelAsString": true, + "values": [ + { + "value": "literal" + }, + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + }, + { + "value": "custom_model" + }, + { + "value": "mlflow_model" + }, + { + "value": "triton_model" + } + ] + }, + "additionalProperties": false + }, + "JobLimits": { + "required": [ + "jobLimitsType" + ], + "type": "object", + "properties": { + "jobLimitsType": { + "description": "[Required] JobLimit type.", + "$ref": "#/definitions/JobLimitsType" + }, + "timeout": { + "format": "duration", + "description": "The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.", + "type": "string", + "x-nullable": true + } + }, + "discriminator": "jobLimitsType" + }, + "JobLimitsType": { + "enum": [ + "Command", + "Sweep" + ], + "type": "string", + "x-ms-enum": { + "name": "JobLimitsType", + "modelAsString": true, + "values": [ + { + "value": "Command" + }, + { + "value": "Sweep" + } + ] + }, + "additionalProperties": false + }, + "JobOutput": { + "description": "Job output definition container information on where to find job output/logs.", + "required": [ + "jobOutputType" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the output.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobOutputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobOutputType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "jobOutputType" + }, + "JobOutputType": { + "description": "Enum to determine the Job Output Type.", + "enum": [ + "uri_file", + "uri_folder", + "mltable", + "custom_model", + "mlflow_model", + "triton_model" + ], + "type": "string", + "x-ms-enum": { + "name": "JobOutputType", + "modelAsString": true, + "values": [ + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + }, + { + "value": "custom_model" + }, + { + "value": "mlflow_model" + }, + { + "value": "triton_model" + } + ] + }, + "additionalProperties": false + }, + "JobResourceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceConfiguration" + } + ], + "properties": { + "dockerArgs": { + "description": "Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "shmSize": { + "description": "Size of the docker container's shared memory block. This should be in the format of (number)(unit) where number as to be greater than 0 and the unit can be one of b(bytes), k(kilobytes), m(megabytes), or g(gigabytes).", + "default": "2g", + "pattern": "\\d+[bBkKmMgG]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "JobScheduleAction": { + "required": [ + "actionType", + "jobDefinition" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], + "properties": { + "jobDefinition": { + "description": "[Required] Defines Schedule action definition details.", + "$ref": "#/definitions/JobBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-discriminator-value": "CreateJob", + "additionalProperties": false + }, + "JobService": { + "description": "Job endpoint definition", + "type": "object", + "properties": { + "endpoint": { + "description": "Url for endpoint.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "errorMessage": { + "description": "Any error in the service.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "jobServiceType": { + "description": "Endpoint type.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "nodes": { + "description": "Nodes that user would like to start the service on.\r\nIf Nodes is not set or set to null, the service will only be started on leader node.", + "$ref": "#/definitions/Nodes", + "x-nullable": true + }, + "port": { + "format": "int32", + "description": "Port for endpoint.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "properties": { + "description": "Additional properties to set on the endpoint.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "status": { + "description": "Status of endpoint.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "JobStatus": { + "description": "The status of a job.", + "enum": [ + "NotStarted", + "Starting", + "Provisioning", + "Preparing", + "Queued", + "Running", + "Finalizing", + "CancelRequested", + "Completed", + "Failed", + "Canceled", + "NotResponding", + "Paused", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "Run hasn't started yet." + }, + { + "value": "Starting", + "description": "Run has started. The user has a run ID." + }, + { + "value": "Provisioning", + "description": "(Not used currently) It will be used if ES is creating the compute target." + }, + { + "value": "Preparing", + "description": "The run environment is being prepared." + }, + { + "value": "Queued", + "description": "The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting for all required nodes to be ready." + }, + { + "value": "Running", + "description": "The job started to run in the compute target." + }, + { + "value": "Finalizing", + "description": "Job is completed in the target. It is in output collection state now." + }, + { + "value": "CancelRequested", + "description": "Cancellation has been requested for the job." + }, + { + "value": "Completed", + "description": "Job completed successfully. This reflects that both the job itself and output collection states completed successfully" + }, + { + "value": "Failed", + "description": "Job failed." + }, + { + "value": "Canceled", + "description": "Following cancellation request, the job is now successfully canceled." + }, + { + "value": "NotResponding", + "description": "When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run goes to NotResponding state.\nNotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of the previous states." + }, + { + "value": "Paused", + "description": "The job is paused by users. Some adjustment to labeling jobs can be made only in paused state." + }, + { + "value": "Unknown", + "description": "Default job status if not mapped to all other statuses" + } + ] + }, + "additionalProperties": false + }, + "JobTier": { + "description": "Enum to determine the job tier.", + "enum": [ + "Null", + "Spot", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "JobTier", + "modelAsString": true, + "values": [ + { + "value": "Null" + }, + { + "value": "Spot" + }, + { + "value": "Basic" + }, + { + "value": "Standard" + }, + { + "value": "Premium" + } + ] + }, + "additionalProperties": false + }, + "JobType": { + "description": "Enum to determine the type of job.", + "enum": [ + "AutoML", + "Command", + "Sweep", + "Pipeline", + "Spark" + ], + "type": "string", + "x-ms-enum": { + "name": "JobType", + "modelAsString": true, + "values": [ + { + "value": "AutoML" + }, + { + "value": "Command" + }, + { + "value": "Sweep" + }, + { + "value": "Pipeline" + }, + { + "value": "Spark" + } + ] + }, + "additionalProperties": false + }, + "KeyType": { + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true, + "values": [ + { + "value": "Primary" + }, + { + "value": "Secondary" + } + ] + }, + "additionalProperties": false + }, + "KubernetesOnlineDeployment": { + "description": "Properties specific to a KubernetesOnlineDeployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineDeployment" + } + ], + "properties": { + "containerResourceRequirements": { + "description": "The resource requirements for the container (cpu and memory).", + "$ref": "#/definitions/ContainerResourceRequirements", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Kubernetes", + "additionalProperties": false + }, + "LakeHouseArtifact": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OneLakeArtifact" + } + ], + "x-ms-discriminator-value": "LakeHouse", + "additionalProperties": false + }, + "LearningRateScheduler": { + "description": "Learning rate scheduler enum.", + "enum": [ + "None", + "WarmupCosine", + "Step" + ], + "type": "string", + "x-ms-enum": { + "name": "LearningRateScheduler", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No learning rate scheduler selected." + }, + { + "value": "WarmupCosine", + "description": "Cosine Annealing With Warmup." + }, + { + "value": "Step", + "description": "Step learning rate scheduler." + } + ] + }, + "additionalProperties": false + }, + "ListViewType": { + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "type": "string", + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + }, + "additionalProperties": false + }, + "LiteralJobInput": { + "description": "Literal input type.", + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], + "properties": { + "value": { + "description": "[Required] Literal value for the input.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "literal", + "additionalProperties": false + }, + "LogVerbosity": { + "description": "Enum for setting log verbosity.", + "enum": [ + "NotSet", + "Debug", + "Info", + "Warning", + "Error", + "Critical" + ], + "type": "string", + "x-ms-enum": { + "name": "LogVerbosity", + "modelAsString": true, + "values": [ + { + "value": "NotSet", + "description": "No logs emitted." + }, + { + "value": "Debug", + "description": "Debug and above log statements logged." + }, + { + "value": "Info", + "description": "Info and above log statements logged." + }, + { + "value": "Warning", + "description": "Warning and above log statements logged." + }, + { + "value": "Error", + "description": "Error and above log statements logged." + }, + { + "value": "Critical", + "description": "Only critical statements logged." + } + ] + }, + "additionalProperties": false + }, + "MLFlowModelJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "mlflow_model", + "additionalProperties": false + }, + "MLFlowModelJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "mlflow_model", + "additionalProperties": false + }, + "MLTableData": { + "description": "MLTable data definition", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataVersionBase" + } + ], + "properties": { + "referencedUris": { + "description": "Uris referenced in the MLTable definition (required for lineage)", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "mltable", + "additionalProperties": false + }, + "MLTableJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "mltable", + "additionalProperties": false + }, + "MLTableJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "mltable", + "additionalProperties": false + }, + "ManagedComputeIdentity": { + "description": "Managed compute identity definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitorComputeIdentityBase" + } + ], + "properties": { + "identity": { + "description": "The identity which will be leveraged by the monitoring jobs.", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "ManagedIdentity", + "additionalProperties": false + }, + "ManagedIdentity": { + "description": "Managed identity configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IdentityConfiguration" + } + ], + "properties": { + "clientId": { + "format": "uuid", + "description": "Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "objectId": { + "format": "uuid", + "description": "Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resourceId": { + "description": "Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Managed", + "additionalProperties": false + }, + "ManagedIdentityCredential": { + "description": "Credential for user managed identity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataReferenceCredential" + } + ], + "properties": { + "managedIdentityType": { + "description": "ManagedIdentityCredential identity type", + "type": "string", + "x-nullable": true + }, + "userManagedIdentityClientId": { + "description": "ClientId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", + "type": "string", + "x-nullable": true + }, + "userManagedIdentityPrincipalId": { + "description": "PrincipalId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", + "type": "string", + "x-nullable": true + }, + "userManagedIdentityResourceId": { + "description": "Full arm scope for the Id. For ManagedIdentityType = SystemManaged, this field is null.", + "type": "string", + "x-nullable": true + }, + "userManagedIdentityTenantId": { + "description": "TenantId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "ManagedIdentity", + "additionalProperties": false + }, + "ManagedOnlineDeployment": { + "description": "Properties specific to a ManagedOnlineDeployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineDeployment" + } + ], + "x-ms-discriminator-value": "Managed", + "additionalProperties": false + }, + "MarketplacePlan": { + "type": "object", + "properties": { + "offerId": { + "description": "The identifying name of the Offer of the Marketplace Plan.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "planId": { + "description": "The identifying name of the Plan of the Marketplace Plan.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "publisherId": { + "description": "The identifying name of the Publisher of the Marketplace Plan.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "MarketplaceSubscription": { + "required": [ + "modelId" + ], + "type": "object", + "properties": { + "marketplacePlan": { + "description": "Marketplace Plan associated with the Marketplace Subscription.", + "$ref": "#/definitions/MarketplacePlan", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "marketplaceSubscriptionStatus": { + "description": "Current status of the Marketplace Subscription.", + "$ref": "#/definitions/MarketplaceSubscriptionStatus", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "modelId": { + "description": "[Required] Target Marketplace Model ID to create a Marketplace Subscription for.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning State of the Marketplace Subscription.", + "$ref": "#/definitions/MarketplaceSubscriptionProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "MarketplaceSubscriptionProperties", + "additionalProperties": false + }, + "MarketplaceSubscriptionProvisioningState": { + "enum": [ + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Updating", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MarketplaceSubscriptionProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating", + "description": "MarketplaceSubscription is being created." + }, + { + "value": "Deleting", + "description": "MarketplaceSubscription is being deleted." + }, + { + "value": "Succeeded", + "description": "MarketplaceSubscription is successfully provisioned." + }, + { + "value": "Failed", + "description": "MarketplaceSubscription provisioning failed." + }, + { + "value": "Updating", + "description": "MarketplaceSubscription is being updated." + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "MarketplaceSubscriptionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/MarketplaceSubscription" + } + }, + "x-ms-client-name": "MarketplaceSubscription", + "additionalProperties": false + }, + "MarketplaceSubscriptionResourceArmPaginatedResult": { + "description": "A paginated list of MarketplaceSubscription entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of MarketplaceSubscription objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type MarketplaceSubscription.", + "type": "array", + "items": { + "$ref": "#/definitions/MarketplaceSubscriptionResource" + } + } + }, + "additionalProperties": false + }, + "MarketplaceSubscriptionStatus": { + "enum": [ + "Subscribed", + "Suspended", + "Unsubscribed" + ], + "type": "string", + "x-ms-enum": { + "name": "MarketplaceSubscriptionStatus", + "modelAsString": true, + "values": [ + { + "value": "Subscribed", + "description": "The customer can now use the Marketplace Subscription's\nmodel and will be billed." + }, + { + "value": "Suspended", + "description": "The customer could not be billed for the Marketplace Subscription.\nThe customer will not be able to access the model." + }, + { + "value": "Unsubscribed", + "description": "Marketplace Subscriptions reach this state in response to an explicit customer or CSP action.\nA Marketplace Subscription can also be canceled implicitly, as a result of nonpayment of dues,\nafter being in the Suspended state for some time." + } + ] + }, + "additionalProperties": false + }, + "MaterializationComputeResource": { + "description": "DTO object representing compute resource", + "type": "object", + "properties": { + "instanceType": { + "description": "Specifies the instance type", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "MaterializationSettings": { + "type": "object", + "properties": { + "notification": { + "description": "Specifies the notification details", + "$ref": "#/definitions/NotificationSetting", + "x-nullable": true + }, + "resource": { + "description": "Specifies the compute resource settings", + "$ref": "#/definitions/MaterializationComputeResource", + "x-nullable": true + }, + "schedule": { + "description": "Specifies the schedule details", + "$ref": "#/definitions/RecurrenceTrigger", + "x-nullable": true + }, + "sparkConfiguration": { + "description": "Specifies the spark compute settings", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "storeType": { + "description": "Specifies the stores to which materialization should happen", + "default": "None", + "$ref": "#/definitions/MaterializationStoreType" + } + }, + "additionalProperties": false + }, + "MaterializationStoreType": { + "enum": [ + "None", + "Online", + "Offline", + "OnlineAndOffline" + ], + "type": "string", + "x-ms-enum": { + "name": "MaterializationStoreType", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "Online" + }, + { + "value": "Offline" + }, + { + "value": "OnlineAndOffline" + } + ] + }, + "additionalProperties": false + }, + "MedianStoppingPolicy": { + "description": "Defines an early termination policy based on running averages of the primary metric of all runs", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EarlyTerminationPolicy" + } + ], + "x-ms-discriminator-value": "MedianStopping", + "additionalProperties": false + }, + "ModelContainer": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the model container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "ModelContainerProperties", + "additionalProperties": false + }, + "ModelContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ModelContainer" + } + }, + "x-ms-client-name": "ModelContainer", + "additionalProperties": false + }, + "ModelContainerResourceArmPaginatedResult": { + "description": "A paginated list of ModelContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ModelContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ModelContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelContainerResource" + } + } + }, + "additionalProperties": false + }, + "ModelSettings": { + "type": "object", + "properties": { + "modelId": { + "description": "The unique model identifier that this ServerlessEndpoint should provision.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ModelSize": { + "description": "Image model size.", + "enum": [ + "None", + "Small", + "Medium", + "Large", + "ExtraLarge" + ], + "type": "string", + "x-ms-enum": { + "name": "ModelSize", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No value selected." + }, + { + "value": "Small", + "description": "Small size." + }, + { + "value": "Medium", + "description": "Medium size." + }, + { + "value": "Large", + "description": "Large size." + }, + { + "value": "ExtraLarge", + "description": "Extra large size." + } + ] + }, + "additionalProperties": false + }, + "ModelTaskType": { + "description": "Model task type enum.", + "enum": [ + "Classification", + "Regression" + ], + "type": "string", + "x-ms-enum": { + "name": "ModelTaskType", + "modelAsString": true, + "values": [ + { + "value": "Classification" + }, + { + "value": "Regression" + } + ] + }, + "additionalProperties": false + }, + "ModelVersion": { + "description": "Model asset version details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "flavors": { + "description": "Mapping of model flavors to their properties.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FlavorData", + "x-nullable": true + }, + "x-nullable": true + }, + "jobName": { + "description": "Name of the training job which produced this model", + "type": "string", + "x-nullable": true + }, + "modelType": { + "description": "The storage format for this entity. Used for NCD.", + "type": "string", + "x-nullable": true + }, + "modelUri": { + "description": "The URI path to the model contents.", + "type": "string", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the model version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "stage": { + "description": "Stage in the model lifecycle assigned to this model", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ModelVersionProperties", + "additionalProperties": false + }, + "ModelVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ModelVersion" + } + }, + "x-ms-client-name": "ModelVersion", + "additionalProperties": false + }, + "ModelVersionResourceArmPaginatedResult": { + "description": "A paginated list of ModelVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ModelVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ModelVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelVersionResource" + } + } + }, + "additionalProperties": false + }, + "MonitorComputeConfigurationBase": { + "description": "Monitor compute configuration base definition.", + "required": [ + "computeType" + ], + "type": "object", + "properties": { + "computeType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitorComputeType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "computeType" + }, + "MonitorComputeIdentityBase": { + "description": "Monitor compute identity base definition.", + "required": [ + "computeIdentityType" + ], + "type": "object", + "properties": { + "computeIdentityType": { + "description": "[Required] Specifies the type of identity to use within the monitoring jobs.", + "$ref": "#/definitions/MonitorComputeIdentityType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "computeIdentityType" + }, + "MonitorComputeIdentityType": { + "description": "Monitor compute identity type enum.", + "enum": [ + "AmlToken", + "ManagedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitorComputeIdentityType", + "modelAsString": true, + "values": [ + { + "value": "AmlToken", + "description": "Authenticates through user's AML token." + }, + { + "value": "ManagedIdentity", + "description": "Authenticates through a user-provided managed identity." + } + ] + }, + "additionalProperties": false + }, + "MonitorComputeType": { + "description": "Monitor compute type enum.", + "enum": [ + "ServerlessSpark" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitorComputeType", + "modelAsString": true, + "values": [ + { + "value": "ServerlessSpark", + "description": "Serverless Spark compute." + } + ] + }, + "additionalProperties": false + }, + "MonitorDefinition": { + "required": [ + "computeConfiguration", + "signals" + ], + "type": "object", + "properties": { + "alertNotificationSettings": { + "description": "The monitor's notification settings.", + "$ref": "#/definitions/MonitorNotificationSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "computeConfiguration": { + "description": "[Required] The ARM resource ID of the compute resource to run the monitoring job on.", + "$ref": "#/definitions/MonitorComputeConfigurationBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "monitoringTarget": { + "description": "The entities targeted by the monitor.", + "$ref": "#/definitions/MonitoringTarget", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "signals": { + "description": "[Required] The signals to monitor.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringSignalBase", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "MonitorEmailNotificationSettings": { + "type": "object", + "properties": { + "emails": { + "description": "The email recipient list which has a limitation of 499 characters in total.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "MonitorNotificationSettings": { + "type": "object", + "properties": { + "emailNotificationSettings": { + "description": "The AML notification email settings.", + "$ref": "#/definitions/MonitorEmailNotificationSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "MonitorServerlessSparkCompute": { + "description": "Monitor serverless spark compute definition.", + "required": [ + "computeIdentity", + "instanceType", + "runtimeVersion" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitorComputeConfigurationBase" + } + ], + "properties": { + "computeIdentity": { + "description": "[Required] The identity scheme leveraged to by the spark jobs running on serverless Spark.", + "$ref": "#/definitions/MonitorComputeIdentityBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "instanceType": { + "description": "[Required] The instance type running the Spark job.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "runtimeVersion": { + "description": "[Required] The Spark runtime version.", + "minLength": 1, + "pattern": "^[0-9]+\\.[0-9]+$", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "ServerlessSpark", + "additionalProperties": false + }, + "MonitoringFeatureDataType": { + "enum": [ + "Numerical", + "Categorical" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringFeatureDataType", + "modelAsString": true, + "values": [ + { + "value": "Numerical", + "description": "Used for features of numerical data type." + }, + { + "value": "Categorical", + "description": "Used for features of categorical data type." + } + ] + }, + "additionalProperties": false + }, + "MonitoringFeatureFilterBase": { + "required": [ + "filterType" + ], + "type": "object", + "properties": { + "filterType": { + "description": "[Required] Specifies the feature filter to leverage when selecting features to calculate metrics over.", + "$ref": "#/definitions/MonitoringFeatureFilterType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "filterType" + }, + "MonitoringFeatureFilterType": { + "enum": [ + "AllFeatures", + "TopNByAttribution", + "FeatureSubset" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringFeatureFilterType", + "modelAsString": true, + "values": [ + { + "value": "AllFeatures", + "description": "Includes all features." + }, + { + "value": "TopNByAttribution", + "description": "Only includes the top contributing features, measured by feature attribution." + }, + { + "value": "FeatureSubset", + "description": "Includes a user-defined subset of features." + } + ] + }, + "additionalProperties": false + }, + "MonitoringInputDataBase": { + "description": "Monitoring input data base definition.", + "required": [ + "inputDataType", + "jobInputType", + "uri" + ], + "type": "object", + "properties": { + "columns": { + "description": "Mapping of column names to special uses.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "dataContext": { + "description": "The context metadata of the data source.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputDataType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitoringInputDataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "jobInputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobInputType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "uri": { + "description": "[Required] Input Asset URI.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "inputDataType" + }, + "MonitoringInputDataType": { + "description": "Monitoring input data type enum.", + "enum": [ + "Static", + "Rolling", + "Fixed" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringInputDataType", + "modelAsString": true, + "values": [ + { + "value": "Static", + "description": "An input data with a fixed window size." + }, + { + "value": "Rolling", + "description": "An input data which rolls relatively to the monitor's current run time." + }, + { + "value": "Fixed", + "description": "An input data with tabular format which doesn't require preprocessing." + } + ] + }, + "additionalProperties": false + }, + "MonitoringNotificationType": { + "enum": [ + "AmlNotification" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringNotificationType", + "modelAsString": true, + "values": [ + { + "value": "AmlNotification", + "description": "Enables email notifications through AML notifications." + } + ] + }, + "additionalProperties": false + }, + "MonitoringSignalBase": { + "required": [ + "signalType" + ], + "type": "object", + "properties": { + "notificationTypes": { + "description": "The current notification mode for this signal.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoringNotificationType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "signalType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitoringSignalType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "signalType" + }, + "MonitoringSignalType": { + "enum": [ + "DataDrift", + "PredictionDrift", + "DataQuality", + "FeatureAttributionDrift", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringSignalType", + "modelAsString": true, + "values": [ + { + "value": "DataDrift", + "description": "Tracks model input data distribution change, comparing against training data or past production data." + }, + { + "value": "PredictionDrift", + "description": "Tracks prediction result data distribution change, comparing against validation/test label data or past production data." + }, + { + "value": "DataQuality", + "description": "Tracks model input data integrity." + }, + { + "value": "FeatureAttributionDrift", + "description": "Tracks feature importance change in production, comparing against feature importance at training time." + }, + { + "value": "Custom", + "description": "Tracks a custom signal provided by users." + } + ] + }, + "additionalProperties": false + }, + "MonitoringTarget": { + "description": "Monitoring target definition.", + "required": [ + "taskType" + ], + "type": "object", + "properties": { + "deploymentId": { + "description": "Reference to the deployment asset targeted by this monitor.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "modelId": { + "description": "Reference to the model asset targeted by this monitor.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "taskType": { + "description": "[Required] The machine learning task type of the monitored model.", + "$ref": "#/definitions/ModelTaskType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "MonitoringThreshold": { + "type": "object", + "properties": { + "value": { + "format": "double", + "description": "The threshold value. If null, the set default is dependent on the metric type.", + "type": "number", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "Mpi": { + "description": "MPI distribution configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + } + ], + "properties": { + "processCountPerInstance": { + "format": "int32", + "description": "Number of processes per MPI node.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Mpi", + "additionalProperties": false + }, + "NCrossValidations": { + "description": "N-Cross validations value.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Mode for determining N-Cross validations.", + "$ref": "#/definitions/NCrossValidationsMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "NCrossValidationsMode": { + "description": "Determines how N-Cross validations value is determined.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "NCrossValidationsMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Determine N-Cross validations value automatically. Supported only for 'Forecasting' AutoML task." + }, + { + "value": "Custom", + "description": "Use custom N-Cross validations value." + } + ] + }, + "additionalProperties": false + }, + "NlpVertical": { + "description": "Abstract class for NLP related AutoML tasks.\r\nNLP - Natural Language Processing.", + "type": "object", + "properties": { + "featurizationSettings": { + "description": "Featurization inputs needed for AutoML job.", + "$ref": "#/definitions/NlpVerticalFeaturizationSettings", + "x-nullable": true + }, + "limitSettings": { + "description": "Execution constraints for AutoMLJob.", + "$ref": "#/definitions/NlpVerticalLimitSettings", + "x-nullable": true + }, + "validationData": { + "description": "Validation data inputs.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "NlpVerticalFeaturizationSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeaturizationSettings" + } + ], + "additionalProperties": false + }, + "NlpVerticalLimitSettings": { + "description": "Job execution constraints.", + "type": "object", + "properties": { + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum Concurrent AutoML iterations.", + "default": 1, + "type": "integer" + }, + "maxTrials": { + "format": "int32", + "description": "Number of AutoML iterations.", + "default": 1, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "P7D", + "type": "string" + } + }, + "additionalProperties": false + }, + "Nodes": { + "description": "Abstract Nodes definition", + "required": [ + "nodesValueType" + ], + "type": "object", + "properties": { + "nodesValueType": { + "description": "[Required] Type of the Nodes value", + "$ref": "#/definitions/NodesValueType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "nodesValueType" + }, + "NodesValueType": { + "description": "The enumerated types for the nodes value", + "enum": [ + "All" + ], + "type": "string", + "x-ms-enum": { + "name": "NodesValueType", + "modelAsString": true, + "values": [ + { + "value": "All" + } + ] + }, + "additionalProperties": false + }, + "NoneDatastoreCredentials": { + "description": "Empty/none datastore credentials.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "x-ms-discriminator-value": "None", + "additionalProperties": false + }, + "NotificationSetting": { + "description": "Configuration for notification.", + "type": "object", + "properties": { + "emailOn": { + "description": "Send email notification to user on specified notification type", + "type": "array", + "items": { + "$ref": "#/definitions/EmailNotificationEnableType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "emails": { + "description": "This is the email recipient list which has a limitation of 499 characters in total concat with comma separator", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "webhooks": { + "description": "Send webhook callback to a service. Key is a user-provided name for the webhook.", + "type": "object", + "additionalProperties": { + "description": "Webhook base", + "$ref": "#/definitions/Webhook", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "NumericalDataDriftMetric": { + "enum": [ + "JensenShannonDistance", + "PopulationStabilityIndex", + "NormalizedWassersteinDistance", + "TwoSampleKolmogorovSmirnovTest" + ], + "type": "string", + "x-ms-enum": { + "name": "NumericalDataDriftMetric", + "modelAsString": true, + "values": [ + { + "value": "JensenShannonDistance", + "description": "The Jensen Shannon Distance (JSD) metric." + }, + { + "value": "PopulationStabilityIndex", + "description": "The Population Stability Index (PSI) metric." + }, + { + "value": "NormalizedWassersteinDistance", + "description": "The Normalized Wasserstein Distance metric." + }, + { + "value": "TwoSampleKolmogorovSmirnovTest", + "description": "The Two Sample Kolmogorov-Smirnov Test (two-sample K–S) metric." + } + ] + }, + "additionalProperties": false + }, + "NumericalDataDriftMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataDriftMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The numerical data drift metric to calculate.", + "$ref": "#/definitions/NumericalDataDriftMetric" + } + }, + "x-ms-discriminator-value": "Numerical", + "additionalProperties": false + }, + "NumericalDataQualityMetric": { + "enum": [ + "NullValueRate", + "DataTypeErrorRate", + "OutOfBoundsRate" + ], + "type": "string", + "x-ms-enum": { + "name": "NumericalDataQualityMetric", + "modelAsString": true, + "values": [ + { + "value": "NullValueRate", + "description": "Calculates the rate of null values." + }, + { + "value": "DataTypeErrorRate", + "description": "Calculates the rate of data type errors." + }, + { + "value": "OutOfBoundsRate", + "description": "Calculates the rate values are out of bounds." + } + ] + }, + "additionalProperties": false + }, + "NumericalDataQualityMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataQualityMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The numerical data quality metric to calculate.", + "$ref": "#/definitions/NumericalDataQualityMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Numerical", + "additionalProperties": false + }, + "NumericalPredictionDriftMetric": { + "enum": [ + "JensenShannonDistance", + "PopulationStabilityIndex", + "NormalizedWassersteinDistance", + "TwoSampleKolmogorovSmirnovTest" + ], + "type": "string", + "x-ms-enum": { + "name": "NumericalPredictionDriftMetric", + "modelAsString": true, + "values": [ + { + "value": "JensenShannonDistance", + "description": "The Jensen Shannon Distance (JSD) metric." + }, + { + "value": "PopulationStabilityIndex", + "description": "The Population Stability Index (PSI) metric." + }, + { + "value": "NormalizedWassersteinDistance", + "description": "The Normalized Wasserstein Distance metric." + }, + { + "value": "TwoSampleKolmogorovSmirnovTest", + "description": "The Two Sample Kolmogorov-Smirnov Test (two-sample K–S) metric." + } + ] + }, + "additionalProperties": false + }, + "NumericalPredictionDriftMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PredictionDriftMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The numerical prediction drift metric to calculate.", + "$ref": "#/definitions/NumericalPredictionDriftMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Numerical", + "additionalProperties": false + }, + "ObjectDetectionPrimaryMetrics": { + "description": "Primary metrics for Image ObjectDetection task.", + "enum": [ + "MeanAveragePrecision" + ], + "type": "string", + "x-ms-enum": { + "name": "ObjectDetectionPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "MeanAveragePrecision", + "description": "Mean Average Precision (MAP) is the average of AP (Average Precision).\nAP is calculated for each class and averaged to get the MAP." + } + ] + }, + "additionalProperties": false + }, + "Objective": { + "description": "Optimization objective.", + "required": [ + "goal", + "primaryMetric" + ], + "type": "object", + "properties": { + "goal": { + "description": "[Required] Defines supported metric goals for hyperparameter tuning", + "$ref": "#/definitions/Goal" + }, + "primaryMetric": { + "description": "[Required] Name of the metric to optimize.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, + "OneLakeArtifact": { + "description": "OneLake artifact (data source) configuration.", + "required": [ + "artifactName", + "artifactType" + ], + "type": "object", + "properties": { + "artifactName": { + "description": "[Required] OneLake artifact name", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "artifactType": { + "description": "[Required] OneLake artifact type", + "$ref": "#/definitions/OneLakeArtifactType" + } + }, + "discriminator": "artifactType" + }, + "OneLakeArtifactType": { + "description": "Enum to determine OneLake artifact type.", + "enum": [ + "LakeHouse" + ], + "type": "string", + "x-ms-enum": { + "name": "OneLakeArtifactType", + "modelAsString": true, + "values": [ + { + "value": "LakeHouse" + } + ] + }, + "additionalProperties": false + }, + "OneLakeDatastore": { + "description": "OneLake (Trident) datastore configuration.", + "required": [ + "artifact", + "oneLakeWorkspaceName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "artifact": { + "description": "[Required] OneLake artifact backing the datastore.", + "$ref": "#/definitions/OneLakeArtifact", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "endpoint": { + "description": "OneLake endpoint to use for the datastore.", + "type": "string", + "example": "data.microsoft.com", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "oneLakeWorkspaceName": { + "description": "[Required] OneLake workspace name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "OneLake", + "additionalProperties": false + }, + "OnlineDeployment": { + "required": [ + "endpointComputeType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointDeploymentPropertiesBase" + } + ], + "properties": { + "appInsightsEnabled": { + "description": "If true, enables Application Insights logging.", + "default": false, + "type": "boolean" + }, + "dataCollector": { + "description": "The mdc configuration, we disable mdc when it's null.", + "$ref": "#/definitions/DataCollector", + "x-nullable": true + }, + "egressPublicNetworkAccess": { + "description": "If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.", + "default": "Enabled", + "$ref": "#/definitions/EgressPublicNetworkAccessType" + }, + "endpointComputeType": { + "description": "[Required] The compute type of the endpoint.", + "$ref": "#/definitions/EndpointComputeType" + }, + "instanceType": { + "description": "Compute instance type.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "livenessProbe": { + "description": "Liveness probe monitors the health of the container regularly.", + "$ref": "#/definitions/ProbeSettings", + "x-nullable": true + }, + "model": { + "description": "The URI path to the model.", + "type": "string", + "x-nullable": true + }, + "modelMountPath": { + "description": "The path to mount the model in custom container.", + "type": "string", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint deployment.", + "$ref": "#/definitions/DeploymentProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "readinessProbe": { + "description": "Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.", + "$ref": "#/definitions/ProbeSettings", + "x-nullable": true + }, + "requestSettings": { + "description": "Request settings for the deployment.", + "$ref": "#/definitions/OnlineRequestSettings", + "x-nullable": true + }, + "scaleSettings": { + "description": "Scale settings for the deployment.\r\nIf it is null or not provided,\r\nit defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment\r\nand to DefaultScaleSettings for ManagedOnlineDeployment.", + "$ref": "#/definitions/OnlineScaleSettings", + "x-nullable": true + } + }, + "discriminator": "endpointComputeType", + "x-ms-client-name": "OnlineDeploymentProperties" + }, + "OnlineDeploymentTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/OnlineDeployment" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "OnlineDeployment", + "additionalProperties": false + }, + "OnlineDeploymentTrackedResourceArmPaginatedResult": { + "description": "A paginated list of OnlineDeployment entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of OnlineDeployment objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type OnlineDeployment.", + "type": "array", + "items": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + }, + "additionalProperties": false + }, + "OnlineEndpoint": { + "description": "Online endpoint configuration", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesBase" + } + ], + "properties": { + "compute": { + "description": "ARM resource ID of the compute if it exists.\r\noptional", + "type": "string", + "x-nullable": true + }, + "mirrorTraffic": { + "description": "Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "publicNetworkAccess": { + "description": "Set to \"Enabled\" for endpoints that should allow public access when Private Link is enabled.", + "default": "Enabled", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "traffic": { + "description": "Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true + } + }, + "x-ms-client-name": "OnlineEndpointProperties", + "additionalProperties": false + }, + "OnlineEndpointTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/OnlineEndpoint" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "OnlineEndpoint", + "additionalProperties": false + }, + "OnlineEndpointTrackedResourceArmPaginatedResult": { + "description": "A paginated list of OnlineEndpoint entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type OnlineEndpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + } + }, + "additionalProperties": false + }, + "OnlineRequestSettings": { + "description": "Online deployment scoring requests configuration.", + "type": "object", + "properties": { + "maxConcurrentRequestsPerInstance": { + "format": "int32", + "description": "The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.", + "default": 1, + "type": "integer" + }, + "maxQueueWait": { + "format": "duration", + "description": "(Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format.\r\nDefaults to 500ms.\r\n(Now increase `request_timeout_ms` to account for any networking/queue delays)", + "default": "PT0.5S", + "type": "string" + }, + "requestTimeout": { + "format": "duration", + "description": "The scoring timeout in ISO 8601 format.\r\nDefaults to 5000ms.", + "default": "PT5S", + "type": "string" + } + }, + "additionalProperties": false + }, + "OnlineScaleSettings": { + "description": "Online deployment scaling configuration.", + "required": [ + "scaleType" + ], + "type": "object", + "properties": { + "scaleType": { + "description": "[Required] Type of deployment scaling algorithm", + "$ref": "#/definitions/ScaleType" + } + }, + "discriminator": "scaleType" + }, + "OperatingSystemType": { + "description": "The type of operating system.", + "enum": [ + "Linux", + "Windows" + ], + "type": "string", + "x-ms-enum": { + "name": "OperatingSystemType", + "modelAsString": true, + "values": [ + { + "value": "Linux" + }, + { + "value": "Windows" + } + ] + }, + "additionalProperties": false + }, + "OrderString": { + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "type": "string", + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true, + "values": [ + { + "value": "CreatedAtDesc" + }, + { + "value": "CreatedAtAsc" + }, + { + "value": "UpdatedAtDesc" + }, + { + "value": "UpdatedAtAsc" + } + ] + }, + "additionalProperties": false + }, + "OutputDeliveryMode": { + "description": "Output data delivery mode enums.", + "enum": [ + "ReadWriteMount", + "Upload", + "Direct" + ], + "type": "string", + "x-ms-enum": { + "name": "OutputDeliveryMode", + "modelAsString": true, + "values": [ + { + "value": "ReadWriteMount" + }, + { + "value": "Upload" + }, + { + "value": "Direct" + } + ] + }, + "additionalProperties": false + }, + "OutputPathAssetReference": { + "description": "Reference to an asset via its path in a job output.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "jobId": { + "description": "ARM resource ID of the job.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "The path of the file/directory in the job output.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "OutputPath", + "additionalProperties": false + }, + "PartialBatchDeployment": { + "description": "Mutable batch inference settings per deployment.", + "type": "object", + "properties": { + "description": { + "description": "Description of the endpoint deployment.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties": { + "description": "Strictly used in update requests.", + "type": "object", + "properties": { + "properties": { + "description": "Additional attributes of the entity.", + "$ref": "#/definitions/PartialBatchDeployment" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "PartialManagedServiceIdentity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "type": "object", + "properties": { + "type": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentityType" + }, + "userAssignedIdentities": { + "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PartialUserAssignedIdentity" + } + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResource": { + "description": "Strictly used in update requests.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResourceWithIdentity": { + "description": "Strictly used in update requests.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PartialMinimalTrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "#/definitions/PartialManagedServiceIdentity" + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResourceWithSku": { + "description": "Strictly used in update requests.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PartialMinimalTrackedResource" + } + ], + "properties": { + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "#/definitions/PartialSku" + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResourceWithSkuAndIdentity": { + "description": "Strictly used in update requests.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PartialMinimalTrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "#/definitions/PartialManagedServiceIdentity" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "#/definitions/PartialSku" + } + }, + "additionalProperties": false + }, + "PartialSku": { + "description": "Common SKU definition.", + "type": "object", + "properties": { + "capacity": { + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.", + "type": "integer" + }, + "family": { + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "name": { + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code.", + "type": "string" + }, + "size": { + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.", + "type": "string" + }, + "tier": { + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + } + }, + "additionalProperties": false + }, + "PartialUserAssignedIdentity": { + "type": "object", + "additionalProperties": false + }, + "PendingUploadCredentialDto": { + "required": [ + "credentialType" + ], + "type": "object", + "properties": { + "credentialType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/PendingUploadCredentialType" + } + }, + "discriminator": "credentialType" + }, + "PendingUploadCredentialType": { + "description": "Enum to determine the PendingUpload credentials type.", + "enum": [ + "SAS" + ], + "type": "string", + "x-ms-enum": { + "name": "PendingUploadCredentialType", + "modelAsString": true, + "values": [ + { + "value": "SAS" + } + ] + }, + "additionalProperties": false + }, + "PendingUploadRequestDto": { + "type": "object", + "properties": { + "pendingUploadId": { + "description": "If PendingUploadId = null then random guid will be used.", + "type": "string", + "x-nullable": true + }, + "pendingUploadType": { + "description": "TemporaryBlobReference is the only supported type", + "default": "TemporaryBlobReference", + "$ref": "#/definitions/PendingUploadType" + } + }, + "additionalProperties": false + }, + "PendingUploadResponseDto": { + "type": "object", + "properties": { + "blobReferenceForConsumption": { + "description": "Container level read, write, list SAS", + "$ref": "#/definitions/BlobReferenceForConsumptionDto", + "x-nullable": true + }, + "pendingUploadId": { + "description": "ID for this upload request", + "type": "string", + "x-nullable": true + }, + "pendingUploadType": { + "description": "TemporaryBlobReference is the only supported type", + "default": "TemporaryBlobReference", + "$ref": "#/definitions/PendingUploadType" + } + }, + "additionalProperties": false + }, + "PendingUploadType": { + "description": "Type of storage to use for the pending upload location", + "enum": [ + "None", + "TemporaryBlobReference" + ], + "type": "string", + "x-ms-enum": { + "name": "PendingUploadType", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "TemporaryBlobReference" + } + ] + }, + "additionalProperties": false + }, + "PipelineJob": { + "description": "Pipeline Job definition: defines generic to MFE attributes.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "inputs": { + "description": "Inputs for the pipeline job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobs": { + "description": "Jobs construct the Pipeline Job.", + "type": "object", + "additionalProperties": { + "type": "object", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Outputs for the pipeline job", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "settings": { + "description": "Pipeline settings, for things like ContinueRunOnStepFailure etc.", + "type": "object", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "sourceJobId": { + "description": "ARM resource ID of source job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Pipeline", + "additionalProperties": false + }, + "PredictionDriftMetricThresholdBase": { + "required": [ + "dataType" + ], + "type": "object", + "properties": { + "dataType": { + "description": "[Required] Specifies the data type of the metric threshold.", + "$ref": "#/definitions/MonitoringFeatureDataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "discriminator": "dataType" + }, + "PredictionDriftMonitoringSignal": { + "required": [ + "metricThresholds", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/PredictionDriftMetricThresholdBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "[Required] The data which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "PredictionDrift", + "additionalProperties": false + }, + "ProbeSettings": { + "description": "Deployment container liveness/readiness probe configuration.", + "type": "object", + "properties": { + "failureThreshold": { + "format": "int32", + "description": "The number of failures to allow before returning an unhealthy status.", + "default": 30, + "type": "integer" + }, + "initialDelay": { + "format": "duration", + "description": "The delay before the first probe in ISO 8601 format.", + "type": "string", + "x-nullable": true + }, + "period": { + "format": "duration", + "description": "The length of time between probes in ISO 8601 format.", + "default": "PT10S", + "type": "string" + }, + "successThreshold": { + "format": "int32", + "description": "The number of successful probes before returning a healthy status.", + "default": 1, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "The probe timeout in ISO 8601 format.", + "default": "PT2S", + "type": "string" + } + }, + "additionalProperties": false + }, + "PublicNetworkAccessType": { + "description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "PyTorch": { + "description": "PyTorch distribution configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + } + ], + "properties": { + "processCountPerInstance": { + "format": "int32", + "description": "Number of processes per node.", + "type": "integer", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PyTorch", + "additionalProperties": false + }, + "QueueSettings": { + "type": "object", + "properties": { + "jobTier": { + "description": "Controls the compute job tier", + "default": "Null", + "$ref": "#/definitions/JobTier", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "RandomSamplingAlgorithm": { + "description": "Defines a Sampling Algorithm that generates values randomly", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SamplingAlgorithm" + } + ], + "properties": { + "rule": { + "description": "The specific type of random algorithm", + "default": "Random", + "$ref": "#/definitions/RandomSamplingAlgorithmRule" + }, + "seed": { + "format": "int32", + "description": "An optional integer to use as the seed for random number generation", + "type": "integer", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Random", + "additionalProperties": false + }, + "RandomSamplingAlgorithmRule": { + "description": "The specific type of random algorithm", + "enum": [ + "Random", + "Sobol" + ], + "type": "string", + "x-ms-enum": { + "name": "RandomSamplingAlgorithmRule", + "modelAsString": true, + "values": [ + { + "value": "Random" + }, + { + "value": "Sobol" + } + ] + }, + "additionalProperties": false + }, + "RecurrenceFrequency": { + "description": "Enum to describe the frequency of a recurrence schedule", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "type": "string", + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": true, + "values": [ + { + "value": "Minute", + "description": "Minute frequency" + }, + { + "value": "Hour", + "description": "Hour frequency" + }, + { + "value": "Day", + "description": "Day frequency" + }, + { + "value": "Week", + "description": "Week frequency" + }, + { + "value": "Month", + "description": "Month frequency" + } + ] + }, + "additionalProperties": false + }, + "RecurrenceSchedule": { + "required": [ + "hours", + "minutes" + ], + "type": "object", + "properties": { + "hours": { + "description": "[Required] List of hours for the schedule.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "minutes": { + "description": "[Required] List of minutes for the schedule.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "monthDays": { + "description": "List of month days for the schedule", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true + }, + "weekDays": { + "description": "List of days for the schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/WeekDay" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RecurrenceTrigger": { + "required": [ + "frequency", + "interval" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerBase" + } + ], + "properties": { + "frequency": { + "description": "[Required] The frequency to trigger schedule.", + "$ref": "#/definitions/RecurrenceFrequency" + }, + "interval": { + "format": "int32", + "description": "[Required] Specifies schedule interval in conjunction with frequency", + "type": "integer" + }, + "schedule": { + "description": "The recurrence schedule.", + "$ref": "#/definitions/RecurrenceSchedule", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Recurrence", + "additionalProperties": false + }, + "ReferenceType": { + "description": "Enum to determine which reference method to use for an asset.", + "enum": [ + "Id", + "DataPath", + "OutputPath" + ], + "type": "string", + "x-ms-enum": { + "name": "ReferenceType", + "modelAsString": true, + "values": [ + { + "value": "Id" + }, + { + "value": "DataPath" + }, + { + "value": "OutputPath" + } + ] + }, + "additionalProperties": false + }, + "RegenerateEndpointKeysRequest": { + "required": [ + "keyType" + ], + "type": "object", + "properties": { + "keyType": { + "description": "[Required] Specification for which type of key to generate. Primary or Secondary.", + "$ref": "#/definitions/KeyType", + "example": "Primary" + }, + "keyValue": { + "description": "The value the key is set to.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "Regression": { + "description": "Regression task in AutoML Table vertical.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TableVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for regression task.", + "default": "NormalizedRootMeanSquaredError", + "$ref": "#/definitions/RegressionPrimaryMetrics" + }, + "trainingSettings": { + "description": "Inputs for training phase for an AutoML Job.", + "$ref": "#/definitions/RegressionTrainingSettings", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Regression", + "additionalProperties": false + }, + "RegressionModels": { + "description": "Enum for all Regression models supported by AutoML.", + "enum": [ + "ElasticNet", + "GradientBoosting", + "DecisionTree", + "KNN", + "LassoLars", + "SGD", + "RandomForest", + "ExtremeRandomTrees", + "LightGBM", + "XGBoostRegressor" + ], + "type": "string", + "x-ms-enum": { + "name": "RegressionModels", + "modelAsString": true, + "values": [ + { + "value": "ElasticNet", + "description": "Elastic net is a popular type of regularized linear regression that combines two popular penalties, specifically the L1 and L2 penalty functions." + }, + { + "value": "GradientBoosting", + "description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution." + }, + { + "value": "DecisionTree", + "description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features." + }, + { + "value": "KNN", + "description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set." + }, + { + "value": "LassoLars", + "description": "Lasso model fit with Least Angle Regression a.k.a. Lars. It is a Linear Model trained with an L1 prior as regularizer." + }, + { + "value": "SGD", + "description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs.\nIt's an inexact but powerful technique." + }, + { + "value": "RandomForest", + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the \"bagging\" method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + }, + { + "value": "ExtremeRandomTrees", + "description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm." + }, + { + "value": "LightGBM", + "description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms." + }, + { + "value": "XGBoostRegressor", + "description": "XGBoostRegressor: Extreme Gradient Boosting Regressor is a supervised machine learning model using ensemble of base learners." + } + ] + }, + "additionalProperties": false + }, + "RegressionPrimaryMetrics": { + "description": "Primary metrics for Regression task.", + "enum": [ + "SpearmanCorrelation", + "NormalizedRootMeanSquaredError", + "R2Score", + "NormalizedMeanAbsoluteError" + ], + "type": "string", + "x-ms-enum": { + "name": "RegressionPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "SpearmanCorrelation", + "description": "The Spearman's rank coefficient of correlation is a nonparametric measure of rank correlation." + }, + { + "value": "NormalizedRootMeanSquaredError", + "description": "The Normalized Root Mean Squared Error (NRMSE) the RMSE facilitates the comparison between models with different scales." + }, + { + "value": "R2Score", + "description": "The R2 score is one of the performance evaluation measures for forecasting-based machine learning models." + }, + { + "value": "NormalizedMeanAbsoluteError", + "description": "The Normalized Mean Absolute Error (NMAE) is a validation metric to compare the Mean Absolute Error (MAE) of (time) series with different scales." + } + ] + }, + "additionalProperties": false + }, + "RegressionTrainingSettings": { + "description": "Regression Training related configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrainingSettings" + } + ], + "properties": { + "allowedTrainingAlgorithms": { + "description": "Allowed models for regression task.", + "type": "array", + "items": { + "$ref": "#/definitions/RegressionModels" + }, + "x-nullable": true + }, + "blockedTrainingAlgorithms": { + "description": "Blocked models for regression task.", + "type": "array", + "items": { + "$ref": "#/definitions/RegressionModels" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RequestLogging": { + "type": "object", + "properties": { + "captureHeaders": { + "description": "For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ResourceBase": { + "type": "object", + "properties": { + "description": { + "description": "The asset description text.", + "type": "string", + "x-nullable": true + }, + "properties": { + "description": "The asset property dictionary.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "tags": { + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ResourceConfiguration": { + "type": "object", + "properties": { + "instanceCount": { + "format": "int32", + "description": "Optional number of instances or nodes used by the compute target.", + "default": 1, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "instanceType": { + "description": "Optional type of VM used as supported by the compute target.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "properties": { + "description": "Additional properties bag.", + "type": "object", + "additionalProperties": { + "type": "object", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RollingInputData": { + "description": "Rolling input data definition.", + "required": [ + "windowOffset", + "windowSize" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringInputDataBase" + } + ], + "properties": { + "preprocessingComponentId": { + "description": "Reference to the component asset used to preprocess the data.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "windowOffset": { + "format": "duration", + "description": "[Required] The time offset between the end of the data window and the monitor's current run time.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "windowSize": { + "format": "duration", + "description": "[Required] The size of the rolling data window.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Rolling", + "additionalProperties": false + }, + "RollingRateType": { + "enum": [ + "Year", + "Month", + "Day", + "Hour", + "Minute" + ], + "type": "string", + "x-ms-enum": { + "name": "RollingRateType", + "modelAsString": true, + "values": [ + { + "value": "Year" + }, + { + "value": "Month" + }, + { + "value": "Day" + }, + { + "value": "Hour" + }, + { + "value": "Minute" + } + ] + }, + "additionalProperties": false + }, + "Route": { + "required": [ + "path", + "port" + ], + "type": "object", + "properties": { + "path": { + "description": "[Required] The path for the route.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "port": { + "format": "int32", + "description": "[Required] The port for the route.", + "type": "integer" + } + }, + "additionalProperties": false + }, + "SASCredential": { + "description": "Access with full SAS uri", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataReferenceCredential" + } + ], + "properties": { + "sasUri": { + "format": "uri", + "description": "Full SAS Uri, including the storage, container/blob path and SAS token", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "SAS", + "additionalProperties": false + }, + "SASCredentialDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PendingUploadCredentialDto" + } + ], + "properties": { + "sasUri": { + "format": "uri", + "description": "Full SAS Uri, including the storage, container/blob path and SAS token", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + } + }, + "x-ms-discriminator-value": "SAS", + "additionalProperties": false + }, + "SamplingAlgorithm": { + "description": "The Sampling Algorithm used to generate hyperparameter values, along with properties to\r\nconfigure the algorithm", + "required": [ + "samplingAlgorithmType" + ], + "type": "object", + "properties": { + "samplingAlgorithmType": { + "description": "[Required] The algorithm used for generating hyperparameter values, along with configuration properties", + "$ref": "#/definitions/SamplingAlgorithmType" + } + }, + "discriminator": "samplingAlgorithmType" + }, + "SamplingAlgorithmType": { + "enum": [ + "Grid", + "Random", + "Bayesian" + ], + "type": "string", + "x-ms-enum": { + "name": "SamplingAlgorithmType", + "modelAsString": true, + "values": [ + { + "value": "Grid" + }, + { + "value": "Random" + }, + { + "value": "Bayesian" + } + ] + }, + "additionalProperties": false + }, + "SasDatastoreCredentials": { + "description": "SAS datastore credentials configuration.", + "required": [ + "secrets" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "secrets": { + "description": "[Required] Storage container secrets.", + "$ref": "#/definitions/SasDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "Sas", + "additionalProperties": false + }, + "SasDatastoreSecrets": { + "description": "Datastore SAS secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "sasToken": { + "description": "Storage container SAS token.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Sas", + "additionalProperties": false + }, + "ScaleType": { + "enum": [ + "Default", + "TargetUtilization" + ], + "type": "string", + "x-ms-enum": { + "name": "ScaleType", + "modelAsString": true, + "values": [ + { + "value": "Default" + }, + { + "value": "TargetUtilization" + } + ] + }, + "additionalProperties": false + }, + "Schedule": { + "description": "Base definition of a schedule", + "required": [ + "action", + "trigger" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "action": { + "description": "[Required] Specifies the action of the schedule", + "$ref": "#/definitions/ScheduleActionBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "displayName": { + "description": "Display name of schedule.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "isEnabled": { + "description": "Is the schedule enabled?", + "default": true, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "provisioningState": { + "description": "Provisioning state for the schedule.", + "$ref": "#/definitions/ScheduleProvisioningStatus", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "trigger": { + "description": "[Required] Specifies the trigger details", + "$ref": "#/definitions/TriggerBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-client-name": "ScheduleProperties", + "additionalProperties": false + }, + "ScheduleActionBase": { + "required": [ + "actionType" + ], + "type": "object", + "properties": { + "actionType": { + "description": "[Required] Specifies the action type of the schedule", + "$ref": "#/definitions/ScheduleActionType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "discriminator": "actionType" + }, + "ScheduleActionType": { + "enum": [ + "CreateJob", + "InvokeBatchEndpoint", + "CreateMonitor" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleActionType", + "modelAsString": true, + "values": [ + { + "value": "CreateJob" + }, + { + "value": "InvokeBatchEndpoint" + }, + { + "value": "CreateMonitor" + } + ] + }, + "additionalProperties": false + }, + "ScheduleListViewType": { + "enum": [ + "EnabledOnly", + "DisabledOnly", + "All" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleListViewType", + "modelAsString": true, + "values": [ + { + "value": "EnabledOnly" + }, + { + "value": "DisabledOnly" + }, + { + "value": "All" + } + ] + }, + "additionalProperties": false + }, + "ScheduleProvisioningStatus": { + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleProvisioningStatus", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Updating" + }, + { + "value": "Deleting" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "ScheduleResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Schedule" + } + }, + "x-ms-client-name": "Schedule", + "additionalProperties": false + }, + "ScheduleResourceArmPaginatedResult": { + "description": "A paginated list of Schedule entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Schedule objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScheduleResource" + } + } + }, + "additionalProperties": false + }, + "Seasonality": { + "description": "Forecasting seasonality.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Seasonality mode.", + "$ref": "#/definitions/SeasonalityMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "SeasonalityMode": { + "description": "Forecasting seasonality mode.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "SeasonalityMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Seasonality to be determined automatically." + }, + { + "value": "Custom", + "description": "Use the custom seasonality value." + } + ] + }, + "additionalProperties": false + }, + "SecretsType": { + "description": "Enum to determine the datastore secrets type.", + "enum": [ + "AccountKey", + "Certificate", + "Sas", + "ServicePrincipal" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretsType", + "modelAsString": true, + "values": [ + { + "value": "AccountKey" + }, + { + "value": "Certificate" + }, + { + "value": "Sas" + }, + { + "value": "ServicePrincipal" + } + ] + }, + "additionalProperties": false + }, + "ServerlessEndpoint": { + "required": [ + "authMode" + ], + "type": "object", + "properties": { + "authMode": { + "description": "[Required] Specifies the authentication mode for the Serverless endpoint.", + "$ref": "#/definitions/ServerlessInferenceEndpointAuthMode" + }, + "contentSafety": { + "description": "Specifies the content safety options. If omitted, the default content safety settings will be configured", + "$ref": "#/definitions/ContentSafety", + "x-nullable": true + }, + "endpointState": { + "description": "The current state of the ServerlessEndpoint.", + "$ref": "#/definitions/ServerlessEndpointState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "inferenceEndpoint": { + "description": "The inference uri to target when making requests against the serverless endpoint", + "$ref": "#/definitions/ServerlessInferenceEndpoint", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "marketplaceSubscriptionId": { + "description": "The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "modelSettings": { + "description": "The model settings (model id) for the model being serviced on the ServerlessEndpoint.", + "$ref": "#/definitions/ModelSettings", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "ServerlessEndpointProperties", + "additionalProperties": false + }, + "ServerlessEndpointState": { + "description": "State of the Serverless Endpoint.", + "enum": [ + "Unknown", + "Creating", + "Deleting", + "Suspending", + "Reinstating", + "Online", + "Suspended", + "CreationFailed", + "DeletionFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerlessEndpointState", + "modelAsString": true, + "values": [ + { + "value": "Unknown" + }, + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Suspending" + }, + { + "value": "Reinstating" + }, + { + "value": "Online" + }, + { + "value": "Suspended" + }, + { + "value": "CreationFailed" + }, + { + "value": "DeletionFailed" + } + ] + }, + "additionalProperties": false + }, + "ServerlessEndpointTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ServerlessEndpoint" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "ServerlessEndpoint", + "additionalProperties": false + }, + "ServerlessEndpointTrackedResourceArmPaginatedResult": { + "description": "A paginated list of ServerlessEndpoint entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ServerlessEndpoint objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ServerlessEndpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + } + }, + "additionalProperties": false + }, + "ServerlessInferenceEndpoint": { + "required": [ + "uri" + ], + "type": "object", + "properties": { + "headers": { + "description": "Specifies any required headers to target this serverless endpoint.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "uri": { + "format": "uri", + "description": "[Required] The inference uri to target when making requests against the Serverless Endpoint.", + "type": "string", + "x-ms-mutability": [ + "read" + ] + } + }, + "additionalProperties": false + }, + "ServerlessInferenceEndpointAuthMode": { + "enum": [ + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerlessInferenceEndpointAuthMode", + "modelAsString": true, + "values": [ + { + "value": "Key" + } + ] + }, + "additionalProperties": false + }, + "ServiceDataAccessAuthIdentity": { + "enum": [ + "None", + "WorkspaceSystemAssignedIdentity", + "WorkspaceUserAssignedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceDataAccessAuthIdentity", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Do not use any identity for service data access." + }, + { + "value": "WorkspaceSystemAssignedIdentity", + "description": "Use the system assigned managed identity of the Workspace to authenticate service data access." + }, + { + "value": "WorkspaceUserAssignedIdentity", + "description": "Use the user assigned managed identity of the Workspace to authenticate service data access." + } + ] + }, + "additionalProperties": false + }, + "ServicePrincipalDatastoreCredentials": { + "description": "Service Principal datastore credentials configuration.", + "required": [ + "clientId", + "secrets", + "tenantId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "authorityUrl": { + "description": "Authority URL used for authentication.", + "type": "string", + "x-nullable": true + }, + "clientId": { + "format": "uuid", + "description": "[Required] Service principal client ID.", + "type": "string" + }, + "resourceUrl": { + "description": "Resource the service principal has access to.", + "type": "string", + "x-nullable": true + }, + "secrets": { + "description": "[Required] Service principal secrets.", + "$ref": "#/definitions/ServicePrincipalDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "tenantId": { + "format": "uuid", + "description": "[Required] ID of the tenant to which the service principal belongs.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ServicePrincipal", + "additionalProperties": false + }, + "ServicePrincipalDatastoreSecrets": { + "description": "Datastore Service Principal secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "clientSecret": { + "description": "Service principal secret.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "ServicePrincipal", + "additionalProperties": false + }, + "ShortSeriesHandlingConfiguration": { + "description": "The parameter defining how if AutoML should handle short time series.", + "enum": [ + "None", + "Auto", + "Pad", + "Drop" + ], + "type": "string", + "x-ms-enum": { + "name": "ShortSeriesHandlingConfiguration", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Represents no/null value." + }, + { + "value": "Auto", + "description": "Short series will be padded if there are no long series, otherwise short series will be dropped." + }, + { + "value": "Pad", + "description": "All the short series will be padded." + }, + { + "value": "Drop", + "description": "All the short series will be dropped." + } + ] + }, + "additionalProperties": false + }, + "SkuCapacity": { + "description": "SKU capacity information", + "type": "object", + "properties": { + "default": { + "format": "int32", + "description": "Gets or sets the default capacity.", + "default": 0, + "type": "integer" + }, + "maximum": { + "format": "int32", + "description": "Gets or sets the maximum.", + "default": 0, + "type": "integer" + }, + "minimum": { + "format": "int32", + "description": "Gets or sets the minimum.", + "default": 0, + "type": "integer" + }, + "scaleType": { + "description": "Gets or sets the type of the scale.", + "default": "Automatic", + "$ref": "#/definitions/SkuScaleType" + } + }, + "additionalProperties": false + }, + "SkuResource": { + "description": "Fulfills ARM Contract requirement to list all available SKUS for a resource.", + "type": "object", + "properties": { + "capacity": { + "description": "Gets or sets the Sku Capacity.", + "$ref": "#/definitions/SkuCapacity", + "x-nullable": true + }, + "resourceType": { + "description": "The resource type name.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "sku": { + "description": "Gets or sets the Sku.", + "$ref": "#/definitions/SkuSetting", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "SkuResourceArmPaginatedResult": { + "description": "A paginated list of SkuResource entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of SkuResource objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type SkuResource.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuResource" + }, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "SkuScaleType": { + "description": "Node scaling setting for the compute sku.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuScaleType", + "modelAsString": true, + "values": [ + { + "value": "Automatic", + "description": "Automatically scales node count." + }, + { + "value": "Manual", + "description": "Node count scaled upon user request." + }, + { + "value": "None", + "description": "Fixed set of nodes." + } + ] + }, + "additionalProperties": false + }, + "SkuSetting": { + "description": "SkuSetting fulfills the need for stripped down SKU info in ARM contract.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "[Required] The name of the SKU. Ex - P3. It is typically a letter+number code.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "tier": { + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", + "default": "Basic", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + } + }, + "additionalProperties": false + }, + "SparkJob": { + "description": "Spark job definition.", + "required": [ + "codeId", + "entry" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "archives": { + "description": "Archive files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "args": { + "description": "Arguments for the job.", + "type": "string", + "example": " --input abfss://blob-container@testgen2.dfs.core.windows.net/mltable", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "codeId": { + "format": "arm-id", + "description": "[Required] arm-id of the code asset.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "conf": { + "description": "Spark configured properties.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "example": [ + { + "spark.driver.memory": "2g" + } + ], + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "entry": { + "description": "[Required] The entry to execute on startup of the job.", + "$ref": "#/definitions/SparkJobEntry", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentId": { + "format": "arm-id", + "description": "The ARM resource ID of the Environment specification for the job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "files": { + "description": "Files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Mapping of input data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jars": { + "description": "Jar files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "pyFiles": { + "description": "Python files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "$ref": "#/definitions/SparkResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Spark", + "additionalProperties": false + }, + "SparkJobEntry": { + "description": "Spark job entry point definition.", + "required": [ + "sparkJobEntryType" + ], + "type": "object", + "properties": { + "sparkJobEntryType": { + "description": "[Required] Type of the job's entry point.", + "$ref": "#/definitions/SparkJobEntryType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "sparkJobEntryType" + }, + "SparkJobEntryType": { + "enum": [ + "SparkJobPythonEntry", + "SparkJobScalaEntry" + ], + "type": "string", + "x-ms-enum": { + "name": "SparkJobEntryType", + "modelAsString": true, + "values": [ + { + "value": "SparkJobPythonEntry" + }, + { + "value": "SparkJobScalaEntry" + } + ] + }, + "additionalProperties": false + }, + "SparkJobPythonEntry": { + "required": [ + "file" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SparkJobEntry" + } + ], + "properties": { + "file": { + "description": "[Required] Relative python file path for job entry point.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "train.py", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "SparkJobPythonEntry", + "additionalProperties": false + }, + "SparkJobScalaEntry": { + "required": [ + "className" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SparkJobEntry" + } + ], + "properties": { + "className": { + "description": "[Required] Scala class name used as entry point.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "microsoft.aml.sample.myapp", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "SparkJobScalaEntry", + "additionalProperties": false + }, + "SparkResourceConfiguration": { + "type": "object", + "properties": { + "instanceType": { + "description": "Optional type of VM used as supported by the compute target.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "runtimeVersion": { + "description": "Version of spark runtime used for the job.", + "default": "3.1", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "StackEnsembleSettings": { + "description": "Advances setting to customize StackEnsemble run.", + "type": "object", + "properties": { + "stackMetaLearnerKWargs": { + "description": "Optional parameters to pass to the initializer of the meta-learner.", + "type": "object", + "x-nullable": true + }, + "stackMetaLearnerTrainPercentage": { + "format": "double", + "description": "Specifies the proportion of the training set (when choosing train and validation type of training) to be reserved for training the meta-learner. Default value is 0.2.", + "default": 0.2, + "type": "number" + }, + "stackMetaLearnerType": { + "description": "The meta-learner is a model trained on the output of the individual heterogeneous models.", + "default": "None", + "$ref": "#/definitions/StackMetaLearnerType" + } + }, + "additionalProperties": false + }, + "StackMetaLearnerType": { + "description": "The meta-learner is a model trained on the output of the individual heterogeneous models.\r\nDefault meta-learners are LogisticRegression for classification tasks (or LogisticRegressionCV if cross-validation is enabled) and ElasticNet for regression/forecasting tasks (or ElasticNetCV if cross-validation is enabled).\r\nThis parameter can be one of the following strings: LogisticRegression, LogisticRegressionCV, LightGBMClassifier, ElasticNet, ElasticNetCV, LightGBMRegressor, or LinearRegression", + "enum": [ + "None", + "LogisticRegression", + "LogisticRegressionCV", + "LightGBMClassifier", + "ElasticNet", + "ElasticNetCV", + "LightGBMRegressor", + "LinearRegression" + ], + "type": "string", + "x-ms-enum": { + "name": "StackMetaLearnerType", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "LogisticRegression", + "description": "Default meta-learners are LogisticRegression for classification tasks." + }, + { + "value": "LogisticRegressionCV", + "description": "Default meta-learners are LogisticRegression for classification task when CV is on." + }, + { + "value": "LightGBMClassifier" + }, + { + "value": "ElasticNet", + "description": "Default meta-learners are LogisticRegression for regression task." + }, + { + "value": "ElasticNetCV", + "description": "Default meta-learners are LogisticRegression for regression task when CV is on." + }, + { + "value": "LightGBMRegressor" + }, + { + "value": "LinearRegression" + } + ] + }, + "additionalProperties": false + }, + "StaticInputData": { + "description": "Static input data definition.", + "required": [ + "windowEnd", + "windowStart" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringInputDataBase" + } + ], + "properties": { + "preprocessingComponentId": { + "description": "Reference to the component asset used to preprocess the data.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "windowEnd": { + "format": "date-time", + "description": "[Required] The end date of the data window.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "windowStart": { + "format": "date-time", + "description": "[Required] The start date of the data window.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Static", + "additionalProperties": false + }, + "StochasticOptimizer": { + "description": "Stochastic optimizer for image models.", + "enum": [ + "None", + "Sgd", + "Adam", + "Adamw" + ], + "type": "string", + "x-ms-enum": { + "name": "StochasticOptimizer", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No optimizer selected." + }, + { + "value": "Sgd", + "description": "Stochastic Gradient Descent optimizer." + }, + { + "value": "Adam", + "description": "Adam is algorithm the optimizes stochastic objective functions based on adaptive estimates of moments" + }, + { + "value": "Adamw", + "description": "AdamW is a variant of the optimizer Adam that has an improved implementation of weight decay." + } + ] + }, + "additionalProperties": false + }, + "SweepJob": { + "description": "Sweep job definition.", + "required": [ + "objective", + "samplingAlgorithm", + "searchSpace", + "trial" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "earlyTermination": { + "description": "Early termination policies enable canceling poor-performing runs before they complete", + "$ref": "#/definitions/EarlyTerminationPolicy", + "x-nullable": true + }, + "inputs": { + "description": "Mapping of input data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "limits": { + "description": "Sweep Job limit.", + "default": "{}", + "$ref": "#/definitions/SweepJobLimits", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "objective": { + "description": "[Required] Optimization objective.", + "$ref": "#/definitions/Objective" + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "samplingAlgorithm": { + "description": "[Required] The hyperparameter sampling algorithm", + "$ref": "#/definitions/SamplingAlgorithm" + }, + "searchSpace": { + "description": "[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter", + "type": "object" + }, + "trial": { + "description": "[Required] Trial component definition.", + "$ref": "#/definitions/TrialComponent" + } + }, + "x-ms-discriminator-value": "Sweep", + "additionalProperties": false + }, + "SweepJobLimits": { + "description": "Sweep Job limit class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobLimits" + } + ], + "properties": { + "maxConcurrentTrials": { + "format": "int32", + "description": "Sweep Job max concurrent trials.", + "type": "integer", + "x-nullable": true + }, + "maxTotalTrials": { + "format": "int32", + "description": "Sweep Job max total trials.", + "type": "integer", + "x-nullable": true + }, + "trialTimeout": { + "format": "duration", + "description": "Sweep Job Trial timeout value.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Sweep", + "additionalProperties": false + }, + "TableVertical": { + "description": "Abstract class for AutoML tasks that use table dataset as input - such as Classification/Regression/Forecasting.", + "type": "object", + "properties": { + "cvSplitColumnNames": { + "description": "Columns to use for CVSplit data.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "featurizationSettings": { + "description": "Featurization inputs needed for AutoML job.", + "$ref": "#/definitions/TableVerticalFeaturizationSettings", + "x-nullable": true + }, + "limitSettings": { + "description": "Execution constraints for AutoMLJob.", + "$ref": "#/definitions/TableVerticalLimitSettings", + "x-nullable": true + }, + "nCrossValidations": { + "description": "Number of cross validation folds to be applied on training dataset\r\nwhen validation dataset is not provided.", + "$ref": "#/definitions/NCrossValidations", + "x-nullable": true + }, + "testData": { + "description": "Test data input.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, + "testDataSize": { + "format": "double", + "description": "The fraction of test dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + }, + "validationData": { + "description": "Validation data inputs.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, + "validationDataSize": { + "format": "double", + "description": "The fraction of training dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + }, + "weightColumnName": { + "description": "The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "TableVerticalFeaturizationSettings": { + "description": "Featurization Configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeaturizationSettings" + } + ], + "properties": { + "blockedTransformers": { + "description": "These transformers shall not be used in featurization.", + "type": "array", + "items": { + "$ref": "#/definitions/BlockedTransformers" + }, + "x-nullable": true + }, + "columnNameAndTypes": { + "description": "Dictionary of column name and its type (int, float, string, datetime etc).", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "enableDnnFeaturization": { + "description": "Determines whether to use Dnn based featurizers for data featurization.", + "default": false, + "type": "boolean" + }, + "mode": { + "description": "Featurization mode - User can keep the default 'Auto' mode and AutoML will take care of necessary transformation of the data in featurization phase.\r\nIf 'Off' is selected then no featurization is done.\r\nIf 'Custom' is selected then user can specify additional inputs to customize how featurization is done.", + "default": "Auto", + "$ref": "#/definitions/FeaturizationMode" + }, + "transformerParams": { + "description": "User can specify additional transformers to be used along with the columns to which it would be applied and parameters for the transformer constructor.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/ColumnTransformer" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "TableVerticalLimitSettings": { + "description": "Job execution constraints.", + "type": "object", + "properties": { + "enableEarlyTermination": { + "description": "Enable early termination, determines whether or not if AutoMLJob will terminate early if there is no score improvement in last 20 iterations.", + "default": true, + "type": "boolean" + }, + "exitScore": { + "format": "double", + "description": "Exit score for the AutoML job.", + "type": "number", + "x-nullable": true + }, + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum Concurrent iterations.", + "default": 1, + "type": "integer" + }, + "maxCoresPerTrial": { + "format": "int32", + "description": "Max cores per iteration.", + "default": -1, + "type": "integer" + }, + "maxTrials": { + "format": "int32", + "description": "Number of iterations.", + "default": 1000, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "PT6H", + "type": "string" + }, + "trialTimeout": { + "format": "duration", + "description": "Iteration timeout.", + "default": "PT30M", + "type": "string" + } + }, + "additionalProperties": false + }, + "TargetAggregationFunction": { + "description": "Target aggregate function.", + "enum": [ + "None", + "Sum", + "Max", + "Min", + "Mean" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetAggregationFunction", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Represent no value set." + }, + { + "value": "Sum" + }, + { + "value": "Max" + }, + { + "value": "Min" + }, + { + "value": "Mean" + } + ] + }, + "additionalProperties": false + }, + "TargetLags": { + "description": "The number of past periods to lag from the target column.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Set target lags mode - Auto/Custom", + "$ref": "#/definitions/TargetLagsMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "TargetLagsMode": { + "description": "Target lags selection modes.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetLagsMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Target lags to be determined automatically." + }, + { + "value": "Custom", + "description": "Use the custom target lags." + } + ] + }, + "additionalProperties": false + }, + "TargetRollingWindowSize": { + "description": "Forecasting target rolling window size.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] TargetRollingWindowSiz detection mode.", + "$ref": "#/definitions/TargetRollingWindowSizeMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "TargetRollingWindowSizeMode": { + "description": "Target rolling windows size mode.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetRollingWindowSizeMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Determine rolling windows size automatically." + }, + { + "value": "Custom", + "description": "Use the specified rolling window size." + } + ] + }, + "additionalProperties": false + }, + "TargetUtilizationScaleSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineScaleSettings" + } + ], + "properties": { + "maxInstances": { + "format": "int32", + "description": "The maximum number of instances that the deployment can scale to. The quota will be reserved for max_instances.", + "default": 1, + "type": "integer" + }, + "minInstances": { + "format": "int32", + "description": "The minimum number of instances to always be present.", + "default": 1, + "type": "integer" + }, + "pollingInterval": { + "format": "duration", + "description": "The polling interval in ISO 8691 format. Only supports duration with precision as low as Seconds.", + "default": "PT1S", + "type": "string" + }, + "targetUtilizationPercentage": { + "format": "int32", + "description": "Target CPU usage for the autoscaler.", + "default": 70, + "type": "integer" + } + }, + "x-ms-discriminator-value": "TargetUtilization", + "additionalProperties": false + }, + "TaskType": { + "description": "AutoMLJob Task type.", + "enum": [ + "Classification", + "Regression", + "Forecasting", + "ImageClassification", + "ImageClassificationMultilabel", + "ImageObjectDetection", + "ImageInstanceSegmentation", + "TextClassification", + "TextClassificationMultilabel", + "TextNER" + ], + "type": "string", + "x-ms-enum": { + "name": "TaskType", + "modelAsString": true, + "values": [ + { + "value": "Classification", + "description": "Classification in machine learning and statistics is a supervised learning approach in which\nthe computer program learns from the data given to it and make new observations or classifications." + }, + { + "value": "Regression", + "description": "Regression means to predict the value using the input data. Regression models are used to predict a continuous value." + }, + { + "value": "Forecasting", + "description": "Forecasting is a special kind of regression task that deals with time-series data and creates forecasting model\nthat can be used to predict the near future values based on the inputs." + }, + { + "value": "ImageClassification", + "description": "Image Classification. Multi-class image classification is used when an image is classified with only a single label\nfrom a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'." + }, + { + "value": "ImageClassificationMultilabel", + "description": "Image Classification Multilabel. Multi-label image classification is used when an image could have one or more labels\nfrom a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'." + }, + { + "value": "ImageObjectDetection", + "description": "Image Object Detection. Object detection is used to identify objects in an image and locate each object with a\nbounding box e.g. locate all dogs and cats in an image and draw a bounding box around each." + }, + { + "value": "ImageInstanceSegmentation", + "description": "Image Instance Segmentation. Instance segmentation is used to identify objects in an image at the pixel level,\ndrawing a polygon around each object in the image." + }, + { + "value": "TextClassification", + "description": "Text classification (also known as text tagging or text categorization) is the process of sorting texts into categories.\nCategories are mutually exclusive." + }, + { + "value": "TextClassificationMultilabel", + "description": "Multilabel classification task assigns each sample to a group (zero or more) of target labels." + }, + { + "value": "TextNER", + "description": "Text Named Entity Recognition a.k.a. TextNER.\nNamed Entity Recognition (NER) is the ability to take free-form text and identify the occurrences of entities such as people, locations, organizations, and more." + } + ] + }, + "additionalProperties": false + }, + "TensorFlow": { + "description": "TensorFlow distribution configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + } + ], + "properties": { + "parameterServerCount": { + "format": "int32", + "description": "Number of parameter server tasks.", + "default": 0, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "workerCount": { + "format": "int32", + "description": "Number of workers. If not specified, will default to the instance count.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "TensorFlow", + "additionalProperties": false + }, + "TextClassification": { + "description": "Text Classification task in AutoML NLP vertical.\r\nNLP - Natural Language Processing.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NlpVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for Text-Classification task.", + "default": "Accuracy", + "$ref": "#/definitions/ClassificationPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "TextClassification", + "additionalProperties": false + }, + "TextClassificationMultilabel": { + "description": "Text Classification Multilabel task in AutoML NLP vertical.\r\nNLP - Natural Language Processing.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NlpVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for Text-Classification-Multilabel task.\r\nCurrently only Accuracy is supported as primary metric, hence user need not set it explicitly.", + "$ref": "#/definitions/ClassificationMultilabelPrimaryMetrics", + "readOnly": true + } + }, + "x-ms-discriminator-value": "TextClassificationMultilabel", + "additionalProperties": false + }, + "TextNer": { + "description": "Text-NER task in AutoML NLP vertical.\r\nNER - Named Entity Recognition.\r\nNLP - Natural Language Processing.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NlpVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for Text-NER task.\r\nOnly 'Accuracy' is supported for Text-NER, so user need not set this explicitly.", + "$ref": "#/definitions/ClassificationPrimaryMetrics", + "readOnly": true + } + }, + "x-ms-discriminator-value": "TextNER", + "additionalProperties": false + }, + "TopNFeaturesByAttribution": { + "required": [ + "filterType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringFeatureFilterBase" + } + ], + "properties": { + "top": { + "format": "int32", + "description": "The number of top features to include.", + "default": 10, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "TopNByAttribution", + "additionalProperties": false + }, + "TrainingSettings": { + "description": "Training related configuration.", + "type": "object", + "properties": { + "enableDnnTraining": { + "description": "Enable recommendation of DNN models.", + "default": false, + "type": "boolean" + }, + "enableModelExplainability": { + "description": "Flag to turn on explainability on best model.", + "default": true, + "type": "boolean" + }, + "enableOnnxCompatibleModels": { + "description": "Flag for enabling onnx compatible models.", + "default": false, + "type": "boolean" + }, + "enableStackEnsemble": { + "description": "Enable stack ensemble run.", + "default": true, + "type": "boolean" + }, + "enableVoteEnsemble": { + "description": "Enable voting ensemble run.", + "default": true, + "type": "boolean" + }, + "ensembleModelDownloadTimeout": { + "format": "duration", + "description": "During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded.\r\nConfigure this parameter with a higher value than 300 secs, if more time is needed.", + "default": "PT5M", + "type": "string" + }, + "stackEnsembleSettings": { + "description": "Stack ensemble settings for stack ensemble run.", + "$ref": "#/definitions/StackEnsembleSettings", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "TrialComponent": { + "description": "Trial component definition.", + "required": [ + "command", + "environmentId" + ], + "type": "object", + "properties": { + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "command": { + "description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "distribution": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "$ref": "#/definitions/DistributionConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentId": { + "description": "[Required] The ARM resource ID of the Environment specification for the job.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "TriggerBase": { + "required": [ + "triggerType" + ], + "type": "object", + "properties": { + "endTime": { + "description": "Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601.\r\nRecommented format would be \"2022-06-01T00:00:01\"\r\nIf not present, the schedule will run indefinitely", + "type": "string", + "x-nullable": true + }, + "startTime": { + "description": "Specifies start time of schedule in ISO 8601 format, but without a UTC offset.", + "type": "string", + "x-nullable": true + }, + "timeZone": { + "description": "Specifies time zone in which the schedule runs.\r\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11", + "default": "UTC", + "type": "string" + }, + "triggerType": { + "description": "[Required] ", + "$ref": "#/definitions/TriggerType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "discriminator": "triggerType" + }, + "TriggerType": { + "enum": [ + "Recurrence", + "Cron" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerType", + "modelAsString": true, + "values": [ + { + "value": "Recurrence" + }, + { + "value": "Cron" + } + ] + }, + "additionalProperties": false + }, + "TritonModelJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "triton_model", + "additionalProperties": false + }, + "TritonModelJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "triton_model", + "additionalProperties": false + }, + "TruncationSelectionPolicy": { + "description": "Defines an early termination policy that cancels a given percentage of runs at each evaluation interval.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EarlyTerminationPolicy" + } + ], + "properties": { + "truncationPercentage": { + "format": "int32", + "description": "The percentage of runs to cancel at each evaluation interval.", + "default": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "TruncationSelection", + "additionalProperties": false + }, + "UriFileDataVersion": { + "description": "uri-file data version entity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataVersionBase" + } + ], + "x-ms-discriminator-value": "uri_file", + "additionalProperties": false + }, + "UriFileJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "uri_file", + "additionalProperties": false + }, + "UriFileJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "uri_file", + "additionalProperties": false + }, + "UriFolderDataVersion": { + "description": "uri-folder data version entity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataVersionBase" + } + ], + "x-ms-discriminator-value": "uri_folder", + "additionalProperties": false + }, + "UriFolderJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "uri_folder", + "additionalProperties": false + }, + "UriFolderJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "uri_folder", + "additionalProperties": false + }, + "UseStl": { + "description": "Configure STL Decomposition of the time-series target column.", + "enum": [ + "None", + "Season", + "SeasonTrend" + ], + "type": "string", + "x-ms-enum": { + "name": "UseStl", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No stl decomposition." + }, + { + "value": "Season" + }, + { + "value": "SeasonTrend" + } + ] + }, + "additionalProperties": false + }, + "UserIdentity": { + "description": "User identity configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IdentityConfiguration" + } + ], + "x-ms-discriminator-value": "UserIdentity", + "additionalProperties": false + }, + "ValidationMetricType": { + "description": "Metric computation method to use for validation metrics in image tasks.", + "enum": [ + "None", + "Coco", + "Voc", + "CocoVoc" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationMetricType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No metric." + }, + { + "value": "Coco", + "description": "Coco metric." + }, + { + "value": "Voc", + "description": "Voc metric." + }, + { + "value": "CocoVoc", + "description": "CocoVoc metric." + } + ] + }, + "additionalProperties": false + }, + "Webhook": { + "description": "Webhook base", + "required": [ + "webhookType" + ], + "type": "object", + "properties": { + "eventType": { + "description": "Send callback on a specified notification event", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "webhookType": { + "description": "[Required] Specifies the type of service to send a callback", + "$ref": "#/definitions/WebhookType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "webhookType" + }, + "WebhookType": { + "description": "Enum to determine the webhook callback service type.", + "enum": [ + "AzureDevOps" + ], + "type": "string", + "x-ms-enum": { + "name": "WebhookType", + "modelAsString": true, + "values": [ + { + "value": "AzureDevOps" + } + ] + }, + "additionalProperties": false + }, + "WeekDay": { + "description": "Enum of weekday", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true, + "values": [ + { + "value": "Monday", + "description": "Monday weekday" + }, + { + "value": "Tuesday", + "description": "Tuesday weekday" + }, + { + "value": "Wednesday", + "description": "Wednesday weekday" + }, + { + "value": "Thursday", + "description": "Thursday weekday" + }, + { + "value": "Friday", + "description": "Friday weekday" + }, + { + "value": "Saturday", + "description": "Saturday weekday" + }, + { + "value": "Sunday", + "description": "Sunday weekday" + } + ] + }, + "additionalProperties": false + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/registries.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/registries.json new file mode 100644 index 000000000000..469254245ee2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/registries.json @@ -0,0 +1,876 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/registries": { + "get": { + "tags": [ + "RegistryManagement" + ], + "summary": "List registries by subscription", + "operationId": "Registries_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List registries by subscription.": { + "$ref": "./examples/Registries/listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries": { + "get": { + "tags": [ + "RegistryManagement" + ], + "summary": "List registries", + "operationId": "Registries_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List registries with system created accounts.": { + "$ref": "./examples/Registries/list-SystemCreated.json" + }, + "List registries with user created accounts.": { + "$ref": "./examples/Registries/list-UserCreated.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}": { + "delete": { + "tags": [ + "RegistryManagement" + ], + "summary": "Delete registry", + "operationId": "Registries_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No content" + } + }, + "x-ms-examples": { + "Delete Registry.": { + "$ref": "./examples/Registries/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "RegistryManagement" + ], + "summary": "Get registry", + "operationId": "Registries_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + }, + "x-ms-examples": { + "Get Registry with system created accounts.": { + "$ref": "./examples/Registries/get-SystemCreated.json" + }, + "Get Registry with user created accounts.": { + "$ref": "./examples/Registries/get-UserCreated.json" + } + } + }, + "patch": { + "tags": [ + "RegistryManagement" + ], + "summary": "Update tags", + "operationId": "Registries_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Details required to create the registry.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialRegistryPartialTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + }, + "x-ms-examples": { + "Update Registry with system created accounts.": { + "$ref": "./examples/Registries/update-SystemCreated.json" + }, + "Update Registry with user created accounts.": { + "$ref": "./examples/Registries/update-UserCreated.json" + } + } + }, + "put": { + "tags": [ + "RegistryManagement" + ], + "summary": "Create or update registry", + "operationId": "Registries_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Details required to create the registry.", + "required": true, + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry with system created accounts.": { + "$ref": "./examples/Registries/createOrUpdate-SystemCreated.json" + }, + "CreateOrUpdate Registry with user created accounts.": { + "$ref": "./examples/Registries/createOrUpdate-UserCreated.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/removeRegions": { + "post": { + "tags": [ + "RegistryManagement" + ], + "summary": "Remove regions from registry", + "operationId": "Registries_RemoveRegions", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Details required to create the registry.", + "required": true, + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Remove regions from registry": { + "$ref": "./examples/Registries/removeRegions.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "AcrDetails": { + "description": "Details of ACR account to be used for the Registry", + "type": "object", + "properties": { + "systemCreatedAcrAccount": { + "description": "Details of system created ACR account to be used for the Registry", + "$ref": "#/definitions/SystemCreatedAcrAccount", + "x-nullable": true + }, + "userCreatedAcrAccount": { + "description": "Details of user created ACR account to be used for the Registry", + "$ref": "#/definitions/UserCreatedAcrAccount", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ArmResourceId": { + "description": "ARM ResourceId of a resource", + "type": "object", + "properties": { + "resourceId": { + "description": "Arm ResourceId is in the format \"/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}\"\r\nor \"/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}\"", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointServiceConnectionStatus": { + "description": "Connection status of the service consumer with the service provider", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointServiceConnectionStatus", + "modelAsString": true + }, + "additionalProperties": false + }, + "RegistryPartialManagedServiceIdentity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + } + ], + "additionalProperties": false + }, + "PartialRegistry": { + "description": "Partial Registry class for PATCH", + "type": "object", + "additionalProperties": false + }, + "PartialRegistryPartialTrackedResource": { + "description": "Strictly used in update requests.", + "type": "object", + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "#/definitions/RegistryPartialManagedServiceIdentity" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "#/definitions/PartialSku" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "PartialSku": { + "description": "Common SKU definition.", + "type": "object", + "properties": { + "capacity": { + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.", + "type": "integer" + }, + "family": { + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "name": { + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code.", + "type": "string" + }, + "size": { + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.", + "type": "string" + }, + "tier": { + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + } + }, + "additionalProperties": false + }, + "RegistryPrivateEndpointConnection": { + "description": "Private endpoint connection definition.", + "type": "object", + "properties": { + "id": { + "description": "This is the private endpoint connection name created on SRP\r\nFull resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName}", + "type": "string", + "x-nullable": true + }, + "location": { + "description": "Same as workspace location.", + "type": "string", + "x-nullable": true, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the Private Endpoint Connection", + "$ref": "#/definitions/RegistryPrivateEndpointConnectionProperties", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RegistryPrivateEndpointConnectionProperties": { + "description": "Properties of the Private Endpoint Connection", + "type": "object", + "properties": { + "groupIds": { + "description": "The group ids", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "privateEndpoint": { + "description": "The PE network resource that is linked to this PE connection.", + "$ref": "#/definitions/PrivateEndpointResource", + "x-nullable": true + }, + "registryPrivateLinkServiceConnectionState": { + "description": "The connection state.", + "$ref": "#/definitions/RegistryPrivateLinkServiceConnectionState", + "x-nullable": true + }, + "provisioningState": { + "description": "One of null, \"Succeeded\", \"Provisioning\", \"Failed\". While not approved, it's null.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PrivateEndpointResource": { + "description": "The PE network resource that is linked to this PE connection.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpoint" + } + ], + "properties": { + "subnetArmId": { + "description": "The subnetId that the private endpoint is connected to.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RegistryPrivateLinkServiceConnectionState": { + "description": "The connection state.", + "type": "object", + "properties": { + "actionsRequired": { + "description": "Some RP chose \"None\". Other RPs use this for region expansion.", + "type": "string", + "x-nullable": true + }, + "description": { + "description": "User-defined message that, per NRP doc, may be used for approval-related message.", + "type": "string", + "x-nullable": true + }, + "status": { + "description": "Connection status of the service consumer with the service provider", + "$ref": "#/definitions/EndpointServiceConnectionStatus" + } + }, + "additionalProperties": false + }, + "Registry": { + "description": "Details of the Registry", + "type": "object", + "properties": { + "discoveryUrl": { + "description": "Discovery URL for the Registry", + "type": "string", + "x-nullable": true + }, + "intellectualPropertyPublisher": { + "description": "IntellectualPropertyPublisher for the registry", + "type": "string", + "x-nullable": true + }, + "managedResourceGroup": { + "description": "ResourceId of the managed RG if the registry has system created resources", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + }, + "mlFlowRegistryUri": { + "description": "MLFlow Registry URI for the Registry", + "type": "string", + "x-nullable": true + }, + "registryPrivateEndpointConnections": { + "description": "Private endpoint connections info used for pending connections in private link portal", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryPrivateEndpointConnection" + }, + "x-nullable": true + }, + "publicNetworkAccess": { + "description": "Is the Registry accessible from the internet?\r\nPossible values: \"Enabled\" or \"Disabled\"", + "type": "string", + "x-nullable": true + }, + "regionDetails": { + "description": "Details of each region the registry is in", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryRegionArmDetails" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "x-ms-client-name": "RegistryProperties", + "additionalProperties": false + }, + "RegistryRegionArmDetails": { + "description": "Details for each region the registry is in", + "type": "object", + "properties": { + "acrDetails": { + "description": "List of ACR accounts", + "type": "array", + "items": { + "$ref": "#/definitions/AcrDetails" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "location": { + "description": "The location where the registry exists", + "type": "string", + "x-nullable": true + }, + "storageAccountDetails": { + "description": "List of storage accounts", + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountDetails" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "RegistryTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Registry" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "Registry", + "additionalProperties": false + }, + "RegistryTrackedResourceArmPaginatedResult": { + "description": "A paginated list of Registry entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Registry objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Registry.", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + }, + "additionalProperties": false + }, + "StorageAccountDetails": { + "description": "Details of storage account to be used for the Registry", + "type": "object", + "properties": { + "systemCreatedStorageAccount": { + "description": "Details of system created storage account to be used for the registry", + "$ref": "#/definitions/SystemCreatedStorageAccount", + "x-nullable": true + }, + "userCreatedStorageAccount": { + "description": "Details of user created storage account to be used for the registry", + "$ref": "#/definitions/UserCreatedStorageAccount", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "SystemCreatedAcrAccount": { + "type": "object", + "properties": { + "acrAccountName": { + "description": "Name of the ACR account", + "type": "string", + "x-nullable": true + }, + "acrAccountSku": { + "description": "SKU of the ACR account", + "type": "string", + "x-nullable": true + }, + "armResourceId": { + "description": "This is populated once the ACR account is created.", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "SystemCreatedStorageAccount": { + "type": "object", + "properties": { + "allowBlobPublicAccess": { + "description": "Public blob access allowed", + "type": "boolean" + }, + "armResourceId": { + "description": "This is populated once the storage account is created.", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + }, + "storageAccountHnsEnabled": { + "description": "HNS enabled for storage account", + "type": "boolean" + }, + "storageAccountName": { + "description": "Name of the storage account", + "type": "string", + "x-nullable": true + }, + "storageAccountType": { + "description": "Allowed values:\r\n\"Standard_LRS\",\r\n\"Standard_GRS\",\r\n\"Standard_RAGRS\",\r\n\"Standard_ZRS\",\r\n\"Standard_GZRS\",\r\n\"Standard_RAGZRS\",\r\n\"Premium_LRS\",\r\n\"Premium_ZRS\"", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "UserCreatedAcrAccount": { + "type": "object", + "properties": { + "armResourceId": { + "description": "ARM ResourceId of a resource", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "UserCreatedStorageAccount": { + "type": "object", + "properties": { + "armResourceId": { + "description": "ARM ResourceId of a resource", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + } + }, + "additionalProperties": false + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "parameters": { + "RegistryNameParameter": { + "name": "registryName", + "description": "Name of Azure Machine Learning registry. This is case-insensitive", + "in": "path", + "type": "string", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/workspaceFeatures.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/workspaceFeatures.json new file mode 100644 index 000000000000..dace57fd8e79 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/workspaceFeatures.json @@ -0,0 +1,114 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/features": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all enabled features for a workspace", + "operationId": "WorkspaceFeatures_List", + "x-ms-examples": { + "List Workspace features": { + "$ref": "./examples/WorkspaceFeature/list.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListAmlUserFeatureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AmlUserFeature": { + "description": "Features enabled for a workspace", + "type": "object", + "properties": { + "id": { + "description": "Specifies the feature ID", + "type": "string" + }, + "displayName": { + "description": "Specifies the feature name ", + "type": "string" + }, + "description": { + "description": "Describes the feature for user experience", + "type": "string" + } + } + }, + "ListAmlUserFeatureResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlUserFeature" + }, + "description": "The list of AML user facing features." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML user features information. Call ListNext() with this to fetch the next page of AML user features information." + } + }, + "description": "The List Aml user feature operation response." + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/workspaceRP.json new file mode 100644 index 000000000000..6fd7a07dbc2d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-10-01/workspaceRP.json @@ -0,0 +1,3706 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.MachineLearningServices/operations": { + "get": { + "tags": [ + "Operation" + ], + "description": "Lists all of the available Azure Machine Learning Workspaces REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/Workspace/operationsList.json" + } + }, + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Gets the properties of the specified machine learning workspace.", + "operationId": "Workspaces_Get", + "x-ms-examples": { + "Get Workspace": { + "$ref": "./examples/Workspace/get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Workspaces" + ], + "description": "Creates or updates a workspace with the specified parameters.", + "operationId": "Workspaces_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Workspace": { + "$ref": "./examples/Workspace/create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for creating or updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "description": "Deletes a machine learning workspace.", + "operationId": "Workspaces_Delete", + "x-ms-examples": { + "Delete Workspace": { + "$ref": "./examples/Workspace/delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceForceToPurgeParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "The machine learning workspace does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "description": "Updates a machine learning workspace with the specified parameters.", + "operationId": "Workspaces_Update", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Workspace": { + "$ref": "./examples/Workspace/update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available machine learning workspaces under the specified resource group.", + "operationId": "Workspaces_ListByResourceGroup", + "x-ms-examples": { + "Get Workspaces by Resource Group": { + "$ref": "./examples/Workspace/listByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { + "post": { + "tags": [ + "Workspaces" + ], + "summary": "Diagnose workspace setup issue.", + "operationId": "Workspaces_Diagnose", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameter of diagnosing workspace health", + "schema": { + "$ref": "#/definitions/DiagnoseWorkspaceParameters" + } + } + ], + "responses": { + "202": { + "description": "Success", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DiagnoseResponseResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Diagnose Workspace": { + "$ref": "./examples/Workspace/diagnose.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ListKeys", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListWorkspaceKeysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ResyncKeys", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resync Workspace Keys": { + "$ref": "./examples/Workspace/resyncKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available machine learning workspaces under the specified subscription.", + "operationId": "Workspaces_ListBySubscription", + "x-ms-examples": { + "Get Workspaces by subscription": { + "$ref": "./examples/Workspace/listBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "return notebook access token and refresh token", + "operationId": "Workspaces_ListNotebookAccessToken", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listNotebookAccessToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NotebookAccessTokenResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "description": "List all the private endpoint connections associated with the workspace.", + "x-ms-examples": { + "StorageAccountListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnection/list.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspaceGetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "description": "Update the state of specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspaceDeletePrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "WorkspacePrivateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "description": "Gets the private link resources that need to be created for a workspace.", + "x-ms-examples": { + "WorkspaceListPrivateLinkResources": { + "$ref": "./examples/PrivateLinkResource/list.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/prepareNotebook": { + "post": { + "tags": [ + "ProxyOperations" + ], + "operationId": "Workspaces_PrepareNotebook", + "description": "Prepare a notebook.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Prepare Notebook": { + "$ref": "./examples/Notebook/prepare.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NotebookResourceInfo" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "operationId": "Workspaces_ListStorageAccountKeys", + "description": "List storage account keys of a workspace.", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listStorageAccountKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListStorageAccountKeysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "operationId": "Workspaces_ListNotebookKeys", + "description": "List keys of a notebook.", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Notebook/listKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListNotebookKeysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": { + "put": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "operationId": "WorkspaceConnections_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The object for creating or updating a new workspace connection", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/create.json" + } + } + }, + "get": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "operationId": "WorkspaceConnections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/get.json" + } + } + }, + "delete": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "operationId": "WorkspaceConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "Success" + } + }, + "x-ms-examples": { + "DeleteWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/delete.json" + } + } + }, + "patch": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "Update machine learning workspaces connections under the specified workspace.", + "operationId": "WorkspaceConnections_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Parameters for workspace connection update.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionUpdateParameter" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { + "get": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "operationId": "WorkspaceConnections_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/TargetParameter" + }, + { + "$ref": "#/parameters/CategoryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "includeAll", + "description": "query parameter that indicates if get connection call should return both connections and datastores", + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListWorkspaceConnections": { + "$ref": "./examples/WorkspaceConnection/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { + "post": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "List all the secrets of a machine learning workspaces connections.", + "operationId": "WorkspaceConnections_ListSecrets", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/listSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "OutboundNetworkDependenciesEndpoints" + ], + "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", + "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExternalFQDNResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListOutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/ExternalFQDN/get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": { + "get": { + "tags": [ + "ManagedNetwork" + ], + "summary": "Lists the managed network outbound rules for a machine learning workspace.", + "operationId": "ManagedNetworkSettingsRule_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/listRule.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { + "delete": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_Delete", + "summary": "Deletes an outbound rule from the managed network of a machine learning workspace.", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/deleteRule.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_Get", + "summary": "Gets an outbound rule from the managed network of a machine learning workspace.", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/getRule.json" + } + } + }, + "put": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", + "summary": "Creates or updates an outbound rule in the managed network of a machine learning workspace.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "description": "Outbound Rule to be created or updated in the managed network of a machine learning workspace.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/createOrUpdateRule.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/provisionManagedNetwork": { + "post": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork", + "summary": "Provisions the managed network of a machine learning workspace.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Managed Network Provisioning Options for a machine learning workspace.", + "schema": { + "$ref": "#/definitions/ManagedNetworkProvisionOptions" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ManagedNetworkProvisionStatus" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Provision ManagedNetwork": { + "$ref": "./examples/ManagedNetwork/provision.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "parameters": { + "WorkspaceNameParameter": { + "name": "workspaceName", + "description": "Name of Azure Machine Learning workspace.", + "in": "path", + "type": "string", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$", + "x-ms-parameter-location": "method" + }, + "PaginationParameter": { + "in": "query", + "name": "$skip", + "type": "string", + "description": "Continuation token for pagination.", + "required": false, + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection associated with the workspace", + "x-ms-parameter-location": "method" + }, + "ConnectionName": { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Friendly name of the workspace connection", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "TargetParameter": { + "in": "query", + "name": "target", + "type": "string", + "description": "Target of the workspace connection.", + "required": false, + "x-ms-parameter-location": "method" + }, + "CategoryParameter": { + "in": "query", + "name": "category", + "type": "string", + "description": "Category of the workspace connection.", + "required": false, + "x-ms-parameter-location": "method" + }, + "RuleName": { + "in": "path", + "name": "ruleName", + "description": "Name of the workspace managed network outbound rule", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "WorkspaceForceToPurgeParameter": { + "in": "query", + "name": "forceToPurge", + "description": "Flag to indicate delete is a purge request.", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "Workspace": { + "type": "object", + "description": "An object that represents a machine learning workspace.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceProperties", + "description": "The properties of the machine learning workspace.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "kind": { + "type": "string" + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace." + } + } + }, + "WorkspaceProperties": { + "type": "object", + "description": "The properties of a machine learning workspace.", + "properties": { + "workspaceId": { + "description": "The immutable id associated with this workspace.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" + }, + "keyVault": { + "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace.", + "type": "string", + "x-nullable": true + }, + "storageAccount": { + "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "discoveryUrl": { + "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", + "type": "string" + }, + "provisioningState": { + "type": "string", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning." + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperty", + "description": "The encryption settings of Azure ML workspace." + }, + "hbiWorkspace": { + "type": "boolean", + "description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service", + "default": false + }, + "serviceProvisionedResourceGroup": { + "type": "string", + "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", + "readOnly": true + }, + "privateLinkCount": { + "type": "integer", + "format": "int32", + "description": "Count of private connections in the workspace", + "readOnly": true + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "allowPublicAccessWhenBehindVnet": { + "type": "boolean", + "description": "The flag to indicate whether to allow public access when behind VNet.", + "default": false + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether requests from Public Network are allowed.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of private endpoint connections in the workspace." + }, + "serverlessComputeSettings": { + "description": "Settings for serverless compute created in the workspace", + "$ref": "#/definitions/ServerlessComputeSettings" + }, + "sharedPrivateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of shared private link resources in this workspace." + }, + "notebookInfo": { + "readOnly": true, + "$ref": "#/definitions/NotebookResourceInfo", + "description": "The notebook info of Azure ML workspace." + }, + "serviceManagedResourcesSettings": { + "$ref": "#/definitions/ServiceManagedResourcesSettings", + "description": "The service managed resource settings." + }, + "primaryUserAssignedIdentity": { + "description": "The user assigned identity resource id that represents the workspace identity.", + "type": "string" + }, + "tenantId": { + "description": "The tenant id associated with this workspace.", + "type": "string", + "readOnly": true + }, + "storageHnsEnabled": { + "description": "If the storage associated with the workspace has hierarchical namespace(HNS) enabled.", + "type": "boolean", + "readOnly": true + }, + "mlFlowTrackingUri": { + "description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.", + "type": "string", + "readOnly": true + }, + "v1LegacyMode": { + "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "default": false, + "type": "boolean" + }, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, + "associatedWorkspaces": { + "type": "array", + "items": { + "type": "string" + } + }, + "enableDataIsolation": { + "type": "boolean" + }, + "hubResourceId": { + "type": "string" + }, + "workspaceHubConfig": { + "description": "WorkspaceHub's configuration object.", + "$ref": "#/definitions/WorkspaceHubConfig" + } + } + }, + "WorkspaceUpdateParameters": { + "type": "object", + "description": "The parameters for updating a machine learning workspace.", + "properties": { + "tags": { + "description": "The resource tags for the machine learning workspace.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "properties": { + "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", + "description": "The properties that the machine learning workspace will be updated with.", + "x-ms-client-flatten": true + } + } + }, + "WorkspacePropertiesUpdateParameters": { + "type": "object", + "description": "The parameters for updating the properties of a machine learning workspace.", + "properties": { + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace.", + "type": "string" + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "serviceManagedResourcesSettings": { + "$ref": "#/definitions/ServiceManagedResourcesSettings", + "description": "The service managed resource settings." + }, + "primaryUserAssignedIdentity": { + "description": "The user assigned identity resource id that represents the workspace identity.", + "type": "string" + }, + "serverlessComputeSettings": { + "description": "Settings for serverless compute created in the workspace", + "$ref": "#/definitions/ServerlessComputeSettings" + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether requests from Public Network are allowed.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace.", + "type": "string" + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" + }, + "enableDataIsolation": { + "type": "boolean" + }, + "v1LegacyMode": { + "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "type": "boolean" + }, + "encryption": { + "$ref": "#/definitions/EncryptionUpdateProperties" + } + } + }, + "WorkspaceListResult": { + "type": "object", + "description": "The result of a request to list machine learning workspaces.", + "properties": { + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of machine learning workspaces.", + "type": "string" + } + } + }, + "DiagnoseRequestProperties": { + "type": "object", + "properties": { + "udr": { + "description": "Setting for diagnosing user defined routing", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "nsg": { + "description": "Setting for diagnosing network security group", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "resourceLock": { + "description": "Setting for diagnosing resource lock", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "dnsResolution": { + "description": "Setting for diagnosing dns resolution", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "storageAccount": { + "description": "Setting for diagnosing dependent storage account", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "keyVault": { + "description": "Setting for diagnosing dependent key vault", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "containerRegistry": { + "description": "Setting for diagnosing dependent container registry", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "applicationInsights": { + "description": "Setting for diagnosing dependent application insights", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "others": { + "description": "Setting for diagnosing unclassified category of problems", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "DiagnoseWorkspaceParameters": { + "type": "object", + "description": "Parameters to diagnose a workspace", + "properties": { + "value": { + "description": "Value of Parameters", + "$ref": "#/definitions/DiagnoseRequestProperties" + } + } + }, + "DiagnoseResult": { + "type": "object", + "description": "Result of Diagnose", + "properties": { + "code": { + "description": "Code for workspace setup error", + "type": "string", + "readOnly": true + }, + "level": { + "description": "Level of workspace setup error", + "enum": [ + "Warning", + "Error", + "Information" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DiagnoseResultLevel", + "modelAsString": true + } + }, + "message": { + "description": "Message of workspace setup error", + "type": "string", + "readOnly": true + } + } + }, + "DiagnoseResponseResult": { + "type": "object", + "properties": { + "value": { + "type": "object", + "properties": { + "userDefinedRouteResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "networkSecurityRuleResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "resourceLockResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "dnsResolutionResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "storageAccountResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "keyVaultResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "containerRegistryResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "applicationInsightsResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "otherResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + } + } + } + } + }, + "ListWorkspaceKeysResult": { + "type": "object", + "properties": { + "userStorageKey": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + }, + "userStorageResourceId": { + "readOnly": true, + "type": "string" + }, + "appInsightsInstrumentationKey": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + }, + "containerRegistryCredentials": { + "readOnly": true, + "$ref": "#/definitions/RegistryListCredentialsResult" + }, + "notebookAccessKeys": { + "readOnly": true, + "$ref": "#/definitions/ListNotebookKeysResult" + } + } + }, + "NotebookAccessTokenResult": { + "type": "object", + "properties": { + "notebookResourceId": { + "readOnly": true, + "type": "string" + }, + "hostName": { + "readOnly": true, + "type": "string" + }, + "publicDns": { + "readOnly": true, + "type": "string" + }, + "accessToken": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + }, + "tokenType": { + "readOnly": true, + "type": "string" + }, + "expiresIn": { + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "refreshToken": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + }, + "scope": { + "readOnly": true, + "type": "string" + } + } + }, + "RegistryListCredentialsResult": { + "type": "object", + "properties": { + "location": { + "readOnly": true, + "type": "string" + }, + "username": { + "readOnly": true, + "type": "string" + }, + "passwords": { + "type": "array", + "items": { + "$ref": "#/definitions/Password" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Password": { + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string" + }, + "value": { + "readOnly": true, + "type": "string" + } + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "description": "List of private endpoint connection associated with the specified workspace" + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateEndpoint": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for Private Endpoint" + } + }, + "description": "The Private Endpoint resource." + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "SharedPrivateLinkResource": { + "type": "object", + "properties": { + "name": { + "description": "Unique name of the private link.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/SharedPrivateLinkResourceProperty", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + } + }, + "SharedPrivateLinkResourceProperty": { + "type": "object", + "properties": { + "privateLinkResourceId": { + "description": "The resource id that private link links to.", + "type": "string" + }, + "groupId": { + "description": "The private link resource group id.", + "type": "string" + }, + "requestMessage": { + "description": "Request message.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + } + }, + "description": "Properties of a shared private link resource." + }, + "EncryptionProperty": { + "properties": { + "status": { + "description": "Indicates whether or not the encryption is enabled for the workspace.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } + }, + "identity": { + "$ref": "#/definitions/IdentityForCmk", + "description": "The identity that will be used to access the key vault for encryption at rest." + }, + "keyVaultProperties": { + "$ref": "#/definitions/EncryptionKeyVaultProperties", + "description": "Customer Key vault properties." + } + }, + "required": [ + "status", + "keyVaultProperties" + ], + "type": "object" + }, + "EncryptionKeyVaultProperties": { + "properties": { + "keyVaultArmId": { + "description": "The ArmId of the keyVault where the customer owned encryption key is present.", + "type": "string" + }, + "keyIdentifier": { + "description": "Key vault uri to access the encryption key.", + "type": "string" + }, + "identityClientId": { + "description": "For future use - The client id of the identity which will be used to access key vault.", + "type": "string" + } + }, + "required": [ + "keyIdentifier", + "keyVaultArmId" + ], + "type": "object" + }, + "IdentityForCmk": { + "description": "Identity that will be used to access key vault for encryption at rest", + "type": "object", + "properties": { + "userAssignedIdentity": { + "description": "The ArmId of the user assigned identity that will be used to access the customer managed key vault", + "type": "string" + } + } + }, + "ServerlessComputeSettings": { + "type": "object", + "properties": { + "serverlessComputeCustomSubnet": { + "description": "The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed", + "type": "string", + "format": "arm-id" + }, + "serverlessComputeNoPublicIP": { + "description": "The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint", + "type": "boolean" + } + } + }, + "ServiceManagedResourcesSettings": { + "type": "object", + "properties": { + "cosmosDb": { + "$ref": "#/definitions/CosmosDbSettings", + "description": "The settings for the service managed cosmosdb account." + } + } + }, + "CosmosDbSettings": { + "type": "object", + "properties": { + "collectionsThroughput": { + "type": "integer", + "format": "int32", + "description": "The throughput of the collections in cosmosdb database" + } + } + }, + "OutboundRuleListResult": { + "description": "List of outbound rules for the managed network of a machine learning workspace.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } + } + }, + "OutboundRuleBasicResource": { + "description": "Outbound Rule Basic Resource for the managed network of a machine learning workspace.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OutboundRule" + } + } + }, + "ManagedNetworkSettings": { + "description": "Managed Network settings for a machine learning workspace.", + "type": "object", + "properties": { + "isolationMode": { + "description": "Isolation mode for the managed network of a machine learning workspace.", + "$ref": "#/definitions/IsolationMode" + }, + "networkId": { + "type": "string", + "readOnly": true + }, + "outboundRules": { + "type": "object", + "additionalProperties": { + "description": "Outbound Rule for the managed network of a machine learning workspace.", + "$ref": "#/definitions/OutboundRule" + }, + "x-nullable": true + }, + "status": { + "description": "Status of the Provisioning for the managed network of a machine learning workspace.", + "$ref": "#/definitions/ManagedNetworkProvisionStatus" + }, + "firewallSku": { + "description": "Firewall Sku used for FQDN Rules", + "$ref": "#/definitions/FirewallSku" + } + } + }, + "ManagedNetworkProvisionOptions": { + "description": "Managed Network Provisioning options for managed network of a machine learning workspace.", + "type": "object", + "properties": { + "includeSpark": { + "type": "boolean" + } + } + }, + "ManagedNetworkProvisionStatus": { + "description": "Status of the Provisioning for the managed network of a machine learning workspace.", + "type": "object", + "properties": { + "sparkReady": { + "type": "boolean" + }, + "status": { + "$ref": "#/definitions/ManagedNetworkStatus" + } + } + }, + "ManagedNetworkStatus": { + "description": "Status for the managed network of a machine learning workspace.", + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedNetworkStatus", + "modelAsString": true + } + }, + "IsolationMode": { + "description": "Isolation mode for the managed network of a machine learning workspace.", + "enum": [ + "Disabled", + "AllowInternetOutbound", + "AllowOnlyApprovedOutbound" + ], + "type": "string", + "x-ms-enum": { + "name": "IsolationMode", + "modelAsString": true + } + }, + "OutboundRule": { + "description": "Outbound Rule for the managed network of a machine learning workspace.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/RuleCategory" + }, + "status": { + "$ref": "#/definitions/RuleStatus" + }, + "type": { + "$ref": "#/definitions/RuleType" + } + }, + "discriminator": "type" + }, + "PrivateEndpointOutboundRule": { + "description": "Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "$ref": "#/definitions/PrivateEndpointDestination" + } + }, + "x-ms-discriminator-value": "PrivateEndpoint" + }, + "PrivateEndpointDestination": { + "type": "object", + "description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "properties": { + "serviceResourceId": { + "type": "string", + "format": "arm-id" + }, + "sparkEnabled": { + "type": "boolean" + }, + "sparkStatus": { + "$ref": "#/definitions/RuleStatus" + }, + "subresourceTarget": { + "type": "string" + } + } + }, + "ServiceTagOutboundRule": { + "type": "object", + "description": "Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "$ref": "#/definitions/ServiceTagDestination" + } + }, + "x-ms-discriminator-value": "ServiceTag" + }, + "ServiceTagDestination": { + "type": "object", + "description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "properties": { + "action": { + "$ref": "#/definitions/RuleAction" + }, + "addressPrefixes": { + "description": "Optional, if provided, the ServiceTag property will be ignored.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "portRanges": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "serviceTag": { + "type": "string" + } + } + }, + "RuleAction": { + "description": "The action enum for networking rule.", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleAction", + "modelAsString": true + } + }, + "FqdnOutboundRule": { + "type": "object", + "description": "FQDN Outbound Rule for the managed network of a machine learning workspace.", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "type": "string" + } + }, + "x-ms-discriminator-value": "FQDN" + }, + "RuleCategory": { + "description": "Category of a managed network Outbound Rule of a machine learning workspace.", + "enum": [ + "Required", + "Recommended", + "UserDefined", + "Dependency" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleCategory", + "modelAsString": true + } + }, + "RuleStatus": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleStatus", + "modelAsString": true + } + }, + "RuleType": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "enum": [ + "FQDN", + "PrivateEndpoint", + "ServiceTag" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleType", + "modelAsString": true + } + }, + "NotebookResourceInfo": { + "type": "object", + "properties": { + "fqdn": { + "type": "string" + }, + "resourceId": { + "type": "string", + "description": "the data plane resourceId that used to initialize notebook component" + }, + "notebookPreparationError": { + "$ref": "#/definitions/NotebookPreparationError", + "description": "The error that occurs when preparing notebook.", + "x-nullable": true + } + } + }, + "NotebookPreparationError": { + "type": "object", + "properties": { + "errorMessage": { + "type": "string" + }, + "statusCode": { + "format": "int32", + "type": "integer" + } + } + }, + "ListNotebookKeysResult": { + "type": "object", + "properties": { + "primaryAccessKey": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + }, + "secondaryAccessKey": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + } + } + }, + "ListStorageAccountKeysResult": { + "type": "object", + "properties": { + "userStorageKey": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + } + } + }, + "ConnectionAuthType": { + "description": "Authentication type of the connection target", + "enum": [ + "PAT", + "ManagedIdentity", + "UsernamePassword", + "None", + "SAS", + "AccountKey", + "ServicePrincipal", + "AccessKey", + "ApiKey", + "CustomKeys", + "OAuth2", + "AAD" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionAuthType", + "modelAsString": true + } + }, + "ConnectionCategory": { + "description": "Category of the connection", + "enum": [ + "PythonFeed", + "ContainerRegistry", + "Git", + "S3", + "Snowflake", + "AzureSqlDb", + "AzureSynapseAnalytics", + "AzureMySqlDb", + "AzurePostgresDb", + "ADLSGen2", + "Redis", + "ApiKey", + "AzureOpenAI", + "AIServices", + "CognitiveSearch", + "CognitiveService", + "CustomKeys", + "AzureBlob", + "AzureOneLake", + "CosmosDb", + "CosmosDbMongoDbApi", + "AzureDataExplorer", + "AzureMariaDb", + "AzureDatabricksDeltaLake", + "AzureSqlMi", + "AzureTableStorage", + "AmazonRdsForOracle", + "AmazonRdsForSqlServer", + "AmazonRedshift", + "Db2", + "Drill", + "GoogleBigQuery", + "Greenplum", + "Hbase", + "Hive", + "Impala", + "Informix", + "MariaDb", + "MicrosoftAccess", + "MySql", + "Netezza", + "Oracle", + "Phoenix", + "PostgreSql", + "Presto", + "SapOpenHub", + "SapBw", + "SapHana", + "SapTable", + "Spark", + "SqlServer", + "Sybase", + "Teradata", + "Vertica", + "Pinecone", + "Cassandra", + "Couchbase", + "MongoDbV2", + "MongoDbAtlas", + "AmazonS3Compatible", + "FileServer", + "FtpServer", + "GoogleCloudStorage", + "Hdfs", + "OracleCloudStorage", + "Sftp", + "GenericHttp", + "ODataRest", + "Odbc", + "GenericRest", + "AmazonMws", + "Concur", + "Dynamics", + "DynamicsAx", + "DynamicsCrm", + "GoogleAdWords", + "Hubspot", + "Jira", + "Magento", + "Marketo", + "Office365", + "Eloqua", + "Responsys", + "OracleServiceCloud", + "PayPal", + "QuickBooks", + "Salesforce", + "SalesforceServiceCloud", + "SalesforceMarketingCloud", + "SapCloudForCustomer", + "SapEcc", + "ServiceNow", + "SharePointOnlineList", + "Shopify", + "Square", + "WebTable", + "Xero", + "Zoho", + "GenericContainerRegistry", + "Elasticsearch", + "OpenAI", + "Serp", + "BingLLMSearch", + "Serverless", + "ManagedOnlineEndpoint" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionCategory", + "modelAsString": true + } + }, + "WorkspaceConnectionUsernamePassword": { + "type": "object", + "properties": { + "username": { + "type": "string" + }, + "password": { + "type": "string" + }, + "securityToken": { + "description": "Optional, required by connections like SalesForce for extra security in addition to UsernamePassword", + "type": "string", + "x-ms-secret": true + } + }, + "additionalProperties": false + }, + "WorkspaceConnectionPersonalAccessToken": { + "type": "object", + "properties": { + "pat": { + "type": "string" + } + }, + "additionalProperties": false + }, + "PATAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken" + } + }, + "additionalProperties": false, + "x-ms-discriminator-value": "PAT" + }, + "WorkspaceConnectionSharedAccessSignature": { + "type": "object", + "properties": { + "sas": { + "type": "string" + } + }, + "additionalProperties": false + }, + "WorkspaceConnectionAccountKey": { + "type": "object", + "properties": { + "key": { + "type": "string", + "x-ms-secret": true + } + }, + "additionalProperties": false + }, + "SASAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" + } + }, + "additionalProperties": false, + "x-ms-discriminator-value": "SAS" + }, + "UsernamePasswordAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" + } + }, + "additionalProperties": false, + "x-ms-discriminator-value": "UsernamePassword" + }, + "WorkspaceConnectionPropertiesV2": { + "required": [ + "authType" + ], + "type": "object", + "properties": { + "authType": { + "description": "Authentication type of the connection target", + "$ref": "#/definitions/ConnectionAuthType" + }, + "category": { + "description": "Category of the connection", + "$ref": "#/definitions/ConnectionCategory" + }, + "createdByWorkspaceArmId": { + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "expiryTime": { + "format": "date-time", + "type": "string" + }, + "group": { + "description": "Group based on connection category", + "$ref": "#/definitions/ConnectionGroup", + "readOnly": true + }, + "isSharedToAll": { + "type": "boolean" + }, + "target": { + "type": "string" + }, + "metadata": { + "description": "Store user metadata for this connection", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sharedUserList": { + "type": "array", + "items": { + "type": "string" + } + }, + "value": { + "description": "Value details of the workspace connection.", + "type": "string" + }, + "valueFormat": { + "description": "format for the workspace connection value", + "type": "string", + "enum": [ + "JSON" + ], + "x-ms-enum": { + "name": "ValueFormat", + "modelAsString": true + } + } + }, + "discriminator": "authType" + }, + "NoneAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "additionalProperties": false, + "x-ms-discriminator-value": "None" + }, + "WorkspaceConnectionManagedIdentity": { + "type": "object", + "properties": { + "resourceId": { + "type": "string" + }, + "clientId": { + "type": "string" + } + }, + "additionalProperties": false + }, + "ManagedIdentityAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" + } + }, + "additionalProperties": false, + "x-ms-discriminator-value": "ManagedIdentity" + }, + "WorkspaceConnectionPropertiesV2BasicResource": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + }, + "additionalProperties": false + }, + "WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "nextLink": { + "readOnly": true, + "type": "string" + } + }, + "additionalProperties": false + }, + "FQDNEndpointDetail": { + "type": "object", + "properties": { + "port": { + "format": "int32", + "type": "integer" + } + } + }, + "FQDNEndpoint": { + "type": "object", + "properties": { + "domainName": { + "type": "string" + }, + "endpointDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpointDetail" + }, + "x-ms-identifiers": [ + "port" + ] + } + } + }, + "FQDNEndpointsProperties": { + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpoint" + }, + "x-ms-identifiers": [ + "domainName" + ] + } + } + }, + "FQDNEndpoints": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FQDNEndpointsProperties" + } + } + }, + "ExternalFQDNResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpoints" + }, + "x-ms-identifiers": [ + "/properties/category" + ] + } + } + }, + "FeatureStoreSettings": { + "type": "object", + "description": "Settings for feature store type workspace.", + "properties": { + "computeRuntime": { + "$ref": "#/definitions/ComputeRuntimeDto" + }, + "offlineStoreConnectionName": { + "type": "string" + }, + "onlineStoreConnectionName": { + "type": "string" + } + } + }, + "ComputeRuntimeDto": { + "type": "object", + "description": "Compute runtime config for feature store type workspace.", + "properties": { + "sparkRuntimeVersion": { + "type": "string" + } + } + }, + "AADAuthTypeWorkspaceConnectionProperties": { + "description": "This connection type covers the AAD auth for any applicable Azure service", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "AAD" + }, + "AccessKeyAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionAccessKey" + } + }, + "x-ms-discriminator-value": "AccessKey" + }, + "WorkspaceConnectionAccessKey": { + "type": "object", + "properties": { + "accessKeyId": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" + } + } + }, + "AccountKeyAuthTypeWorkspaceConnectionProperties": { + "description": "This connection type covers the account key connection for Azure storage", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionAccountKey" + } + }, + "x-ms-discriminator-value": "AccountKey" + }, + "ApiKeyAuthWorkspaceConnectionProperties": { + "description": "This connection type covers the generic ApiKey auth connection categories, for examples:\r\nAzureOpenAI:\r\n Category:= AzureOpenAI\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= {ApiBase}\r\n \r\nCognitiveService:\r\n Category:= CognitiveService\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= ServiceRegion={serviceRegion}\r\n \r\nCognitiveSearch:\r\n Category:= CognitiveSearch\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= {Endpoint}\r\n \r\nUse Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionApiKey" + } + }, + "x-ms-discriminator-value": "ApiKey" + }, + "WorkspaceConnectionApiKey": { + "description": "Api key object for workspace connection credential.", + "type": "object", + "properties": { + "key": { + "type": "string" + } + } + }, + "CustomKeysWorkspaceConnectionProperties": { + "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "description": "Custom Keys credential object", + "$ref": "#/definitions/CustomKeys" + } + }, + "x-ms-discriminator-value": "CustomKeys" + }, + "CustomKeys": { + "description": "Custom Keys credential object", + "type": "object", + "properties": { + "keys": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OAuth2AuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionOAuth2" + } + }, + "x-ms-discriminator-value": "OAuth2" + }, + "WorkspaceConnectionOAuth2": { + "description": "ClientId and ClientSecret are required. Other properties are optional\r\ndepending on each OAuth2 provider's implementation.", + "type": "object", + "properties": { + "authUrl": { + "description": "Required by Concur connection category", + "type": "string", + "format": "url" + }, + "clientId": { + "type": "string", + "description": "Client id in the format of UUID", + "format": "uuid" + }, + "clientSecret": { + "type": "string", + "x-ms-secret": true + }, + "developerToken": { + "description": "Required by GoogleAdWords connection category", + "type": "string", + "x-ms-secret": true + }, + "password": { + "type": "string", + "x-ms-secret": true + }, + "refreshToken": { + "description": "Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho\r\nwhere user needs to get RefreshToken offline", + "type": "string", + "x-ms-secret": true + }, + "tenantId": { + "description": "Required by QuickBooks and Xero connection categories", + "type": "string" + }, + "username": { + "description": "Concur, ServiceNow auth server AccessToken grant type is 'Password'\r\nwhich requires UsernamePassword", + "type": "string" + } + } + }, + "ServicePrincipalAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" + } + }, + "x-ms-discriminator-value": "ServicePrincipal" + }, + "WorkspaceConnectionServicePrincipal": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string" + }, + "tenantId": { + "type": "string" + } + } + }, + "ConnectionGroup": { + "description": "Group based on connection category", + "enum": [ + "Azure", + "AzureAI", + "Database", + "NoSQL", + "File", + "GenericProtocol", + "ServicesAndApps" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionGroup", + "modelAsString": true + } + }, + "EncryptionUpdateProperties": { + "required": [ + "keyVaultProperties" + ], + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties" + } + } + }, + "EncryptionKeyVaultUpdateProperties": { + "required": [ + "keyIdentifier" + ], + "type": "object", + "properties": { + "keyIdentifier": { + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + } + }, + "WorkspaceHubConfig": { + "description": "WorkspaceHub's configuration object.", + "type": "object", + "properties": { + "additionalWorkspaceStorageAccounts": { + "type": "array", + "items": { + "type": "string" + } + }, + "defaultWorkspaceResourceGroup": { + "type": "string" + } + } + }, + "WorkspaceConnectionUpdateParameter": { + "description": "The properties that the machine learning workspace connection will be updated with.", + "type": "object", + "properties": { + "properties": { + "description": "The properties that the machine learning workspace connection will be updated with.", + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + } + }, + "FirewallSku": { + "description": "Firewall Sku used for FQDN Rules", + "enum": [ + "Standard", + "Basic" + ], + "type": "string", + "x-ms-enum": { + "name": "FirewallSku", + "modelAsString": true + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index 3cbc0090f0ed..0a46f51b7013 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -27,9 +27,59 @@ These are the global settings for the Machine Learning Services API. ``` yaml openapi-type: arm -tag: package-preview-2024-10 +tag: package-2024-10 ``` +### Tag: package-2024-10 + +These settings apply only when `--tag=package-2024-10` is specified on the command line. + +```yaml $(tag) == 'package-2024-10' +input-file: + - Microsoft.MachineLearningServices/stable/2024-10-01/machineLearningServices.json + - Microsoft.MachineLearningServices/stable/2024-10-01/mfe.json + - Microsoft.MachineLearningServices/stable/2024-10-01/registries.json + - Microsoft.MachineLearningServices/stable/2024-10-01/workspaceFeatures.json + - Microsoft.MachineLearningServices/stable/2024-10-01/workspaceRP.json +suppressions: + - code: PatchBodyParametersSchema + reason: Suppress as instructed, this patch is for a abstract class and the type-discriminator needs to be required. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}"].patch.parameters[5].schema.properties.properties + - code: ResourceNameRestriction + reason: Experience is the same as previous GA version, adding restriction will be a breaking change. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}"] + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes"] + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys"] + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/start"] + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/stop"] + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/restart"] + - code: AvoidAdditionalProperties + reason: Existing property in previous GA version. + where: + - $.definitions.SparkJob.properties.conf + - $.definitions.SparkJob.properties.environmentVariables + - $.definitions.WorkspaceConnectionPropertiesV2.properties.metadata + - $.definitions.CustomKeys.properties.keys + - code: LroLocationHeader + reason: Existing API behavior + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}"].delete.responses.202 + - code: PatchBodyParametersSchema + reason: Existing API behavior, the whole property is not required. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}"].patch.parameters[4].schema.properties.properties + - code: XmsPageableForListCalls + reason: Existing API behavior. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateLinkResources"].get + - code: GuidUsage + reason: Existing property in previous GA version. + where: + - $.definitions.WorkspaceConnectionOAuth2.properties.clientId.format + ``` + ### Tag: package-preview-2024-10 These settings apply only when `--tag=package-preview-2024-10` is specified on the command line. diff --git a/specification/machinelearningservices/resource-manager/sdk-suppressions.yaml b/specification/machinelearningservices/resource-manager/sdk-suppressions.yaml index 0fe8cd31ab5d..6c5a50b65be5 100644 --- a/specification/machinelearningservices/resource-manager/sdk-suppressions.yaml +++ b/specification/machinelearningservices/resource-manager/sdk-suppressions.yaml @@ -38,6 +38,57 @@ suppressions: - Removed operation group NotebooksOperations - Renamed operation WorkspacesOperations.resync_keys to WorkspacesOperations.begin_resync_keys - Renamed operation WorkspacesOperations.update to WorkspacesOperations.begin_update + - Deleted or renamed model `AzureMachineLearningWorkspaces` + - Model `AmlComputeNodesInformation` deleted or renamed its instance variable `compute_type` + - Model `ClusterUpdateParameters` deleted or renamed its instance variable `scale_settings` + - Model `ErrorResponse` deleted or renamed its instance variable `code` + - Model `ErrorResponse` deleted or renamed its instance variable `message` + - Model `ErrorResponse` deleted or renamed its instance variable `details` + - Model `Resource` deleted or renamed its instance variable `identity` + - Model `Resource` deleted or renamed its instance variable `location` + - Model `Resource` deleted or renamed its instance variable `tags` + - Model `Resource` deleted or renamed its instance variable `sku` + - Method `Sku.__init__` removed default value `None` from its parameter `name` + - Model `VirtualMachineSizeListResult` deleted or renamed its instance variable `aml_compute` + - Model `Workspace` deleted or renamed its instance variable `creation_time` + - Deleted or renamed model `AKSProperties` + - Deleted or renamed model `ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties` + - Deleted or renamed model `ComputeNodesInformation` + - Deleted or renamed model `DataLakeAnalyticsProperties` + - Deleted or renamed model `Identity` + - Deleted or renamed model `KeyVaultProperties` + - Deleted or renamed model `MachineLearningServiceError` + - Deleted or renamed model `NotebookListCredentialsResult` + - Deleted or renamed model `PaginatedWorkspaceConnectionsList` + - Deleted or renamed model `ReasonCode` + - Deleted or renamed model `ResourceIdentityType` + - Deleted or renamed model `ResourceSkuLocationInfo` + - Deleted or renamed model `ResourceSkuZoneDetails` + - Deleted or renamed model `Restriction` + - Deleted or renamed model `SKUCapability` + - Deleted or renamed model `ServicePrincipalCredentials` + - Deleted or renamed model `SkuSettings` + - Deleted or renamed model `SslConfigurationStatus` + - Deleted or renamed model `VirtualMachineProperties` + - Deleted or renamed model `WorkspaceConnection` + - Deleted or renamed model `WorkspaceConnectionDto` + - Deleted or renamed model `WorkspaceSku` + - Deleted or renamed method `PrivateEndpointConnectionsOperations.begin_delete` + - Deleted or renamed method `PrivateEndpointConnectionsOperations.put` + - Deleted or renamed method `PrivateLinkResourcesOperations.list_by_workspace` + - Method `VirtualMachineSizesOperations.list` deleted or renamed its parameter `compute_type` of kind `positional_or_keyword` + - Method `VirtualMachineSizesOperations.list` deleted or renamed its parameter `recommended` of kind `positional_or_keyword` + - Method `WorkspaceConnectionsOperations.list` inserted a `positional_or_keyword` parameter `include_all` + - Method `WorkspacesOperations.begin_delete` inserted a `positional_or_keyword` parameter `force_to_purge` + - Method `WorkspacesOperations.list_by_resource_group` deleted or renamed its parameter `skiptoken` of kind `positional_or_keyword` + - Method `WorkspacesOperations.list_by_subscription` deleted or renamed its parameter `skiptoken` of kind `positional_or_keyword` + - Deleted or renamed method `WorkspacesOperations.resync_keys` + - Deleted or renamed method `WorkspacesOperations.update` + - Deleted or renamed model `AzureMachineLearningWorkspacesOperationsMixin` + - Deleted or renamed model `MachineLearningComputeOperations` + - Deleted or renamed model `NotebooksOperations` + - Method `WorkspacesOperations.list_by_subscription` re-ordered its parameters from `['self', 'skiptoken', 'kwargs']` to `['self', 'skip', 'kwargs']` + - Method `WorkspacesOperations.list_by_resource_group` re-ordered its parameters from `['self', 'resource_group_name', 'skiptoken', 'kwargs']` to `['self', 'resource_group_name', 'skip', 'kwargs']` azure-sdk-for-js: - package: '@azure/arm-machinelearning' breaking-changes: diff --git a/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/GetRouteMatrixAsyncResult.json b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/GetRouteMatrixAsyncResult.json new file mode 100644 index 000000000000..b4c33aabe986 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/GetRouteMatrixAsyncResult.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "id": "bc3f9365-3ee0-4564-aa27-825016325557" + }, + "responses": { + "200": { + "body": { + "kind": "RouteMatrix", + "type": "Feature", + "geometry": null, + "properties": { + "summary": { + "totalCount": 4, + "successfulCount": 2 + }, + "matrix": [ + { + "statusCode": 200, + "originIndex": 0, + "destinationIndex": 0, + "departureTime": "2022-12-19T16:39:57+01:00", + "arrivalTime": "2022-12-20T00:21:14+01:00", + "distanceInMeters": 573064, + "durationInSeconds": 27677, + "durationTrafficInSeconds": 27677 + }, + { + "statusCode": 400, + "originIndex": 0, + "destinationIndex": 1, + "error": { + "code": "OUT_OF_REGION", + "message": "Input coordinates out of region" + } + }, + { + "statusCode": 200, + "originIndex": 1, + "destinationIndex": 0, + "departureTime": "2022-12-19T16:39:57+01:00", + "arrivalTime": "2022-12-19T22:19:10+01:00", + "distanceInMeters": 452488, + "durationInSeconds": 20353, + "durationTrafficInSeconds": 20353 + }, + { + "statusCode": 400, + "originIndex": 1, + "destinationIndex": 1, + "error": { + "code": "OUT_OF_REGION", + "message": "Input coordinates out of region" + } + } + ] + } + } + }, + "404": { + "body": { + "error": { + "code": "NotFound", + "message": "Not Found: the requested resource could not be found." + } + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/GetRouteOperationStatusCompleted.json b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/GetRouteOperationStatusCompleted.json new file mode 100644 index 000000000000..a9d3a851ca54 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/GetRouteOperationStatusCompleted.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "id": "bc3f9365-3ee0-4564-aa27-825016325557" + }, + "responses": { + "200": { + "body": { + "kind": "RouteMatrix", + "status": "Completed", + "createdDateTime": "2023-01-01T00:00:00Z", + "lastActionDateTime": "2023-01-01T00:05:00Z", + "result": { + "resultUrl": "https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2024-07-01-preview" + } + } + }, + "404": { + "body": { + "error": { + "code": "NotFound", + "message": "Not Found: the requested resource could not be found." + } + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteDirections.json b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteDirections.json new file mode 100644 index 000000000000..4ecefd5b4228 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteDirections.json @@ -0,0 +1,485 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "routeDirectionsRequest": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.201399, + 47.608678 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 0, + "pointType": "waypoint" + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.20687, + 47.612002 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 1, + "pointType": "viaWaypoint" + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.201669, + 47.615076 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 2, + "pointType": "waypoint" + } + } + ], + "optimizeRoute": "fastestWithTraffic", + "routeOutputOptions": [ + "routePath" + ], + "maxRouteCount": 3, + "travelMode": "driving" + } + }, + "responses": { + "200": { + "body": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.20147, + 47.608676 + ] + }, + "properties": { + "type": "Waypoint", + "routePathPoint": { + "legIndex": 0, + "pointIndex": 0 + }, + "order": { + "inputIndex": 0 + }, + "compassDirection": "north", + "instruction": { + "formattedText": "Head north on Bellevue Way SE toward SE 1st St", + "maneuverType": "DepartStart", + "text": "Head north on Bellevue Way SE toward SE 1st St" + }, + "sideOfStreet": "Unknown", + "towardsRoadName": "SE 1st St", + "distanceInMeters": 98.2, + "durationInSeconds": 19, + "steps": [ + { + "routePathRange": { + "legIndex": 0, + "range": [ + 0, + 1 + ] + }, + "maneuverType": "DepartStart", + "compassDegrees": 358, + "roadType": "Arterial", + "names": [ + "Bellevue Way SE" + ] + } + ], + "travelMode": "driving" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.201495, + 47.610109 + ] + }, + "properties": { + "type": "ManeuverPoint", + "routePathPoint": { + "legIndex": 0, + "pointIndex": 1 + }, + "compassDirection": "north", + "instruction": { + "formattedText": "Turn left onto Main st", + "maneuverType": "TurnLeft", + "text": "Turn left onto Main st" + }, + "sideOfStreet": "Unknown", + "distanceInMeters": 253.5, + "durationInSeconds": 81, + "steps": [ + { + "routePathRange": { + "legIndex": 0, + "range": [ + 1, + 3 + ] + }, + "maneuverType": "TurnLeft", + "compassDegrees": 358, + "roadType": "Arterial", + "names": [ + "Main st" + ] + } + ], + "travelMode": "driving" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.206817, + 47.610185 + ] + }, + "properties": { + "type": "ManeuverPoint", + "routePathPoint": { + "legIndex": 0, + "pointIndex": 3 + }, + "compassDirection": "north", + "instruction": { + "formattedText": "Turn right onto 100th Ave NE", + "maneuverType": "TurnRight", + "text": "Turn right onto 100th Ave NE" + }, + "sideOfStreet": "Unknown", + "distanceInMeters": 252.9, + "durationInSeconds": 49, + "steps": [ + { + "routePathRange": { + "legIndex": 0, + "range": [ + 3, + 5 + ] + }, + "maneuverType": "TurnRight", + "compassDegrees": 357, + "roadType": "Arterial", + "names": [ + "100th Ave NE" + ] + } + ], + "travelMode": "driving" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.206971, + 47.61384 + ] + }, + "properties": { + "type": "ManeuverPoint", + "routePathPoint": { + "legIndex": 0, + "pointIndex": 6 + }, + "compassDirection": "east", + "instruction": { + "formattedText": "Turn right onto NE 4th St", + "maneuverType": "TurnRight", + "text": "Turn right onto NE 4th St" + }, + "sideOfStreet": "Unknown", + "distanceInMeters": 247.9, + "durationInSeconds": 77, + "steps": [ + { + "routePathRange": { + "legIndex": 0, + "range": [ + 6, + 9 + ] + }, + "maneuverType": "TurnRight", + "compassDegrees": 90, + "roadType": "Arterial", + "names": [ + "NE 4th St" + ] + } + ], + "travelMode": "driving" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.201664, + 47.61386 + ] + }, + "properties": { + "type": "ManeuverPoint", + "routePathPoint": { + "legIndex": 0, + "pointIndex": 9 + }, + "compassDirection": "east", + "instruction": { + "formattedText": "Turn left onto Bellevue Way NE", + "maneuverType": "TurnLeft", + "text": "Turn left onto Bellevue Way NE" + }, + "sideOfStreet": "Unknown", + "distanceInMeters": 94.4, + "durationInSeconds": 38, + "steps": [ + { + "routePathRange": { + "legIndex": 0, + "range": [ + 9, + 11 + ] + }, + "maneuverType": "TurnLeft", + "compassDegrees": 91, + "roadType": "Arterial", + "names": [ + "Bellevue Way NE" + ] + } + ], + "travelMode": "driving" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.201603, + 47.615137 + ] + }, + "properties": { + "type": "Waypoint", + "routePathPoint": { + "legIndex": 0, + "pointIndex": 11 + }, + "order": { + "inputIndex": 2 + }, + "compassDirection": "north", + "instruction": { + "formattedText": "Arrive at Bellevue Way NE", + "maneuverType": "ArriveFinish", + "text": "Arrive at Bellevue Way NE", + "hints": [ + { + "hintType": "PreviousIntersection", + "text": "The last intersection before your destination is NE 4th St" + } + ] + }, + "sideOfStreet": "Unknown", + "distanceInMeters": 0.0, + "durationInSeconds": 0, + "steps": [ + { + "routePathRange": { + "legIndex": 0, + "range": [ + 11, + 11 + ] + }, + "maneuverType": "ArriveFinish", + "compassDegrees": 357, + "roadType": "Arterial", + "names": [ + "Bellevue Way NE" + ] + } + ], + "travelMode": "driving" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.206894, + 47.612001 + ] + }, + "properties": { + "type": "ViaWaypoint", + "names": [ + "100th Ave NE" + ], + "routePathPoint": { + "pointIndex": 5, + "legIndex": 0 + }, + "order": { + "inputIndex": 1 + } + } + }, + { + "type": "Feature", + "geometry": { + "type": "MultiLineString", + "coordinates": [ + [ + [ + -122.20147, + 47.608675 + ], + [ + -122.201494, + 47.610108 + ], + [ + -122.201496, + 47.610196 + ], + [ + -122.206817, + 47.610185 + ], + [ + -122.206824, + 47.610369 + ], + [ + -122.206893, + 47.612001 + ], + [ + -122.20697, + 47.613839 + ], + [ + -122.206832, + 47.613839 + ], + [ + -122.204428, + 47.61379 + ], + [ + -122.201664, + 47.61386 + ], + [ + -122.201547, + 47.613857 + ], + [ + -122.201603, + 47.615137 + ] + ] + ] + }, + "bbox": [ + 47.608676, + -122.206971, + 47.615137, + -122.20147 + ], + "properties": { + "type": "RoutePath", + "resourceId": "v70,h-1241513931,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s3,m1,o1,t4,wuOUjKenNR0CdnKG444xewA2~AISjUSdxkDoBAADgAdG_yz4A0~QmVsbGV2dWUgV2F5IFNF0~~~~~~~~v12,wFYvfFFbOR0CBIatbPY1ewA2~AISjUScpizoBAADgARBojT4A0~MTAwdGggQXZlIE5F0~~~1~~~~~v12,w-kZ0z7rOR0B95xcl6IxewA2~AISjUSchJDoBAADgAQAAgD8A0~QmVsbGV2dWUgV2F5IE5F0~~~~~~~~v12,k0,qatt:1", + "distanceInMeters": 947.0, + "durationInSeconds": 266, + "durationTrafficInSeconds": 295, + "trafficDataUsed": "None", + "trafficCongestion": "Mild", + "departureTime": "2023-08-28T18:00:00+00:00", + "arrivalTime": "2023-08-28T18:04:55+00:00", + "legs": [ + { + "description": "100th Ave NE, NE 4th St", + "routePathRange": { + "range": [ + 0, + 11 + ], + "legIndex": 0 + }, + "subLegs": [ + { + "routePathRange": { + "range": [ + 0, + 5 + ], + "legIndex": 0 + }, + "distanceInMeters": 477.8, + "durationInSeconds": 128, + "durationTrafficInSeconds": 138 + }, + { + "routePathRange": { + "range": [ + 5, + 11 + ], + "legIndex": 0 + }, + "distanceInMeters": 469.1, + "durationInSeconds": 137, + "durationTrafficInSeconds": 157 + } + ], + "distanceInMeters": 947.0, + "durationInSeconds": 266, + "durationTrafficInSeconds": 295, + "departureTime": "2023-08-28T18:00:00+00:00", + "arrivalTime": "2023-08-28T18:04:55+00:00" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteDirectionsBatch.json b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteDirectionsBatch.json new file mode 100644 index 000000000000..cd2ca64a0c9f --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteDirectionsBatch.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "routeDirectionsBatchRequest": { + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.3368, + 47.614988 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 0, + "pointType": "waypoint" + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.316067, + 47.606356 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 1, + "pointType": "waypoint" + } + } + ], + "optimizeRoute": "fastestWithTraffic", + "routeOutputOptions": [ + "routeSummary" + ], + "maxRouteCount": 3, + "travelMode": "driving" + }, + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.3368, + 47.614988 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 0, + "pointType": "waypoint" + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.316067, + 47.606356 + ], + "type": "Point" + }, + "properties": { + "pointIndex": 1, + "pointType": "waypoint" + } + } + ], + "optimizeRoute": "fastestWithTraffic", + "routeOutputOptions": [ + "routeSummary" + ], + "maxRouteCount": 3, + "travelMode": "driving" + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "successfulRequests": 2, + "totalRequests": 2 + }, + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "MultiLineString", + "coordinates": [] + }, + "properties": { + "type": "RoutePath", + "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2", + "distanceInMeters": 1432.9, + "durationInSeconds": 524, + "durationTrafficInSeconds": 554 + } + } + ], + "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B" + }, + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "MultiLineString", + "coordinates": [] + }, + "properties": { + "type": "RoutePath", + "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2", + "distanceInMeters": 1432.9, + "durationInSeconds": 524, + "durationTrafficInSeconds": 554 + } + } + ], + "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteMatrix.json b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteMatrix.json new file mode 100644 index 000000000000..2eff10d0be5a --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteMatrix.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "routeMatrixRequest": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 9.15049, + 45.458545 + ], + [ + 11.050541, + 45.403337 + ] + ] + }, + "properties": { + "pointType": "origins" + } + }, + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 11.499931, + 48.149853 + ], + [ + 14.538226, + 50.033688 + ] + ] + }, + "properties": { + "pointType": "destinations" + } + } + ], + "departAt": "2022-12-19T16:39:57+01:00", + "optimizeRoute": "fastest", + "traffic": "historical", + "travelMode": "truck", + "avoid": [ + "unpavedRoads" + ] + } + }, + "responses": { + "200": { + "body": { + "type": "Feature", + "geometry": null, + "properties": { + "summary": { + "totalCount": 4, + "successfulCount": 4 + }, + "matrix": [ + { + "statusCode": 200, + "originIndex": 0, + "destinationIndex": 0, + "durationTrafficInSeconds": 21007, + "durationInSeconds": 21007, + "distanceInMeters": 492466, + "departureTime": "2022-12-19T16:39:57+01:00", + "arrivalTime": "2022-12-19T22:30:03+01:00" + }, + { + "statusCode": 200, + "originIndex": 0, + "destinationIndex": 1, + "durationTrafficInSeconds": 33623, + "durationInSeconds": 33623, + "distanceInMeters": 877028, + "departureTime": "2022-12-19T16:39:57+01:00", + "arrivalTime": "2022-12-20T02:00:19+01:00" + }, + { + "statusCode": 200, + "originIndex": 1, + "destinationIndex": 0, + "durationTrafficInSeconds": 19520, + "durationInSeconds": 19520, + "distanceInMeters": 427769, + "departureTime": "2022-12-19T16:39:57+01:00", + "arrivalTime": "2022-12-19T22:05:16+01:00" + }, + { + "statusCode": 200, + "originIndex": 1, + "destinationIndex": 1, + "durationTrafficInSeconds": 32070, + "durationInSeconds": 32070, + "distanceInMeters": 836080, + "departureTime": "2022-12-19T16:39:57+01:00", + "arrivalTime": "2022-12-20T01:34:27+01:00" + } + ] + } + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteMatrixAsync.json b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteMatrixAsync.json new file mode 100644 index 000000000000..1dbe75fc4490 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteMatrixAsync.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "routeMatrixAsyncRequest": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 9.15049, + 45.458545 + ], + [ + 11.050541, + 45.403337 + ] + ] + }, + "properties": { + "pointType": "origins" + } + }, + { + "type": "Feature", + "geometry": { + "type": "MultiPoint", + "coordinates": [ + [ + 11.499931, + 48.149853 + ], + [ + 14.538226, + 50.033688 + ] + ] + }, + "properties": { + "pointType": "destinations" + } + } + ], + "departAt": "2022-12-19T16:39:57+01:00", + "optimizeRoute": "fastest", + "traffic": "historical", + "travelMode": "truck", + "avoid": [ + "unpavedRoads" + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2024-07-01-preview" + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteRange.json b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteRange.json new file mode 100644 index 000000000000..4af344e5b512 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteRange.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "routeRangeRequest": { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 5.86605, + 50.9745 + ] + }, + "properties": { + "timeBudgetInSec": 6000 + } + } + }, + "responses": { + "200": { + "body": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 5.86605, + 50.9745 + ] + }, + "properties": { + "type": "center" + } + }, + { + "type": "Feature", + "bbox": [ + 3.62838, + 49.83259, + 7.9826, + 52.25674 + ], + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 5.73602, + 52.03704 + ], + [ + 5.59435, + 52.09456 + ], + [ + 5.42279, + 52.16815 + ], + [ + 5.21276, + 52.25047 + ], + [ + 5.15355, + 52.21374 + ], + [ + 4.96687, + 52.25674 + ], + [ + 4.739, + 52.07834 + ], + [ + 4.72513, + 52.05647 + ], + [ + 4.53237, + 51.94553 + ], + [ + 4.31165, + 51.70119 + ], + [ + 4.28917, + 51.5837 + ], + [ + 3.82685, + 51.48463 + ], + [ + 3.62838, + 51.21096 + ], + [ + 3.89244, + 50.6814 + ], + [ + 3.93493, + 50.66791 + ], + [ + 3.98156, + 50.49042 + ], + [ + 4.47995, + 50.30944 + ], + [ + 4.60502, + 50.24448 + ], + [ + 4.89999, + 50.24467 + ], + [ + 5.04206, + 50.08735 + ], + [ + 5.23042, + 49.99214 + ], + [ + 5.40994, + 49.88478 + ], + [ + 5.46178, + 49.85797 + ], + [ + 5.7196, + 49.86279 + ], + [ + 5.74151, + 49.83259 + ], + [ + 5.9387, + 50.22239 + ], + [ + 6.08535, + 50.0011 + ], + [ + 6.12089, + 50.04616 + ], + [ + 6.28373, + 50.09472 + ], + [ + 6.51654, + 49.95863 + ], + [ + 6.61034, + 50.00485 + ], + [ + 6.70295, + 50.00587 + ], + [ + 6.65865, + 50.2947 + ], + [ + 6.79276, + 50.36903 + ], + [ + 7.32163, + 50.31614 + ], + [ + 7.58782, + 50.36737 + ], + [ + 7.7626, + 50.46919 + ], + [ + 7.9826, + 50.96246 + ], + [ + 7.55924, + 51.07086 + ], + [ + 7.58138, + 51.36614 + ], + [ + 7.67861, + 51.52015 + ], + [ + 7.35175, + 51.65781 + ], + [ + 7.21664, + 51.81916 + ], + [ + 7.0467, + 51.9587 + ], + [ + 6.67267, + 51.82713 + ], + [ + 6.48424, + 51.81133 + ], + [ + 6.27316, + 51.9368 + ], + [ + 6.14452, + 52.01701 + ], + [ + 6.09312, + 52.20847 + ], + [ + 6.01297, + 52.23705 + ], + [ + 5.86605, + 50.9745 + ], + [ + 5.73602, + 52.03704 + ] + ] + ] + }, + "properties": { + "type": "boundary" + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteRangeBatch.json b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteRangeBatch.json new file mode 100644 index 000000000000..4397a6af9b0d --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostRouteRangeBatch.json @@ -0,0 +1,298 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "routeRangeBatchRequest": { + "batchItems": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 5.86605, + 50.9745 + ] + }, + "properties": { + "timeBudgetInSec": 6000 + } + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 52.7109930507, + -0.591556667114 + ] + }, + "properties": { + "timeBudgetInSec": 6000 + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "successfulRequests": 1, + "totalRequests": 2 + }, + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 5.86605, + 50.9745 + ] + }, + "properties": { + "type": "center" + } + }, + { + "type": "Feature", + "bbox": [ + 3.62838, + 49.83259, + 7.9826, + 52.25674 + ], + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 5.73602, + 52.03704 + ], + [ + 5.59435, + 52.09456 + ], + [ + 5.42279, + 52.16815 + ], + [ + 5.21276, + 52.25047 + ], + [ + 5.15355, + 52.21374 + ], + [ + 4.96687, + 52.25674 + ], + [ + 4.739, + 52.07834 + ], + [ + 4.72513, + 52.05647 + ], + [ + 4.53237, + 51.94553 + ], + [ + 4.31165, + 51.70119 + ], + [ + 4.28917, + 51.5837 + ], + [ + 3.82685, + 51.48463 + ], + [ + 3.62838, + 51.21096 + ], + [ + 3.89244, + 50.6814 + ], + [ + 3.93493, + 50.66791 + ], + [ + 3.98156, + 50.49042 + ], + [ + 4.47995, + 50.30944 + ], + [ + 4.60502, + 50.24448 + ], + [ + 4.89999, + 50.24467 + ], + [ + 5.04206, + 50.08735 + ], + [ + 5.23042, + 49.99214 + ], + [ + 5.40994, + 49.88478 + ], + [ + 5.46178, + 49.85797 + ], + [ + 5.7196, + 49.86279 + ], + [ + 5.74151, + 49.83259 + ], + [ + 5.9387, + 50.22239 + ], + [ + 6.08535, + 50.0011 + ], + [ + 6.12089, + 50.04616 + ], + [ + 6.28373, + 50.09472 + ], + [ + 6.51654, + 49.95863 + ], + [ + 6.61034, + 50.00485 + ], + [ + 6.70295, + 50.00587 + ], + [ + 6.65865, + 50.2947 + ], + [ + 6.79276, + 50.36903 + ], + [ + 7.32163, + 50.31614 + ], + [ + 7.58782, + 50.36737 + ], + [ + 7.7626, + 50.46919 + ], + [ + 7.9826, + 50.96246 + ], + [ + 7.55924, + 51.07086 + ], + [ + 7.58138, + 51.36614 + ], + [ + 7.67861, + 51.52015 + ], + [ + 7.35175, + 51.65781 + ], + [ + 7.21664, + 51.81916 + ], + [ + 7.0467, + 51.9587 + ], + [ + 6.67267, + 51.82713 + ], + [ + 6.48424, + 51.81133 + ], + [ + 6.27316, + 51.9368 + ], + [ + 6.14452, + 52.01701 + ], + [ + 6.09312, + 52.20847 + ], + [ + 6.01297, + 52.23705 + ], + [ + 5.86605, + 50.9745 + ], + [ + 5.73602, + 52.03704 + ] + ] + ] + }, + "properties": { + "type": "boundary" + } + } + ] + }, + { + "error": { + "code": "BadRequest", + "message": "No routable road could be found near one or more specified points." + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostSnapToRoads.json b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostSnapToRoads.json new file mode 100644 index 000000000000..c7a123aeb37e --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostSnapToRoads.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "snapToRoadsRequest": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.336729, + 47.590868 + ], + "type": "Point" + }, + "properties": {} + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.336042, + 47.601604 + ], + "type": "Point" + }, + "properties": {} + } + ], + "includeSpeedLimit": true, + "travelMode": "driving" + } + }, + "responses": { + "200": { + "body": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.336769, + 47.590885 + ], + "type": "Point" + }, + "properties": { + "inputIndex": 0, + "name": "WA-99 N", + "speedLimitInKilometersPerHour": 80 + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.336008, + 47.601609 + ], + "type": "Point" + }, + "properties": { + "inputIndex": 1, + "name": "WA-99 N", + "speedLimitInKilometersPerHour": 80 + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostSnapToRoadsBatch.json b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostSnapToRoadsBatch.json new file mode 100644 index 000000000000..c3b161fff5dc --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-07-01-preview/examples/PostSnapToRoadsBatch.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "snapToRoadsBatchRequest": { + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.336729, + 47.590868 + ], + "type": "Point" + }, + "properties": {} + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.336042, + 47.601604 + ], + "type": "Point" + }, + "properties": {} + } + ], + "includeSpeedLimit": true, + "travelMode": "driving" + }, + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.133269, + 47.6470965 + ], + "type": "Point" + }, + "properties": {} + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -74.00487, + 40.71396 + ], + "type": "Point" + }, + "properties": {} + } + ], + "travelMode": "driving" + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "successfulRequests": 1, + "totalRequests": 2 + }, + "batchItems": [ + { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.336769, + 47.590885 + ], + "type": "Point" + }, + "properties": { + "inputIndex": 0, + "name": "WA-99 N", + "speedLimitInKilometersPerHour": 80 + } + }, + { + "type": "Feature", + "geometry": { + "coordinates": [ + -122.336008, + 47.601609 + ], + "type": "Point" + }, + "properties": { + "inputIndex": 1, + "name": "WA-99 N", + "speedLimitInKilometersPerHour": 80 + } + } + ] + }, + { + "error": { + "code": "BadRequest", + "message": "The distance between two consecutive points (-122.133269,47.6470965) (-74.00487,40.71396) must be within 2.5 kilometers of each other." + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/2024-07-01-preview/route.json b/specification/maps/data-plane/Route/preview/2024-07-01-preview/route.json new file mode 100644 index 000000000000..727a2fb597a6 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/2024-07-01-preview/route.json @@ -0,0 +1,3687 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Route Service", + "version": "2024-07-01-preview", + "description": "Azure Maps Route REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n> [!NOTE]\n> * This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n> * The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n> * The Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n> * Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n> * For more information on Microsoft identity platform, see [Microsoft identity platform overview](/entra/identity-platform/v2-overview).\n\n", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "client" + }, + "Accept-Language": { + "name": "Accept-Language", + "in": "header", + "description": "Language in which routing results should be returned. \n\nFor more information, see [Localization support in Azure Maps](https://learn.microsoft.com/en-us/azure/azure-maps/supported-languages#routing-v2-services-preview-supported-languages).", + "required": false, + "type": "string", + "x-ms-parameter-location": "client" + }, + "OperationId": { + "name": "id", + "description": "System generated unique identifier for the asynchronous operation after it has been submitted.", + "type": "string", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$", + "in": "path", + "required": true + } + }, + "paths": { + "/route/directions": { + "post": { + "summary": "Use to get the best route between an origin and destination for automobile, commercial trucks and walking routes.", + "description": "\n\nThe `Route Directions` API is an HTTP `POST` request that returns the ideal route between an origin and destination for automobile (driving), commercial trucks and walking routes. The route passes through a series of waypoints if specified. A waypoint is a geographical location defined by longitude and latitude that is used for navigational purposes. The route considers factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nThe API returns the distance, estimated travel time, and a representation of the route geometry. More routing information such as an optimized waypoint order or turn by turn instructions is also available, depending on the parameters used.\n\nThe Route Directions considers local laws, vehicle dimensions, cargo type, max speed, bridge and tunnel heights to calculate the truck specific routes and avoid complex maneuvers and difficult roads. Not all trucks can travel the same routes as other vehicles due to certain restrictions based on the vehicle profile or cargo type. For example, highways often have separate speed limits for trucks, some roads don't allow trucks with flammable or hazardous materials, and there can be height and weight restriction on bridges.\n\nUp to 25 waypoints and 10 viaWaypoints between any two waypoints is supported for driving and walking routes. Each set of waypoints creates a separate route Leg. ViaWaypoints define the route path and can be used for route creation through specific locations, but they don't create route Legs. Truck routes support up to 150 waypoints but don't support viaWaypoints.\n\nFor information about routing availability in countries/regions, see [Azure Maps routing coverage](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. For more information, see [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/).\n\n", + "operationId": "Route_PostRouteDirections", + "consumes": [ + "application/geo+json" + ], + "produces": [ + "application/geo+json", + "application/json" + ], + "x-ms-client-name": "Route_PostRouteDirections", + "x-ms-examples": { + "Successfully retrieve a route between an origin and a destination with additional parameters in the body": { + "$ref": "./examples/PostRouteDirections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/Accept-Language" + }, + { + "name": "routeDirectionsRequest", + "in": "body", + "description": "Request body of RouteDirections API in GeoJSON format.", + "required": true, + "schema": { + "$ref": "#/definitions/DirectionsRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteDirectionsResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/directions:batch": { + "post": { + "summary": "Use to send a batch of queries to the [Route Directions](/rest/api/maps/route/post-directions?view=rest-maps-2023-10-01-preview) API in a single synchronous request.", + "description": "\n\n\nThe `Route Directions Batch` API is an HTTP `POST` request that sends batches of up to **100** queries in a single call to the [Route Directions](/rest/api/maps/route/post-directions?view=rest-maps-2023-10-01-preview) API.\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions:batch?api-version=2023-10-01-preview\n```\n### POST Body for Batch Request\nTo send the _directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _directions_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"optionalId\": \"bbc9c0f6-ab52-49d8-a788-a658fa654c94\",\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.3368,\n 47.614988\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 0,\n \"pointType\": \"waypoint\"\n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.316067,\n 47.606356\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 1,\n \"pointType\": \"waypoint\"\n }\n }\n ],\n \"optimizeRoute\": \"fastestWithoutTraffic\",\n \"routeOutputOptions\": [\n \"routeSummary\"\n ],\n \"maxRouteCount\": 3,\n \"travelMode\": \"driving\"\n },\n {\n \"optionalId\": \"a191de3c-1268-4986-98f0-03f0a5d9302a\",\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.3368,\n 47.614988\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 0,\n \"pointType\": \"waypoint\"\n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.316067,\n 47.606356\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 1,\n \"pointType\": \"waypoint\"\n }\n }\n ],\n \"optimizeRoute\": \"shortest\",\n \"routeOutputOptions\": [\n \"routeSummary\"\n ],\n \"maxRouteCount\": 2,\n \"travelMode\": \"driving\"\n }\n ]\n}\n ```\n\nA _directions_ batchItem object can accept any of the supported _directions_ [Request body](/rest/api/maps/route/post-directions?view=rest-maps-2023-10-01-preview#request-body) \n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`DirectionsResponse`](/rest/api/maps/route/post-directions#response) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", + "operationId": "Route_PostRouteDirectionsBatch", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-client-name": "Route_PostRouteDirectionsBatch", + "x-ms-examples": { + "A Route Directions Batch request containing 2 queries": { + "$ref": "./examples/PostRouteDirectionsBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Accept-Language" + }, + { + "name": "routeDirectionsBatchRequest", + "in": "body", + "description": "The list of route directions queries/requests to process. The list can contain a max of 100 queries for sync version and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "#/definitions/DirectionsBatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "Batch request successfully processed. The response body contains all the batch results.", + "schema": { + "$ref": "#/definitions/DirectionsBatchResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/snapToRoads": { + "post": { + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe Snap to Roads API accepts GPS point data, represented as longitude and latitude coordinates, and generates points that aligns with existing roadways on a map. This process, known as \"snapping to roads\", produces a series of objects that trace a path closely following the road network. The resulting data includes road names and their respective speed limits, pertinent to the traversed segments.\n\nMoreover, the Snap to Roads API offers an interpolation feature, which refines the GPS points to create a smoother route that adheres to the road's geometry. This functionality is especially beneficial for asset tracking and enhancing data visualization in mapping applications.\n\n>[!Important]\n> The GPS points must be within 2.5 kilometer of each other.\n\n\n\nFor information about routing availability in countries/regions, see [Azure Maps routing coverage](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n\n", + "operationId": "Route_PostSnapToRoads", + "consumes": [ + "application/geo+json" + ], + "produces": [ + "application/geo+json", + "application/json" + ], + "x-ms-client-name": "Route_PostSnapToRoads", + "x-ms-examples": { + "Successfully retrieve snap to roads points with additional parameters in the body": { + "$ref": "./examples/PostSnapToRoads.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/Accept-Language" + }, + { + "name": "snapToRoadsRequest", + "in": "body", + "description": "Request body of SnapToRoads API in GeoJSON format.", + "required": true, + "schema": { + "$ref": "#/definitions/SnapToRoadsRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapToRoadsResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/snapToRoads:batch": { + "post": { + "description": "**SnapToRoads Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Snap To Roads Batch API sends batches of up to **100** queries as a single call to the [Snap To Roads API](https://learn.microsoft.com/en-us/rest/api/maps/route/post-snap-to-roads?view=rest-maps-2024-07-01-preview).\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/snapToRoads:batch?api-version=2024-07-01-preview\n```\n### POST Body for Batch Request\nTo send the _snap to roads_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _snap to roads_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.122353,\n 47.672662\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.132452,\n 47.644234\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \n }\n }\n ],\n \"interpolate\": true,\n \"includeSpeedLimit\": true,\n \"travelMode\": \"driving\"\n },\n {\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n -122.33669,\n 47.590849\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 0\n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"coordinates\": [\n 122.34509,\n 47.610524\n ],\n \"type\": \"Point\"\n },\n \"properties\": {\n \"pointIndex\": 1\n }\n }\n ],\n \"interpolate\": false,\n \"includeSpeedLimit\": false,\n \"travelMode\": \"driving\"\n }\n ]\n}\n```\n\nA _snap to roads_ batchItem object can accept any of the supported _snap to roads_ [Request body](/rest/api/maps/route/post-snap-to-roads?view=rest-maps-2024-07-01-preview#request-body) \n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`SnapToRoadsResponse`](/rest/api/maps/route/post-snap-to-roads#response) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", + "operationId": "Route_PostSnapToRoadsBatch", + "consumes": [ + "application/geo+json" + ], + "produces": [ + "application/json" + ], + "x-ms-client-name": "Route_PostSnapToRoadsBatch", + "x-ms-examples": { + "A Snap To Roads Batch request containing 1 query": { + "$ref": "./examples/PostSnapToRoadsBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Accept-Language" + }, + { + "name": "snapToRoadsBatchRequest", + "in": "body", + "description": "The list of Snap To Roads queries/requests to process. The list can contain a max of 100 queries for sync version and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "#/definitions/SnapToRoadsBatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "Batch request successfully processed. The response body contains all the batch results.", + "schema": { + "$ref": "#/definitions/SnapToRoadsBatchResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/range": { + "post": { + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe Route Range API creates a polygon that depicts the area reachable from a given location within a certain threshold based on the specified time or distance budget. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point.\n\nThe returned polygon can be used for spatial filtering to search for features of interest within the provided Isochrone.\n\n\n\nFor information about routing availability in countries/regions, see [Azure Maps routing coverage](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n\n", + "operationId": "Route_PostRouteRange", + "consumes": [ + "application/geo+json" + ], + "produces": [ + "application/geo+json", + "application/json" + ], + "x-ms-client-name": "Route_PostRouteRange", + "x-ms-examples": { + "Successfully retrieve a set of locations that can be reached from the origin point based on the specified conditions": { + "$ref": "./examples/PostRouteRange.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "name": "routeRangeRequest", + "in": "body", + "description": "Request body of RouteRange API in GeoJSON format.", + "required": true, + "schema": { + "$ref": "#/definitions/RouteRangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteRangeResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/range:batch": { + "post": { + "description": "**Route Range Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Route Range Batch API sends batches of up to **100** queries as a single call to the [Route Range API](https://learn.microsoft.com/en-us/rest/api/maps/route/post-route-range?view=rest-maps-2024-07-01-preview).\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/range:batch?api-version=2024-07-01-preview\n```\n### POST Body for Batch Request\nTo send the _route range_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _route_range_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 5.86605,\n 50.9745\n ]\n },\n \"properties\": {\n \"timeBudgetInSec\": 6000\n }\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -122.201669,\n 47.615076\n ]\n },\n \"properties\": {\n \"timeBudgetInSec\": 2000\n }\n }\n ]\n}\n```\n\nA _route range_ batchItem object can accept any of the supported _snap to roads_ [Request body](/rest/api/maps/route/post-snap-to-roads?view=rest-maps-2024-07-01-preview#request-body) \n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`RouteRangeResponse`](/rest/api/maps/route/post-route-range#response) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", + "operationId": "Route_PostRouteRangeBatch", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-client-name": "Route_PostRouteRangeBatch", + "x-ms-examples": { + "A Route Range Batch request containing 1 query": { + "$ref": "./examples/PostRouteRangeBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "routeRangeBatchRequest", + "in": "body", + "description": "The list of route directions queries/requests to process. The list can contain a max of 100 queries for sync version and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "#/definitions/RouteRangeBatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "Batch request successfully processed. The response body contains all the batch results.", + "schema": { + "$ref": "#/definitions/RouteRangeBatchResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/matrix": { + "post": { + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe `Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a sync request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. Route Matrices can be calculated for driving, walking and truck routes. For example, a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call the Route Matrix API and use the travel cost to sort the drivers by their actual travel distance or time from the restaurant.\n\n\nRoute Matrices are used in several different types of applications, most commonly to solve the Travelling Salesman Problem (TSP) and Vehicle Routing Problem (VRP). For each origin-destination pair in the matrix, the travel time and distance are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for sync request it's **2500** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 2500, you might want to make synchronous request. The maximum size of a matrix for this API is **2500** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x50, 60x40, 90x20 (it does not need to be square).\n\n\n\n### API Limitations\n The synchronous processing of matrix is best suited for fast, small matrices of route calculation. To calculate larger matrices and heavy route calculation, use the asynchronous endpoint. The following limitation is applicable to the synchronous requests. If none of the rows in the following table match the request's parameters, the request does not meet the requirements and will not be processed.\n\n| Max matrix size | Max number of origins | Max number of destinations | Additional limits\n |------------------|------------------------|----------------------------|------------|\n| 100 | 100 | 100 | N/A |\n| 200 | 200 | 200 | All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise, some matrix cells will be resolved as OUT_OF_REGION. |\n| 2500 | 1000 | 1000 | - `departAt` or `arriveAt` must be any.
- `traffic` must be historical.
- `travelMode` must be either driving or truck
- No other parameters can be used explicitly |\n\n\nExamples:\n - Request of 10x20 matrix with `traffic=live`: This request will be processed with a bounding box limit, as it matches a limit of up to 200, which includes bounding box restrictions.\n\n - Request of 10x20 matrix with default parameters (`traffic=historical`): This request will be processed without a bounding box limit, as it matches a limit of up to 2500, which does not impose bounding box restrictions.\n\n\n", + "operationId": "Route_PostRouteMatrix", + "consumes": [ + "application/geo+json" + ], + "produces": [ + "application/geo+json" + ], + "x-ms-client-name": "Route_PostRouteMatrix", + "x-ms-examples": { + "Successfully retrieve a route matrix with additional parameters in the body": { + "$ref": "./examples/PostRouteMatrix.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "name": "routeMatrixRequest", + "in": "body", + "description": "Request body of RouteMatrix API in GeoJSON format.", + "required": true, + "schema": { + "$ref": "#/definitions/RouteMatrixRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteMatrixResponse" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/matrix:async": { + "post": { + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe `Route Matrix Async` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. Route Matrices can be calculated for driving, walking and truck routes.\n\nRoute Matrices are used in several different types of applications, most commonly to solve the Travelling Salesman Problem (TSP) and Vehicle Routing Problem (VRP). For each origin-destination pair in the matrix, the travel time and distance are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **50000** (the number of origins multiplied by the number of destinations).\n\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a URL in the `operation-Location` field of the response header with the Azure Maps geography endpoint `{geography}.atlas.microsoft.com. This URL should be checked periodically until the status is Succeeded. \n\n\nThe maximum size of a matrix for this API is **50000** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 500x100, 100x100, 280x170. 100x50 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix:async?api-version=2024-07-01-preview&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the `operation-location` header in the response contains the URL to get the status of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/operations/{id}?api-version=2024-07-01-preview?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the resultUrl obtained in Step 3 to get the results\n\n \n\n ```\n GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2024-07-01-preview?subscription-key={subscription-key}\n ```\n\n\n\n ### API Limitations\n The asynchronous processing of matrix is best suited for larger matrices that require heavy route calculation. The following limitation is applicable to the asynchronous requests. If none of the rows in the following table match the request's parameters, the request does not meet the requirements and will not be processed.\n\n > Async requests supports up to 50K matrix size in a single request. If you want to request an increase to this limit, you can create an Azure Maps Technical Support Request in the Azure portal.\n\n \n| Max matrix size  | Max number of origins | Max number of destinations  | Additional limits |\n|------------------|-----------------------|-----------------------------|-------------------|\n| 2500  | 1000  | 1000  | All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise some matrix cells will be resolved as OUT_OF_REGION.  |\n| 50,000  | 10,000  | 10,000  | - `departAt` or `arriveAt` must be any.
- `traffic` must be historical.
- `optimizeRoute` must be fastest.
- `travelMode` must be either driving or truck. 
- No other parameters can be used explicitly.  |\n\n\n", + "operationId": "Route_PostRouteMatrixAsync", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "operation-location", + "final-state-schema": "#/definitions/RouteOperation" + }, + "consumes": [ + "application/geo+json" + ], + "produces": [ + "application/json" + ], + "x-ms-client-name": "Route_PostRouteMatrixAsync", + "x-ms-examples": { + "Submit an asynchronous request for matrix": { + "$ref": "./examples/PostRouteMatrixAsync.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "name": "routeMatrixAsyncRequest", + "in": "body", + "description": "Request body of RouteMatrix API in GeoJSON format.", + "required": true, + "schema": { + "$ref": "#/definitions/RouteMatrixAsyncRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Operation-Location": { + "description": "URL to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/operations/{id}": { + "get": { + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n Get the status of an asynchronous operation by its operation ID.", + "operationId": "Route_GetRouteOperationsStatus", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Retrieve the async matrix operation status": { + "$ref": "./examples/GetRouteOperationStatusCompleted.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/OperationId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteOperation" + } + }, + "404": { + "description": "The operation resource was not found.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + }, + "/route/operations/{id}/result": { + "get": { + "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet the result of an asynchronous operation by its operation ID.", + "operationId": "Route_GetRouteOperationResult", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-client-name": "Route_GetOperationResult", + "x-ms-examples": { + "Retrieve the async matrix result": { + "$ref": "./examples/GetRouteMatrixAsyncResult.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/Accept-Language" + }, + { + "$ref": "#/parameters/OperationId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteOperationResponse" + } + }, + "404": { + "description": "The operation resource result was not found.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/MapsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code of the error that occurred." + } + }, + "x-ms-error-response": true + } + } + } + } + }, + "definitions": { + "DirectionsRequest": { + "description": "This object is the request body.", + "type": "object", + "required": [ + "type", + "features" + ], + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "Driving and walking routes are defined by a set of waypoints(stops) and viaWaypoints (intermediate locations that the route must pass through). You can have a maximum of 25 waypoints, and a maximum of 10 viaWaypoints between each set of waypoints. Truck route supports up to 150 waypoints and viaWaypoints are not supported.\n\nA route must have a minimum of 2 waypoints and the start and end points of the route cannot be viaWaypoints.\n\nBoth waypoint and viaWaypoint locations must be specified as a valid GeoJSON Point feature object along with pointIndex that specifies the order of the locations. For more information on the GeoJSON format, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "minimum": 2, + "items": { + "$ref": "#/definitions/InputWaypointFeaturesItem" + } + }, + "travelMode": { + "description": "The mode of travel for the requested route. If not defined, the default value is \"driving\" that returns the route optimized for cars.\n\n`Note`: For truck travelMode, the requested truck route may not be available for the entire route. Where the truck route is not available for a particular section, the travelMode element of the response for that section will be \"other\".\n\nExample: \"travelMode\":\"driving\"", + "type": "string", + "default": "driving", + "enum": [ + "driving", + "truck", + "walking" + ], + "x-ms-enum": { + "name": "TravelModeEnum", + "modelAsString": true, + "values": [ + { + "value": "driving", + "description": "The returned routes are optimized for cars." + }, + { + "value": "truck", + "description": "The returned routes are optimized for large size trucks based on the vehicle specification." + }, + { + "value": "walking", + "description": "The returned routes are optimized for pedestrians, including the use of sidewalks." + } + ] + } + }, + "departAt": { + "description": "The date and time of departure from the origin point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `departAt` value must be in the future in the date-time format. If not set, the default value is the current time.\n\nExample:\n\n\"departAt\": \"2023-06-01T09:30:00.000-07:00\"", + "type": "string", + "format": "date-time", + "default": "any" + }, + "arriveAt": { + "description": "The date and time of arrival at the destination point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `arriveAt` value must be in the future. The `arriveAt` parameter cannot be used in conjunction with `departAt`.\n\nExample: \"arriveAt\": \"2023-06-01T09:30:00.000-07:00\"", + "type": "string", + "format": "date-time" + }, + "optimizeRoute": { + "description": "Specifies the parameter to use to optimize the route. If not defined, the default is \"fastestWithoutTraffic\" which returns the route to minimize the travel time without using current traffic information.\n\nExample: \"optimizeRoute\":\"shortest\"", + "type": "string", + "default": "fastestWithoutTraffic", + "enum": [ + "shortest", + "fastestWithoutTraffic", + "fastestAvoidClosureWithoutTraffic", + "fastestWithTraffic" + ], + "x-ms-enum": { + "name": "RouteDirectionOptimizeRouteEnum", + "modelAsString": true, + "values": [ + { + "value": "shortest", + "name": "Shortest", + "description": "The route is calculated to minimize the distance. Traffic information is not used." + }, + { + "value": "fastestWithoutTraffic", + "name": "FastestWithoutTraffic", + "description": "Finds the fastest route, without factoring in traffic information." + }, + { + "value": "fastestAvoidClosureWithoutTraffic", + "name": "FastestAvoidClosureWithoutTraffic", + "description": "The route is calculated to minimize the time and avoid road closures. No traffic information except for road closures is used in the calculation. `Note`: Only supported for driving travelMode." + }, + { + "value": "fastestWithTraffic", + "name": "FastestWithTraffic", + "description": "The route is calculated to minimize the time using current traffic information. `Note`: Only supported for driving and truck travelMode." + } + ] + } + }, + "optimizeWaypointOrder": { + "description": "Re-order the route waypoints using a fast heuristic algorithm to reduce the route cost specified with the optimize parameter. The origin and destination are excluded from the optimized waypoint and their position is considered fixed. Acceptable values are true or false.\n\n`Note`: Only supported for truck travelMode.", + "type": "boolean", + "default": false + }, + "avoid": { + "$ref": "#/definitions/AvoidEnum" + }, + "routeOutputOptions": { + "description": "Include the desired route information from the response. By default, the itinerary is included in the response.\n\nSupports multiple values such as \"routeOutputOptions\": [\"routePath\", \"regionTravelSummary\"]", + "type": "array", + "default": [ + "itinerary" + ], + "items": { + "type": "string", + "enum": [ + "routeSummary", + "regionTravelSummary", + "routePath", + "itinerary" + ], + "x-ms-enum": { + "name": "RouteOutputOptionEnum", + "modelAsString": true, + "values": [ + { + "value": "routeSummary", + "description": "Include only travel time and distance for the route, and do not provide other information." + }, + { + "value": "regionTravelSummary", + "description": "Include travel summary of distance, time, and toll road distance by two entity types: country (e.g., US, Canada) and administrative division or subregion (e.g., \"state\" in US and \"province\" in Canada). `Note`: Only supported for driving and walking travelMode" + }, + { + "value": "routePath", + "description": "Include a GeoJSON MultiLineString [RFC 7946, section 3.1.5](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.5) that describe the route's path in the response." + }, + { + "value": "itinerary", + "description": "Include detailed directions in the response. Detailed directions are provided as \"ManeuverPoints\" and contain details such as turn-by-turn instructions." + } + ] + } + } + }, + "maxRouteCount": { + "description": "The maximum number of routes to return. Available for the driving and truck travel modes.\n\nFor driving routes, this parameter supports routes with up to two waypoints in addition to the origin and destination and avoid parameter must not be set.\n\nDefault: \"maxRouteCount\":1\n\nMinimum: \"maxRouteCount\":1\n\nMaximum: \"maxRouteCount\":3", + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 3 + }, + "heading": { + "description": "The initial directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359", + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 359 + }, + "vehicleSpec": { + "description": "Specifies the vehicle attributes such as size, weight, max speed, type of cargo, etc. for truck routing only. This helps avoid low bridge clearances, road restrictions, difficult right turns to provide the optimized truck route based on the vehicle specifications.\n\n`Note`: Only supported for truck travelMode", + "$ref": "#/definitions/RouteDirectionVehicleSpec" + } + } + }, + "RouteDirectionsResponse": { + "description": "This object is returned from a successful call.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureCollection" + }, + { + "type": "object", + "description": "Alternative route.", + "properties": { + "alternativeRoutes": { + "description": "Alternative route.", + "type": "array", + "items": { + "$ref": "#/definitions/FeatureCollection" + } + } + } + } + ] + }, + "SnapToRoadsRequest": { + "description": "This object is the request body.", + "type": "object", + "required": [ + "type", + "features" + ], + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "A set of points to snap to road network. You can have a maximum of 100 points and the two consecutive points must be within 2.5 kilometer of each other. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details on the GeoJSON format.\n\n`Note`: The API will not return a point object in the response for the GPS point that cannot be snapped to a road network.", + "minimum": 2, + "maximum": 100, + "items": { + "$ref": "#/definitions/InputSnapToRoadsFeaturesItem" + } + }, + "interpolate": { + "description": "Specifies whether to return additional points between the snapped points to complete the full route path that smoothly follows the road geometry. \n\nThe interpolated points will have `isInterpolate:true` in the response which can be used to identify the snapped points from interpolated points.", + "type": "boolean", + "default": false + }, + "includeSpeedLimit": { + "description": "Specifies whether to include speed limit information for the snapped points in the response. The unit is in kilometers per hour. \n\n`Note`: Only supported for driving travelMode.", + "type": "boolean", + "default": false + }, + "travelMode": { + "description": "Specifies the routing profile for snapping the points. If unspecified, the default mode is \"driving\", which optimizes the snapped points for driving routes.", + "type": "string", + "default": "driving", + "enum": [ + "driving", + "walking" + ], + "x-ms-enum": { + "name": "SnapToRoadsTravelModeEnum", + "modelAsString": true, + "values": [ + { + "value": "driving", + "description": "The points are snapped to the road suitable for cars." + }, + { + "value": "walking", + "description": "The points are snapped to the pedestrian route including the use of sidewalks." + } + ] + } + } + } + }, + "SnapToRoadsResponse": { + "description": "This object is returned from a successful call.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "`GeoJSON` feature object that contains Geometry object and additional properties. Refer to [RFC 7946, Section 3.2](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) for details.", + "items": { + "$ref": "#/definitions/SnapToRoadFeaturesItem" + } + } + } + }, + "RouteRangeRequest": { + "type": "object", + "description": "Specifies the starting point for range calculation. `GeoJSON` feature object and additional properties. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "required": [ + "type", + "geometry", + "properties" + ], + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "#/definitions/RouteRangePointGeometry" + }, + "properties": { + "$ref": "#/definitions/InputRouteRangeProperties" + } + } + }, + "RouteRangeResponse": { + "description": "This object is returned from a successful call.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "`GeoJSON` feature object that contains Geometry object and additional properties. Refer to [RFC 7946, Section 3.2](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) for details.", + "items": { + "$ref": "#/definitions/RouteRangeFeaturesItem" + } + } + } + }, + "RouteMatrixRequest": { + "description": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destination. `GeoJSON` feature object and additional properties. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "type": "object", + "required": [ + "type", + "features" + ], + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "A set of origin and destination points passed as GeoJSON MultiPoint features for the input matrix. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details on the GeoJSON format.", + "minimum": 2, + "maximum": 2, + "items": { + "$ref": "#/definitions/InputRouteMatrixFeaturesItem" + } + }, + "departAt": { + "description": "The date and time of departure from the origin point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `departAt` value must be in the future in the date-time format. The `departAt` parameter cannot be used in conjunction with `arriveAt`.\n\nThe `departAt` also supports:\n\n `any` value tailored to the use case where the time context is irrelevant. The `traffic=live` parameter value cannot be used together with `any`.\n\n`now` value to set the departure time to the processing time of each individual cell. Processing time may be any time between submission and its completion. This mode is best used together with traffic=live.\n\nDefault value: `any` if `departAt` is not specified.\n\nExamples:\n\n\"departAt\": \"2024-12-01T09:30:00.000-07:00\"", + "type": "string", + "format": "date-time" + }, + "arriveAt": { + "description": "The date and time of arrival at the destination point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `arriveAt` value must be in the future. The `arriveAt` parameter cannot be used in conjunction with `departAt`.\n\nThe `arriveAt` also supports `any` value which is tailored to the use case where the time context is irrelevant. The `traffic=live` parameter value cannot be used together with `any`.\n\nDefault value: `any` if `arriveAt` is not specified.\n\nExample: \"arriveAt\": \"2024-12-01T09:30:00.000-07:00\"", + "type": "string", + "format": "date-time" + }, + "travelMode": { + "$ref": "#/definitions/RouteMatrixTravelModeEnum" + }, + "optimizeRoute": { + "description": "Specifies the parameter to use to optimize the route. If not defined, the default is \"fastest\" which returns the route to minimize the travel time.\n\nExample: \"optimizeRoute\":\"fastest \"", + "type": "string", + "default": "fastest", + "enum": [ + "fastest" + ], + "x-ms-enum": { + "name": "RouteMatrixOptimizeRouteEnum", + "modelAsString": true, + "values": [ + { + "value": "fastest", + "name": "Fastest", + "description": "Finds the fastest route to optimize route by travel time.\n\nOnly `fastest` is supported for the Route Matrix sync API. To use the other types, check the Route Matrix async API." + } + ] + } + }, + "traffic": { + "$ref": "#/definitions/RouteMatrixTrafficEnum" + }, + "avoid": { + "description": "Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteMatrixAvoidEnum" + } + }, + "vehicleSpec": { + "$ref": "#/definitions/RouteMatrixVehicleSpec" + } + } + }, + "RouteMatrixAsyncRequest": { + "description": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destination. `GeoJSON` feature object and additional properties. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "type": "object", + "required": [ + "type", + "features" + ], + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "type": "array", + "description": "A set of origin and destination points passed as GeoJSON MultiPoint features for the input matrix. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details on the GeoJSON format.", + "minimum": 2, + "maximum": 2, + "items": { + "$ref": "#/definitions/InputRouteMatrixFeaturesItem" + } + }, + "departAt": { + "description": "The date and time of departure from the origin point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `departAt` value must be in the future in the date-time format. The `departAt` parameter cannot be used in conjunction with `arriveAt`.\n\nThe `departAt` also supports:\n\n `any` value tailored to the use case where the time context is irrelevant. The `traffic=live` parameter value cannot be used together with `any`.\n\n`now` value to set the departure time to the processing time of each individual cell. Processing time may be any time between submission and its completion. This mode is best used together with traffic=live.\n\nDefault value: `any` if `departAt` is not specified.\n\nExamples:\n\n\"departAt\": \"2024-12-01T09:30:00.000-07:00\"", + "type": "string" + }, + "arriveAt": { + "description": "The date and time of arrival at the destination point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `arriveAt` value must be in the future. The `arriveAt` parameter cannot be used in conjunction with `departAt`.\n\nThe `arriveAt` also supports `any` value which is tailored to the use case where the time context is irrelevant. The `traffic=live` parameter value cannot be used together with `any`.\n\nDefault value: `any` if `arriveAt` is not specified.\n\nExample: \"arriveAt\": \"2024-12-01T09:30:00.000-07:00\"", + "type": "string" + }, + "travelMode": { + "$ref": "#/definitions/RouteMatrixTravelModeEnum" + }, + "optimizeRoute": { + "description": "Specifies the parameter to use to optimize the route. If not defined, the default is \"fastest\" which returns the route to minimize the travel time.\n\nExample: \"optimizeRoute\":\"shortest\"", + "type": "string", + "default": "fastest", + "enum": [ + "shortest", + "fastest" + ], + "x-ms-enum": { + "name": "RouteMatrixAsyncOptimizeRouteEnum", + "modelAsString": true, + "values": [ + { + "value": "shortest", + "name": "Shortest", + "description": "Finds the shortest route to optimize route by travel distance." + }, + { + "value": "fastest", + "name": "Fastest", + "description": "Finds the fastest route to optimize route by travel time." + } + ] + } + }, + "traffic": { + "$ref": "#/definitions/RouteMatrixTrafficEnum" + }, + "avoid": { + "description": "Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteMatrixAvoidEnum" + } + }, + "vehicleSpec": { + "$ref": "#/definitions/RouteMatrixVehicleSpec" + } + } + }, + "RouteMatrixResponse": { + "description": "This object is returned from a successful call.", + "type": "object", + "required": [ + "type", + "geometry", + "properties" + ], + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "description": "The geometry object is null", + "type": "object" + }, + "properties": { + "$ref": "#/definitions/RouteMatrixFeatureProperties" + } + } + }, + "RouteOperationResponse": { + "type": "object", + "description": "This object is returned from a successful call.", + "properties": { + "kind": { + "$ref": "#/definitions/RouteOperationKindEnum" + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "RouteMatrixAsyncResponse": { + "type": "object", + "x-ms-discriminator-value": "RouteMatrix", + "description": "Specifies the driving instructions and additional properties for each maneuver point in the route Leg.", + "allOf": [ + { + "$ref": "#/definitions/RouteOperationResponse" + }, + { + "$ref": "#/definitions/RouteMatrixResponse" + } + ] + }, + "FeatureCollection": { + "description": "`GeoJSON` `FeatureCollection` object that contains a list of Features. For more information, see [RFC 7946, section 3.3](https://www.rfc-editor.org/rfc/rfc7946#section-3.3).", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/FeatureTypeEnum" + }, + "features": { + "$ref": "#/definitions/Features" + } + } + }, + "RegionTravelSummary": { + "description": "Travel summary of distance, time, and toll road distance by two entity types: country (e.g. US, Canada) and administrative division or subregion (e.g. “state” in US and “province” in Canada).", + "type": "object", + "properties": { + "countryRegion": { + "description": "Country region name.", + "type": "string", + "readOnly": true + }, + "adminDistricts": { + "description": "adminDistrict array.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AdminDistrict" + } + }, + "distanceInMeters": { + "description": "Length In Meters property", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "Estimated travel time in seconds that does not include delays on the route due to traffic conditions.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "durationTrafficInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.", + "format": "int64", + "type": "integer", + "readOnly": true + } + } + }, + "FeatureTypeEnum": { + "type": "string", + "description": "Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "enum": [ + "FeatureCollection" + ], + "x-ms-enum": { + "name": "FeatureTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "FeatureCollection", + "description": "Specifies the `GeoJSON` `FeatureCollection` object type." + } + ] + } + }, + "FeaturesItemTypeEnum": { + "type": "string", + "description": "Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "enum": [ + "Feature" + ], + "x-ms-enum": { + "name": "FeaturesItemTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "Feature", + "description": "Specifies the `GeoJSON` Feature object type." + } + ] + } + }, + "Bbox": { + "description": "A rectangular area on the earth defined as a bounding box object. The sides of the rectangles are defined by latitude and longitude values. For more information, see [RFC 7946, Section 5](https://www.rfc-editor.org/rfc/rfc7946#section-5).\n\nExample: \"bbox\": [-10.0, -10.0, 10.0, 10.0]", + "type": "array", + "items": { + "type": "number", + "format": "double" + }, + "minItems": 4, + "maxItems": 4 + }, + "Features": { + "type": "array", + "description": "`GeoJSON` feature object that contains Geometry object and additional properties. For more information, see [RFC 7946, Section 3.2](https://www.rfc-editor.org/rfc/rfc7946#section-3.2).", + "items": { + "$ref": "#/definitions/FeaturesItem" + } + }, + "FeaturesItem": { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "allOf": [ + { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "#/definitions/RouteDirectionsGeometry" + }, + "properties": { + "$ref": "#/definitions/FeatureProperties" + }, + "bbox": { + "$ref": "#/definitions/Bbox" + } + } + } + ] + }, + "RouteDirectionsGeometry": { + "type": "object", + "description": "A valid `GeoJSON` Geometry object. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "properties": { + "type": { + "description": "Specifies the geometry type for the `GeoJSON` Geometry object. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "type": "string" + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "RouteRangeGeometry": { + "type": "object", + "description": "A valid `GeoJSON` Geometry object. Please refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "properties": { + "type": { + "description": "Specifies the geometry type for the `GeoJSON` Geometry object. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "type": "string" + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "PointGeometry": { + "type": "object", + "description": "The origin point passed as a valid `GeoJSON` Geometry object, from which the range polygon should be calculated. Please refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.\n\n`Note`: The API will snap the requested origin point to the nearest road network and will use that for range calculation. It will be returned as a `center` point in the response.", + "x-ms-discriminator-value": "Point", + "allOf": [ + { + "$ref": "#/definitions/RouteDirectionsGeometry" + }, + { + "$ref": "#/definitions/GeoJsonPoint" + } + ] + }, + "MultiLineStringGeometry": { + "type": "object", + "description": "Specifies the `GeoJSON` MultiLineString Geometry object. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "x-ms-discriminator-value": "MultiLineString", + "allOf": [ + { + "$ref": "#/definitions/RouteDirectionsGeometry" + }, + { + "$ref": "#/definitions/GeoJsonMultiLineString" + } + ] + }, + "RouteRangePolygonGeometry": { + "type": "object", + "description": "Specifies the `GeoJSON` Polygon Geometry object. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "x-ms-discriminator-value": "Polygon", + "allOf": [ + { + "$ref": "#/definitions/RouteRangeGeometry" + }, + { + "$ref": "#/definitions/GeoJsonPolygon" + } + ] + }, + "RouteRangePointGeometry": { + "type": "object", + "description": "Specifies the `GeoJSON` Point Geometry object. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "x-ms-discriminator-value": "Point", + "allOf": [ + { + "$ref": "#/definitions/RouteRangeGeometry" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonPointData" + } + ] + }, + "GeoJsonPoint": { + "description": "A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonGeometry" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonPointData" + } + ] + }, + "GeoJsonMultiPoint": { + "description": "A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonGeometry" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonMultiPointData" + } + ] + }, + "GeoJsonMultiLineString": { + "description": "A valid `GeoJSON MultiLineString` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.5) for details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonGeometry" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonMultiLineStringData" + } + ] + }, + "GeoJsonPolygon": { + "description": "A valid `GeoJSON Polygon` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.6) for details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonGeometry" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonPolygonData" + } + ] + }, + "InputWaypointFeaturesItem": { + "type": "object", + "description": "Specifies the input waypoint and viaWaypoint `GeoJSON` feature object and additional properties. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonPoint" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InputWaypointProperties" + } + }, + "required": [ + "type", + "geometry", + "properties" + ] + }, + "InputWaypointProperties": { + "type": "object", + "description": "Specifies the properties of a Waypoint which is a specific location or point along a route or trip that serves as a reference or stopping point.", + "properties": { + "pointIndex": { + "description": "Identify and order the sequence of waypoints in the route. The default value is the `index value` of a features array.", + "format": "int64", + "type": "integer" + }, + "pointType": { + "$ref": "#/definitions/InputWaypointTypeEnum" + } + } + }, + "WaypointProperties": { + "x-ms-discriminator-value": "Waypoint", + "type": "object", + "description": "Specifies the properties of a Waypoint which is a specific location or point along a route or trip that serves as a reference or stopping point.", + "allOf": [ + { + "$ref": "#/definitions/FeatureProperties" + }, + { + "$ref": "#/definitions/NavigationPointProperties" + } + ] + }, + "ManeuverPointProperties": { + "x-ms-discriminator-value": "ManeuverPoint", + "type": "object", + "description": "Specifies the driving instructions and additional properties for each maneuver point in the route Leg.", + "allOf": [ + { + "$ref": "#/definitions/FeatureProperties" + }, + { + "$ref": "#/definitions/NavigationPointProperties" + } + ] + }, + "NavigationPointProperties": { + "description": "Waypoint and ManeuverPoint properties.", + "type": "object", + "properties": { + "routePathPoint": { + "$ref": "#/definitions/RoutePathPoint" + }, + "order": { + "$ref": "#/definitions/Order" + }, + "compassDirection": { + "description": "The direction of travel associated with a maneuver on a route, such as south or southwest. `Note`: Only supported for driving travelMode.", + "type": "string", + "readOnly": true + }, + "steps": { + "description": "Steps between two consecutive maneuver points.", + "type": "array", + "items": { + "$ref": "#/definitions/Step" + } + }, + "instruction": { + "$ref": "#/definitions/Instruction" + }, + "sideOfStreet": { + "$ref": "#/definitions/SideOfStreetEnum" + }, + "signs": { + "description": "Signage text for the route. There may be more than one sign value.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "towardsRoadName": { + "description": "The name of the street that the route goes towards in the first `ManeuverPoint`.", + "type": "string", + "readOnly": true + }, + "exitIdentifier": { + "description": "The name or number of the exit associated with this route step.", + "type": "string", + "readOnly": true + }, + "distanceInMeters": { + "description": "The physical distance in meters covered by this route step.", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance`.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "travelMode": { + "$ref": "#/definitions/RoutePathTravelModeEnum" + } + } + }, + "ViaWaypointProperties": { + "x-ms-discriminator-value": "ViaWaypoint", + "type": "object", + "description": "Specifies the properties of a `ViaWaypoint` which is a waypoint that must be passed through or visited along a route or trip.", + "allOf": [ + { + "$ref": "#/definitions/FeatureProperties" + }, + { + "description": "Specifies the properties of a ViaWaypoint which is a waypoint that must be passed through or visited along a route or trip.", + "type": "object", + "properties": { + "names": { + "description": "A street, highway or intersection where the maneuver occurs. If the maneuver is complex, there may be more than one name field in the details collection. The name field may also have no value. This can occur if the name is not known or if a street, highway or intersection does not have a name.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "routePathPoint": { + "$ref": "#/definitions/RoutePathPoint" + }, + "order": { + "$ref": "#/definitions/Order" + } + } + } + ] + }, + "RoutePathProperties": { + "x-ms-discriminator-value": "RoutePath", + "type": "object", + "description": "Specifies the properties that describe the route's path in the response.", + "allOf": [ + { + "$ref": "#/definitions/FeatureProperties" + }, + { + "type": "object", + "description": "Specifies the properties that describe the route's path in the response.", + "properties": { + "resourceId": { + "description": "A unique ID for the resource.", + "type": "string", + "readOnly": true + }, + "distanceInMeters": { + "description": "The physical distance in meters covered by the entire route.", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "Estimated travel time in seconds that does not include delays on the route due to traffic conditions.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "durationTrafficInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "trafficDataUsed": { + "$ref": "#/definitions/TrafficDataUsedEnum" + }, + "trafficCongestion": { + "$ref": "#/definitions/TrafficCongestionEnum" + }, + "departureTime": { + "description": "The estimated departure time for the leg, which takes into account the traffic conditions, is formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "arrivalTime": { + "description": "The estimated arrival time for the leg, which takes into account the traffic conditions, is formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "legs": { + "description": "An array of route Legs. Check route Leg object description for more information.", + "type": "array", + "items": { + "$ref": "#/definitions/Leg" + } + } + } + } + ] + }, + "FeatureProperties": { + "type": "object", + "description": "Specifies the feature properties of the route like itinerary, route Legs and geometry, travel summary.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturePropertiesTypeEnum" + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "FeaturePropertiesTypeEnum": { + "description": "Output type.", + "type": "string", + "readOnly": true, + "enum": [ + "ManeuverPoint", + "Waypoint", + "ViaWaypoint", + "RoutePath" + ], + "x-ms-enum": { + "name": "PropertiesTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "ManeuverPoint", + "description": "A maneuverPoint is a specific point on a route or trip where a change in direction or mode of transportation is required or recommended." + }, + { + "value": "Waypoint", + "description": "A waypoint is a specific location or point along a route or trip that serves as a reference or stopping point." + }, + { + "value": "ViaWaypoint", + "description": "A viaWaypoint is specific waypoint that must be passed through or visited along a route or trip." + }, + { + "value": "RoutePath", + "description": "A routePath is a line that represents the path of a route or trip." + } + ] + } + }, + "InputWaypointTypeEnum": { + "description": "Waypoint type on the route. It can be a stop or an intermediate location that the route must pass through.", + "type": "string", + "default": "waypoint", + "enum": [ + "waypoint", + "viaWaypoint" + ], + "x-ms-enum": { + "name": "InputWaypointTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "waypoint", + "description": "A waypoint is a specific location or point along a route or trip that serves as a reference or stopping point." + }, + { + "value": "viaWaypoint", + "description": "A viaWaypoint is a specific waypoint that must be passed through or visited along a route or trip. `Note`: Only supported for driving travelMode." + } + ] + } + }, + "AdminDistrict": { + "description": "The subdivision name in the country or region for an address. This element is typically treated as the first order administrative subdivision, but in some cases it also contains the second, third, or fourth order subdivision in a country, dependency, or region.", + "type": "object", + "properties": { + "longName": { + "description": "The long name of an address, such as Washington.", + "type": "string", + "readOnly": true + }, + "distanceInMeters": { + "description": "The total distance traveled in meters within the administrative district.", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "Estimated travel time in seconds that does not include delays on the route due to traffic conditions.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "durationTrafficInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.", + "format": "int64", + "type": "integer", + "readOnly": true + } + } + }, + "Leg": { + "x-ms-client-name": "RouteLeg", + "description": "Information about a section of a route between two waypoints. More information about the fields contained in a route Leg:", + "type": "object", + "properties": { + "description": { + "description": "A short description of the route.", + "type": "string", + "readOnly": true + }, + "routePathRange": { + "$ref": "#/definitions/RoutePathRange" + }, + "distanceInMeters": { + "description": "The physical distance in meters covered by a route Leg.", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "Estimated travel time in seconds that does not include delays on the route due to traffic conditions.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "durationTrafficInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "departureTime": { + "description": "The estimated departure time for the leg, which takes into account the traffic conditions, is formatted as a dateTime value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "arrivalTime": { + "description": "The estimated arrival time for the leg, which takes into account the traffic conditions, is formatted as a dateTime value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "subLegs": { + "description": "Information about a segments of the route Leg defined by the route Leg waypoints and any intermediate via-waypoints. For example, if the route Leg has two via-waypoints in addition to start and end waypoints, there would be three (3) route sub-legs.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SubLeg" + } + }, + "regionTravelSummary": { + "description": "Include travel summary of distance, time, and toll road distance by two entity types: country (e.g. US, Canada) and administrative division or subregion (e.g. “state” in US and “province” in Canada).", + "$ref": "#/definitions/RegionTravelSummary" + } + } + }, + "SubLeg": { + "x-ms-client-name": "RouteSubLeg", + "description": "Information about a segments of the route Leg defined by the route Leg waypoints and any intermediate via-waypoints. For example, if the route Leg has two via-waypoints in addition to start and end waypoints, there would be three (3) route sub-legs.", + "type": "object", + "properties": { + "routePathRange": { + "$ref": "#/definitions/RoutePathRange" + }, + "distanceInMeters": { + "description": "The physical distance in meters covered by the sub-leg.", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "Estimated travel time in seconds that does not include delays on the route due to traffic conditions.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "durationTrafficInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.", + "format": "int64", + "type": "integer", + "readOnly": true + } + } + }, + "RoutePathRange": { + "description": "Refers to the range covered by a specific Leg of a route or path.", + "type": "object", + "properties": { + "range": { + "description": "Refers to the range covered by a specific Leg of a route or path.", + "type": "array", + "readOnly": true, + "maximum": 2, + "maxItems": 2, + "items": { + "format": "int64", + "type": "integer" + } + }, + "legIndex": { + "$ref": "#/definitions/LegIndex" + } + } + }, + "RoutePathPoint": { + "description": "Refers to the index of a point within a specific Leg of a route.", + "type": "object", + "properties": { + "legIndex": { + "$ref": "#/definitions/LegIndex" + }, + "pointIndex": { + "description": "Index of a point within a specific Leg.", + "format": "int64", + "type": "integer", + "readOnly": true + } + } + }, + "LegIndex": { + "description": "The route Leg index is a sequential number assigned to each Leg of the route to help identify and distinguish between different segments of the route.", + "readOnly": true, + "format": "int64", + "type": "integer" + }, + "Hint": { + "description": "Additional information that may be helpful in following a route. In addition to the hint text, this element has an attribute hintType that specifies what the hint refers to, such as “NextIntersection.” Hint is an optional element. `Note`: Only supported for driving travelMode.", + "type": "object", + "properties": { + "hintType": { + "description": "hint type.", + "type": "string", + "readOnly": true + }, + "text": { + "description": "hint text.", + "type": "string", + "readOnly": true + } + } + }, + "Step": { + "x-ms-client-name": "RouteStep", + "description": "A route Leg contain turn-by-turn instructions. A step refers to a range of a route between two consecutive maneuverPoint.", + "type": "object", + "properties": { + "compassDegrees": { + "description": "The direction in degrees. `Note`: Only supported for driving travelMode.", + "readOnly": true, + "type": "number" + }, + "maneuverType": { + "readOnly": true, + "$ref": "#/definitions/ManeuverTypeEnum" + }, + "names": { + "description": "A street, highway or intersection where the maneuver occurs. If the maneuver is complex, there may be more than one name field in the details collection. The name field may also have no value. This can occur if the name is not known or if a street, highway or intersection does not have a name.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "routePathRange": { + "$ref": "#/definitions/RoutePathRange" + }, + "roadType": { + "readOnly": true, + "$ref": "#/definitions/RoadTypeEnum" + } + } + }, + "ManeuverTypeEnum": { + "description": "The type of maneuver described by this detail collection. The ManeuverType in A detail collection can provide information for a portion of the maneuver described by the maneuverType attribute of the corresponding Instruction. For example the maneuverType attribute of an Instruction may specify TurnLeftThenTurnRight as the maneuver while the associated detail items may specify specifics about the TurnLeft and TurnRight maneuvers.", + "type": "string", + "readOnly": true, + "enum": [ + "ArriveFinish", + "ArriveIntermediate", + "BearLeft", + "BearLeftThenBearLeft", + "BearLeftThenBearRight", + "BearLeftThenTurnLeft", + "BearLeftThenTurnRight", + "BearRight", + "BearRightThenBearLeft", + "BearRightThenBearRight", + "BearRightThenTurnLeft", + "BearRightThenTurnRight", + "BearThenKeep", + "BearThenMerge", + "Continue", + "DepartIntermediateStop", + "DepartIntermediateStopReturning", + "DepartStart", + "EnterRoundabout", + "ExitRoundabout", + "EnterThenExitRoundabout", + "ExitRoundaboutRight", + "ExitRoundaboutLeft", + "Follow", + "GoAroundRoundabout", + "KeepLeft", + "KeepOnRampLeft", + "KeepOnRampRight", + "KeepOnRampStraight", + "KeepRight", + "KeepStraight", + "KeepToStayLeft", + "KeepToStayRight", + "KeepToStayStraight", + "MergeFreeway", + "MergeHighway", + "MergeMotorway", + "MotorwayExitLeft", + "MotorwayExitRight", + "None", + "RampThenHighwayLeft", + "RampThenHighwayRight", + "RampThenHighwayStraight", + "RoadNameChange", + "SwitchToParallelRoad", + "SwitchToMainRoad", + "Take", + "TakeFerry", + "TakeExit", + "TakeRamp", + "TakeRampLeft", + "TakeRampRight", + "TakeRampStraight", + "TurnBack", + "TurnLeft", + "TurnLeftSharp", + "TurnLeftThenBearLeft", + "TurnLeftThenBearRight", + "TurnLeftThenTurnLeft", + "TurnLeftThenTurnRight", + "TurnRight", + "TurnRightSharp", + "TurnRightThenBearLeft", + "TurnRightThenBearRight", + "TurnRightThenTurnLeft", + "TurnRightThenTurnRight", + "TurnThenMerge", + "TurnToStayLeft", + "TurnToStayRight", + "Unknown", + "UTurn", + "Wait", + "Walk" + ], + "x-ms-enum": { + "name": "ManeuverTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "ArriveFinish", + "name": "ArriveFinish", + "description": "Arrive at the final destination." + }, + { + "value": "ArriveIntermediate", + "name": "ArriveIntermediate", + "description": "Arrive at an intermediate waypoint." + }, + { + "value": "BearLeft", + "name": "BearLeft", + "description": "Bear left." + }, + { + "value": "BearLeftThenBearLeft", + "name": "BearLeftThenBearLeft", + "description": "Bear left and then bear left again." + }, + { + "value": "BearLeftThenBearRight", + "name": "BearLeftThenBearRight", + "description": "Bear left and then bear right." + }, + { + "value": "BearLeftThenTurnLeft", + "name": "BearLeftThenTurnLeft", + "description": "Bear left and then turn left." + }, + { + "value": "BearLeftThenTurnRight", + "name": "BearLeftThenTurnRight", + "description": "Bear left and then turn right." + }, + { + "value": "BearRight", + "name": "BearRight", + "description": "Bear right." + }, + { + "value": "BearRightThenBearLeft", + "name": "BearRightThenBearLeft", + "description": "Bear right and then bear left." + }, + { + "value": "BearRightThenBearRight", + "name": "BearRightThenBearRight", + "description": "Bear right and then bear right again." + }, + { + "value": "BearRightThenTurnLeft", + "name": "BearRightThenTurnLeft", + "description": "Bear right and then turn left." + }, + { + "value": "BearRightThenTurnRight", + "name": "BearRightThenTurnRight", + "description": "Bear right and then turn right." + }, + { + "value": "BearThenKeep", + "name": "BearThenKeep", + "description": "Bear instruction and then a keep instruction" + }, + { + "value": "DepartStart", + "name": "DepartStart", + "description": "Leave the starting point." + }, + { + "value": "BearThenMerge", + "name": "BearThenMerge", + "description": "Bear instruction and then a merge instruction." + }, + { + "value": "Continue", + "name": "Continue", + "description": "Continue on the current road." + }, + { + "value": "DepartIntermediateStop", + "name": "DepartIntermediateStop", + "description": "Leave an intermediate waypoint in a different direction and road than you arrived on." + }, + { + "value": "DepartIntermediateStopReturning", + "name": "DepartIntermediateStopReturning", + "description": "Leave an intermediate waypoint in the same direction and on the same road that you arrived on." + }, + { + "value": "EnterRoundabout", + "name": "EnterRoundabout", + "description": "Enter a roundabout." + }, + { + "value": "ExitRoundabout", + "name": "ExitRoundabout", + "description": "Exit a roundabout." + }, + { + "value": "EnterThenExitRoundabout", + "name": "EnterThenExitRoundabout", + "description": "Enter and exit a roundabout." + }, + { + "value": "ExitRoundaboutRight", + "name": "ExitRoundaboutRight", + "description": "At the roundabout take the exit on the right." + }, + { + "value": "ExitRoundaboutLeft", + "name": "ExitRoundaboutLeft", + "description": "At the roundabout take the exit on the left." + }, + { + "value": "Follow", + "name": "Follow", + "description": "Follow." + }, + { + "value": "GoAroundRoundabout", + "name": "GoAroundRoundabout", + "description": "Go around the roundabout." + }, + { + "value": "KeepLeft", + "name": "KeepLeft", + "description": "Keep left onto a different road." + }, + { + "value": "KeepOnRampLeft", + "name": "KeepOnRampLeft", + "description": "Keep left and continue onto ramp." + }, + { + "value": "KeepOnRampRight", + "name": "KeepOnRampRight", + "description": "Keep right and continue onto ramp." + }, + { + "value": "KeepOnRampStraight", + "name": "KeepOnRampStraight", + "description": "Keep straight and continue onto ramp." + }, + { + "value": "KeepRight", + "name": "KeepRight", + "description": "Keep right onto a different road." + }, + { + "value": "KeepStraight", + "name": "KeepStraight", + "description": "Keep straight onto a different road." + }, + { + "value": "KeepToStayLeft", + "name": "KeepToStayLeft", + "description": "Keep left to stay on the same road." + }, + { + "value": "KeepToStayRight", + "name": "KeepToStayRight", + "description": "Keep right to stay on the same road." + }, + { + "value": "KeepToStayStraight", + "name": "KeepToStayStraight", + "description": "Keep straight to stay on the same road." + }, + { + "value": "MergeFreeway", + "name": "MergeFreeway", + "description": "Merge onto a freeway." + }, + { + "value": "MergeHighway", + "name": "MergeHighway", + "description": "Merge onto a highway." + }, + { + "value": "MergeMotorway", + "name": "MergeMotorway", + "description": "Merge onto a motorway." + }, + { + "value": "MotorwayExitLeft", + "name": "MotorwayExitLeft", + "description": "Take the left exit." + }, + { + "value": "MotorwayExitRight", + "name": "MotorwayExitRight", + "description": "Take the right exit." + }, + { + "value": "None", + "name": "None", + "description": "No instruction." + }, + { + "value": "RampThenHighwayLeft", + "name": "RampThenHighwayLeft", + "description": "Take left ramp onto highway. This is part of a combined instruction." + }, + { + "value": "RampThenHighwayRight", + "name": "RampThenHighwayRight", + "description": "Take right ramp onto highway. This is part of a combined instruction." + }, + { + "value": "RampThenHighwayStraight", + "name": "RampThenHighwayStraight", + "description": "Stay straight to take ramp onto highway. This is part of a combined instruction." + }, + { + "value": "RoadNameChange", + "name": "RoadNameChange", + "description": "Road name changes." + }, + { + "value": "SwitchToParallelRoad", + "name": "SwitchToParallelRoad", + "description": "Switch to the parallel road." + }, + { + "value": "SwitchToMainRoad", + "name": "SwitchToMainRoad", + "description": "Switch to the main road." + }, + { + "value": "Take", + "name": "Take", + "description": "Take the road. This instruction is used when you are entering or exiting a ferry." + }, + { + "value": "TakeFerry", + "name": "TakeFerry", + "description": "Take the ferry." + }, + { + "value": "TakeExit", + "name": "TakeExit", + "description": "Take the exit." + }, + { + "value": "TakeRamp", + "name": "TakeRamp", + "description": "Take ramp." + }, + { + "value": "TakeRampLeft", + "name": "TakeRampLeft", + "description": "Take ramp to the left." + }, + { + "value": "TakeRampRight", + "name": "TakeRampRight", + "description": "Take ramp to the right." + }, + { + "value": "TakeRampStraight", + "name": "TakeRampStraight", + "description": "Stay straight to take ramp." + }, + { + "value": "TurnBack", + "name": "TurnBack", + "description": "Turn back sharply." + }, + { + "value": "TurnLeft", + "name": "TurnLeft", + "description": "Turn left." + }, + { + "value": "TurnLeftSharp", + "name": "TurnLeftSharp", + "description": "Take a sharp left turn." + }, + { + "value": "TurnLeftThenBearLeft", + "name": "TurnLeftThenBearLeft", + "description": "Turn left and then bear left." + }, + { + "value": "TurnLeftThenBearRight", + "name": "TurnLeftThenBearRight", + "description": "Turn left and then bear right." + }, + { + "value": "TurnLeftThenTurnLeft", + "name": "TurnLeftThenTurnLeft", + "description": "Turn left and then turn left again." + }, + { + "value": "TurnLeftThenTurnRight", + "name": "TurnLeftThenTurnRight", + "description": "Turn left and then turn right." + }, + { + "value": "TurnRight", + "name": "TurnRight", + "description": "Turn right." + }, + { + "value": "TurnRightSharp", + "name": "TurnRightSharp", + "description": "Take a sharp right turn." + }, + { + "value": "TurnRightThenBearLeft", + "name": "TurnRightThenBearLeft", + "description": "Turn right and then bear left." + }, + { + "value": "TurnRightThenBearRight", + "name": "TurnRightThenBearRight", + "description": "Turn right and then bear right." + }, + { + "value": "TurnRightThenTurnLeft", + "name": "TurnRightThenTurnLeft", + "description": "Turn right and then turn left." + }, + { + "value": "TurnRightThenTurnRight", + "name": "TurnRightThenTurnRight", + "description": "Turn right and then turn right again" + }, + { + "value": "TurnThenMerge", + "name": "TurnThenMerge", + "description": "Turn instruction followed by a merge instruction." + }, + { + "value": "TurnToStayLeft", + "name": "TurnToStayLeft", + "description": "Turn left to stay on the same road." + }, + { + "value": "TurnToStayRight", + "name": "TurnToStayRight", + "description": "Turn right to stay on the same road." + }, + { + "value": "Unknown", + "name": "Unknown", + "description": "The instruction is unknown." + }, + { + "value": "UTurn", + "name": "UTurn", + "description": "Make a u-turn to go in the opposite direction." + }, + { + "value": "Wait", + "name": "Wait", + "description": "Wait" + }, + { + "value": "Walk", + "name": "Walk", + "description": "Walk" + } + ] + } + }, + "RoadTypeEnum": { + "description": "The type of road. `Note`: Only supported for driving travelMode.", + "type": "string", + "enum": [ + "NotApplicable", + "LimitedAccessHighway", + "Highway", + "MajorRoad", + "Arterial", + "Street", + "Ramp", + "Ferry", + "WalkingPath" + ], + "x-ms-enum": { + "name": "RoadTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "NotApplicable", + "name": "NotApplicable", + "description": "NotApplicable." + }, + { + "value": "LimitedAccessHighway", + "name": "LimitedAccessHighway", + "description": "LimitedAccessHighway." + }, + { + "value": "Highway", + "name": "Highway", + "description": "Highway." + }, + { + "value": "MajorRoad", + "name": "MajorRoad", + "description": "MajorRoad." + }, + { + "value": "Arterial", + "name": "Arterial", + "description": "Arterial." + }, + { + "value": "Street", + "name": "Street", + "description": "Street." + }, + { + "value": "Ramp", + "name": "Ramp", + "description": "Ramp." + }, + { + "value": "Ferry", + "name": "Ferry", + "description": "Ferry." + }, + { + "value": "WalkingPath", + "name": "WalkingPath", + "description": "WalkingPath." + } + ] + } + }, + "SideOfStreetEnum": { + "description": "The side of the street where the destination is found based on the arrival direction. This field applies to the last maneuverPoint only.", + "type": "string", + "readOnly": true, + "enum": [ + "Left", + "Right", + "Unknown" + ], + "x-ms-enum": { + "name": "SideOfStreetEnum", + "modelAsString": true, + "values": [ + { + "value": "Left", + "name": "Left", + "description": "Left." + }, + { + "value": "Right", + "name": "Right", + "description": "Right." + }, + { + "value": "Unknown", + "name": "Unknown", + "description": "Unknown." + } + ] + } + }, + "TrafficDataUsedEnum": { + "description": "The type of real-time traffic data used to generate the route.", + "type": "string", + "enum": [ + "None", + "Flow", + "Closure", + "FlowAndClosure" + ], + "x-ms-enum": { + "name": "TrafficDataUsedEnum", + "modelAsString": true, + "values": [ + { + "value": "None", + "name": "None", + "description": "None." + }, + { + "value": "Flow", + "name": "Flow", + "description": "Real-time traffic speeds used to calculate travel time." + }, + { + "value": "Closure", + "name": "Closure", + "description": "Real-time closure data used, if applicable." + }, + { + "value": "FlowAndClosure", + "name": "FlowAndClosure", + "description": "Flow and Closure." + } + ] + } + }, + "TrafficCongestionEnum": { + "description": "The level of traffic congestion along the route. `Note`: Only supported for driving travelMode", + "type": "string", + "enum": [ + "Unknown", + "None", + "Mild", + "Medium", + "Heavy" + ], + "x-ms-enum": { + "name": "TrafficCongestionEnum", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "name": "Unknown", + "description": "Unknown." + }, + { + "value": "None", + "name": "None", + "description": "None." + }, + { + "value": "Mild", + "name": "Mild", + "description": "Mild." + }, + { + "value": "Medium", + "name": "Medium", + "description": "Medium." + }, + { + "value": "Heavy", + "name": "Heavy", + "description": "Heavy." + } + ] + } + }, + "Instruction": { + "description": "A description of a maneuver in a set of directions.", + "type": "object", + "properties": { + "maneuverType": { + "$ref": "#/definitions/ManeuverTypeEnum" + }, + "text": { + "description": "The plain text description of the instruction.", + "type": "string", + "readOnly": true + }, + "formattedText": { + "description": "The formatted text description of the instruction.", + "type": "string", + "readOnly": true + }, + "hints": { + "description": "Additional information that may be helpful in following a route. In addition to the hint text, this element has an attribute hintType that specifies what the hint refers to, such as “NextIntersection.” Hint is an optional element and a route step can contain more than one hint. `Note`: Only supported for driving travelMode", + "type": "array", + "items": { + "$ref": "#/definitions/Hint" + } + } + } + }, + "RouteRangeVehicleSpec": { + "type": "object", + "description": "Specifies the vehicle attributes such as vehicle height, weight, max speed, type of cargo, etc. to consider when calculating the reachable locations. This helps avoid low bridge clearances, road restrictions, difficult right turns to provide the optimized truck route based on the vehicle specifications. Vehicle attributes are specified within the vehicleSpec property.", + "allOf": [ + { + "$ref": "#/definitions/VehicleSpec" + }, + { + "$ref": "#/definitions/AxleCount" + } + ] + }, + "RouteMatrixVehicleSpec": { + "type": "object", + "description": "Specifies the vehicle attributes such as vehicle height, weight, max speed, type of cargo, etc. to consider when calculating the route matrix. This helps avoid low bridge clearances, road restrictions, difficult right turns to provide the optimized route based on the vehicle specifications. Vehicle attributes are specified within the vehicleSpec property.", + "allOf": [ + { + "$ref": "#/definitions/VehicleSpec" + } + ] + }, + "RouteDirectionVehicleSpec": { + "type": "object", + "description": "Specifies the vehicle attributes such as size, weight, max speed, type of cargo, etc. for truck routing only. This helps avoid low bridge clearances, road restrictions, difficult right turns to provide the optimized truck route based on the vehicle specifications.\n\n`Note`: Only supported for truck travelMode.", + "allOf": [ + { + "$ref": "#/definitions/VehicleSpec" + }, + { + "$ref": "#/definitions/AxleCount" + } + ] + }, + "AxleCount": { + "type": "object", + "description": "The number of axles on the vehicle.", + "properties": { + "axleCount": { + "description": "The number of axles on the vehicle.", + "format": "int64", + "type": "integer" + } + } + }, + "VehicleSpec": { + "description": "Specifies the vehicle attributes such as size, weight, max speed, type of cargo, etc. for truck routing only. This helps avoid low bridge clearances, road restrictions, difficult right turns to provide the optimized truck route based on the vehicle specifications.\n\n`Note`: Only supported for truck travelMode.", + "type": "object", + "properties": { + "isVehicleCommercial": { + "description": "Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads.", + "type": "boolean", + "default": false + }, + "length": { + "x-ms-client-name": "lengthInMeters", + "description": "Length of the vehicle in meters. A value of 0 means that length restrictions are not considered.", + "type": "number", + "format": "double", + "maximum": 1000000, + "minimum": 0, + "default": 0 + }, + "width": { + "x-ms-client-name": "widthInMeters", + "description": "Width of the vehicle in meters. A value of 0 means that width restrictions are not considered.", + "type": "number", + "format": "double", + "maximum": 1000000, + "minimum": 0, + "default": 0 + }, + "height": { + "x-ms-client-name": "heightInMeters", + "description": "Height of the vehicle in meters. A value of 0 means that height restrictions are not considered.", + "type": "number", + "format": "double", + "maximum": 1000000, + "minimum": 0, + "default": 0 + }, + "weight": { + "x-ms-client-name": "weightInKilograms", + "description": "Weight of the vehicle in kilograms. A value of 0 means that weight restrictions are not considered.", + "format": "int64", + "type": "integer", + "maximum": 1000000, + "minimum": 0, + "default": 0 + }, + "maxSpeed": { + "x-ms-client-name": "maxSpeedInKilometersPerHour", + "description": "Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.\n\nA value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.\n\nA non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.", + "format": "int64", + "type": "integer", + "maximum": 250, + "minimum": 0, + "default": 0 + }, + "axleWeight": { + "x-ms-client-name": "axleWeightInKilograms", + "description": "Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.", + "format": "int64", + "type": "integer", + "maximum": 1000000, + "minimum": 0, + "default": 0 + }, + "loadType": { + "description": "Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType supports multiple values in a request.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "USHazmatClass1", + "USHazmatClass2", + "USHazmatClass3", + "USHazmatClass4", + "USHazmatClass5", + "USHazmatClass6", + "USHazmatClass7", + "USHazmatClass8", + "USHazmatClass9", + "otherHazmatExplosive", + "otherHazmatGeneral", + "otherHazmatHarmfulToWater" + ], + "x-ms-enum": { + "name": "VehicleLoadTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "USHazmatClass1", + "description": "Explosives" + }, + { + "value": "USHazmatClass2", + "description": "Compressed gas" + }, + { + "value": "USHazmatClass3", + "description": "Flammable liquids" + }, + { + "value": "USHazmatClass4", + "description": "Flammable solids" + }, + { + "value": "USHazmatClass5", + "description": "Oxidizers" + }, + { + "value": "USHazmatClass6", + "description": "Poisons" + }, + { + "value": "USHazmatClass7", + "description": "Radioactive" + }, + { + "value": "USHazmatClass8", + "description": "Corrosives" + }, + { + "value": "USHazmatClass9", + "description": "Miscellaneous" + }, + { + "value": "otherHazmatExplosive", + "description": "Explosives" + }, + { + "value": "otherHazmatGeneral", + "description": "Miscellaneous" + }, + { + "value": "otherHazmatHarmfulToWater", + "description": "Harmful to water" + } + ] + } + } + }, + "adrTunnelRestrictionCode": { + "description": "The ADR tunnel restriction code. ADR is a European agreement concerning the international carriage of dangerous goods by road. The ADR tunnel restriction code is used to determine whether a vehicle is allowed to pass through a tunnel with restrictions on the carriage of dangerous goods.", + "type": "string", + "enum": [ + "B", + "C", + "D", + "E" + ], + "x-ms-enum": { + "name": "AdrTunnelRestrictionCodeEnum", + "modelAsString": true, + "values": [ + { + "value": "B", + "name": "B", + "description": "Vehicles with code B are restricted from roads with ADR tunnel categories B, C, D, and E." + }, + { + "value": "C", + "name": "C", + "description": "Vehicles with code C are restricted from roads with ADR tunnel categories C, D, and E" + }, + { + "value": "D", + "name": "D", + "description": "Vehicles with code D are restricted from roads with ADR tunnel categories D and E." + }, + { + "value": "E", + "name": "E", + "description": "Vehicles with code E are restricted from roads with ADR tunnel category E." + } + ] + } + } + } + }, + "AvoidEnum": { + "description": "Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode.\n\nExample: \"avoid\": [\"limitedAccessHighways\", \"tollRoads\"]", + "type": "array", + "items": { + "type": "string", + "enum": [ + "limitedAccessHighways", + "tollRoads", + "ferries", + "tunnels", + "borderCrossings", + "lowEmissionZones", + "unpavedRoads" + ], + "x-ms-enum": { + "name": "AvoidEnum", + "modelAsString": true, + "values": [ + { + "value": "limitedAccessHighways", + "description": "Avoids the use of limited access highways in the route." + }, + { + "value": "tollRoads", + "description": "Avoids the use of toll roads in the route." + }, + { + "value": "ferries", + "description": "Avoids the use of ferries in the route." + }, + { + "value": "tunnels", + "description": "Avoids the use of tunnels in the route. `Note`: Only supported for truck travelMode." + }, + { + "value": "borderCrossings", + "description": "Avoids crossing country borders in the route." + }, + { + "value": "lowEmissionZones", + "description": "Avoids low-emission zones in the route. `Note`: Only supported for truck travelMode." + }, + { + "value": "unpavedRoads", + "description": "Avoids unpaved roads in the route. `Note`: Only supported for truck travelMode." + } + ] + } + } + }, + "RouteRangeAvoidEnum": { + "description": "Specifies restrictions that the route calculation should honor when determining the reachable locations. Avoid supports multiple values in a request.\n\nExample: \"avoid\": [\"limitedAccessHighways\", \"tollRoads\"]", + "type": "array", + "items": { + "type": "string", + "enum": [ + "limitedAccessHighways", + "tollRoads", + "ferries", + "tunnels", + "borderCrossings", + "lowEmissionZones", + "unpavedRoads", + "carpools", + "carTrains" + ], + "x-ms-enum": { + "name": "RouteRangeAvoidEnum", + "modelAsString": true, + "values": [ + { + "value": "limitedAccessHighways", + "description": "Avoids the use of limited access highways in the route." + }, + { + "value": "tollRoads", + "description": "Avoids the use of toll roads in the route." + }, + { + "value": "ferries", + "description": "Avoids the use of ferries in the route." + }, + { + "value": "tunnels", + "description": "Avoids the use of tunnels in the route." + }, + { + "value": "borderCrossings", + "description": "Avoids crossing country borders in the route." + }, + { + "value": "lowEmissionZones", + "description": "Avoids low-emission zones in the route." + }, + { + "value": "unpavedRoads", + "description": "Avoids unpaved roads in the route." + }, + { + "value": "carpools", + "description": "Avoids routes that require use of carpool." + }, + { + "value": "carTrains", + "description": "Avoids car trains." + } + ] + } + } + }, + "RouteMatrixAvoidEnum": { + "description": "Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode.", + "type": "string", + "enum": [ + "tollRoads", + "unpavedRoads" + ], + "x-ms-enum": { + "name": "RouteMatrixAvoidEnum", + "modelAsString": true, + "values": [ + { + "value": "tollRoads", + "name": "TollRoads", + "description": "Avoids the use of toll roads in the route." + }, + { + "value": "unpavedRoads", + "name": "UnpavedRoads", + "description": "Avoids unpaved roads in the route." + } + ] + } + }, + "RouteMatrixTrafficEnum": { + "description": "Specifies how traffic is considered for computing routes.\n\nDefault value: `historical`", + "type": "string", + "default": "historical", + "enum": [ + "historical", + "live" + ], + "x-ms-enum": { + "name": "RouteMatrixTrafficEnum", + "modelAsString": true, + "values": [ + { + "value": "historical", + "name": "Historical", + "description": "Route calculation considers historical travel times and long term closures. Traffic jams and short-term closures during the travel time window do not influence routing or travel time." + }, + { + "value": "live", + "name": "Live", + "description": "In addition to historical travel times, route calculation considers traffic jams and short- and long-term closures during the travel time window.\n\n`Note`: `traffic=live` may not be used in conjunction with `arriveAt=any` and `departAt=any`" + } + ] + } + }, + "OptionalId": { + "type": "object", + "description": "optional Id", + "properties": { + "optionalId": { + "description": "Id of the request which would show in corresponding batchItem.", + "type": "string" + } + } + }, + "RoutePathTravelModeEnum": { + "description": "The mode of travel for the route path in the response.", + "type": "string", + "default": "driving", + "enum": [ + "driving", + "truck", + "walking", + "other" + ], + "x-ms-enum": { + "name": "RoutePathTravelModeEnum", + "modelAsString": true, + "values": [ + { + "value": "driving", + "description": "Routes optimized for cars." + }, + { + "value": "truck", + "description": "Routes optimized for large size trucks based on the vehicle specification." + }, + { + "value": "walking", + "description": "Routes optimized for pedestrians." + }, + { + "value": "other", + "description": "RouteTravelMode is returned as \"other\" for the truck travelMode when the truck route is not available for a particular section of a route." + } + ] + } + }, + "RouteMatrixTravelModeEnum": { + "description": "Specifies the travel profile to consider when calculating the matrix. If not specified, the default value is \"driving\".\n\nExample: \"travelMode\":\"driving\"", + "type": "string", + "default": "driving", + "enum": [ + "driving", + "truck", + "walking" + ], + "x-ms-enum": { + "name": "RouteMatrixTravelModeEnum", + "modelAsString": true, + "values": [ + { + "value": "driving", + "description": "Routing profile suitable for cars are used for route matrix calculation." + }, + { + "value": "truck", + "description": "Routing profile suitable for commercial vehicles like trucks are used for route matrix calculation." + }, + { + "value": "walking", + "description": "The returned routes are optimized for pedestrians, including the use of sidewalks." + } + ] + } + }, + "Order": { + "description": "Sequence for visiting waypoints and viaWaypoints.", + "type": "object", + "properties": { + "inputIndex": { + "description": "User-provided index for waypoint and viaWaypoint inputs.", + "type": "integer", + "format": "int64" + }, + "optimizedIndex": { + "description": "System-optimized waypoint and viaWaypoint index.", + "type": "integer", + "format": "int64" + } + } + }, + "InputSnapToRoadsFeaturesItem": { + "type": "object", + "description": "Specifies the input snap to roads points. `GeoJSON` feature object and additional properties. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonPoint" + }, + "properties": { + "description": "The properties object is required in a valid GeoJSON but it can be empty since the metadata is not used for snapping to road.", + "type": "object" + } + }, + "required": [ + "type", + "geometry", + "properties" + ] + }, + "SnapToRoadFeaturesItem": { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "allOf": [ + { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonPoint" + }, + "bbox": { + "$ref": "#/definitions/Bbox" + }, + "properties": { + "$ref": "#/definitions/SnapToRoadsFeatureProperties" + } + } + } + ] + }, + "SnapToRoadsFeatureProperties": { + "description": "Snap to Roads properties.", + "type": "object", + "properties": { + "inputIndex": { + "description": "Identify the corresponding index in the original list of points for each snapped point. Only the snapped points will return indices and can be used to distinguish them from the interpolated points.", + "format": "int64", + "type": "integer" + }, + "isInterpolated": { + "description": "Identify whether this is the interpolated point.", + "type": "boolean" + }, + "name": { + "description": "Name of the road the point is snapped to.", + "type": "string" + }, + "speedLimitInKilometersPerHour": { + "description": "Speed limit in kilometers per hour.", + "type": "number", + "format": "double" + } + } + }, + "InputRouteRangeProperties": { + "type": "object", + "description": "Specifies the parameters to use for the calculation of isochrone polygon.", + "properties": { + "departAt": { + "description": "The date and time of departure from the origin point formatted as a dateTime value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed.\n\nThe `departAt` value must be in the future in the date-time format. If not set, the default value is the current time.\n\nExample:\n\n\"departAt\": \"2023-06-01T09:30:00.000-07:00\"", + "type": "string", + "format": "date-time" + }, + "isSimplifiedPolygon": { + "description": "Use this to specify if you need simplified polygons that reduces the number of polygon vertices while preserving the shape. The API returns high definition polygon by default.", + "type": "boolean", + "default": "false" + }, + "optimizeRoute": { + "description": "Specifies the parameter to use to optimize the route. If not defined, the default is \"fastestWithoutTraffic\" which returns the route to minimize the travel time without using current traffic information.\n\nExample: \"optimizeRoute\":\"shortest\"", + "type": "string", + "default": "fastestWithoutTraffic", + "enum": [ + "shortest", + "fastestWithoutTraffic", + "fastestWithTraffic" + ], + "x-ms-enum": { + "name": "RouteRangeOptimizeRouteEnum", + "modelAsString": true, + "values": [ + { + "value": "shortest", + "name": "Shortest", + "description": "The route is calculated to minimize the distance. Traffic information is not used." + }, + { + "value": "fastestWithoutTraffic", + "name": "FastestWithoutTraffic", + "description": "Finds the fastest route, without factoring in traffic information." + }, + { + "value": "fastestWithTraffic", + "name": "FastestWithTraffic", + "description": "The route is calculated to minimize the time using current traffic information. `Note`: Only supported for driving and truck travelMode." + } + ] + } + }, + "avoid": { + "$ref": "#/definitions/RouteRangeAvoidEnum" + }, + "vehicleSpec": { + "$ref": "#/definitions/RouteRangeVehicleSpec" + }, + "distanceBudgetInMeters ": { + "description": "The distance budget specifies the maximum range in meters which can be travelled from the origin waypoint. It cannot be set when `timeBudgetInSec` is specified.\n\nWhen `isSimplifiedPolygon` is false, the maximum distance supported is 360,000 meters; otherwise, it is 50,000,000 meters.\n\nExample: \"distanceBudgetInMeters\":5000", + "type": "number", + "minimum": 0, + "maximum": 50000000 + }, + "timeBudgetInSec": { + "description": "The time budget specifies the maximum time in seconds available for travel, defining how far one can go within this time constraint from the origin waypoint. It cannot be set when `distanceBudgetInMeters` is specified.\n\nWhen `isSimplifiedPolygon` is false, the maximum time supported is 14,400 seconds; otherwise, it is 10,000,000 seconds.\n\nExample: \"timeBudgetInSec\":3600", + "type": "number", + "minimum": 0, + "maximum": 10000000 + }, + "travelMode": { + "description": "Specifies the travel profile to consider when calculating the range polygon. If not specified, the default value is \"driving\".\n\nExample: \"travelMode\":\"driving\"", + "type": "string", + "default": "driving", + "enum": [ + "driving", + "truck" + ], + "x-ms-enum": { + "name": "RouteRangeTravelModeEnum", + "modelAsString": true, + "values": [ + { + "value": "driving", + "description": "Routing profile suitable for cars are used for range polygon calculation." + }, + { + "value": "truck", + "description": "Routing profile suitable for commercial vehicles like trucks are used for range polygon calculation." + } + ] + } + } + } + }, + "InputRouteRangeFeaturesItem": { + "type": "object", + "description": "Specifies the starting point for range calculation. `GeoJSON` feature object and additional properties. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonPoint" + }, + "properties": { + "type": "object", + "description": "Route Ranges properties." + } + }, + "required": [ + "type", + "geometry", + "properties" + ] + }, + "RouteRangeFeaturesItem": { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "allOf": [ + { + "type": "object", + "description": "GeoJSON feature object that contains Geometry object and additional properties of the route.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "#/definitions/RouteRangeGeometry" + }, + "bbox": { + "$ref": "#/definitions/Bbox" + }, + "properties": { + "$ref": "#/definitions/RouteRangeFeatureProperties" + } + } + } + ] + }, + "RouteRangeFeatureProperties": { + "description": "Route Ranges properties.", + "type": "object", + "properties": { + "type": { + "description": "The feature types for the feature objects returned in the response.", + "type": "string", + "enum": [ + "center", + "boundary" + ], + "x-ms-enum": { + "name": "RouteRangeTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "center", + "description": "The center point feature type represents the point used for the range polygon calculation." + }, + { + "value": "boundary", + "description": "The boundary feature type represents the range polygon." + } + ] + } + } + } + }, + "InputRouteMatrixFeaturesItem": { + "type": "object", + "description": "Specifies the input origin and destination points and additional properties for the `GeoJSON` MultiPoint feature object. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.", + "properties": { + "type": { + "$ref": "#/definitions/FeaturesItemTypeEnum" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonMultiPoint" + }, + "properties": { + "description": "MultiPoint feature properties object which specifies the origin features and destination features for the input matrix.", + "type": "object", + "$ref": "#/definitions/InputRouteMatrixProperties" + } + }, + "required": [ + "type", + "geometry", + "properties" + ] + }, + "InputRouteMatrixProperties": { + "type": "object", + "description": "Specifies the properties object for the input matrix.", + "properties": { + "pointType": { + "description": "Specifies the origin MultiPoint type and destination MultiPoint type for the input matrix.", + "type": "string", + "enum": [ + "origins", + "destinations" + ], + "x-ms-enum": { + "name": "RouteMatrixTypeEnum", + "modelAsString": true, + "values": [ + { + "value": "origins", + "description": "MultiPoint features that define the origin locations in the input matrix." + }, + { + "value": "destinations", + "description": "MultiPoint features that define the destination locations in the input matrix." + } + ] + } + } + } + }, + "RouteMatrixFeatureProperties": { + "description": "Route Matrix properties.", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/RouteMatrixSummary" + }, + "matrix": { + "description": "The matrix of route results.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteMatrixItemResult" + } + } + } + }, + "RouteMatrixItemResult": { + "type": "object", + "description": "Route Matrix item result", + "properties": { + "statusCode": { + "description": "The HTTP status code of the current cell.", + "type": "integer", + "format": "int32" + }, + "originIndex": { + "description": "Index of the origin point", + "type": "integer", + "format": "int32" + }, + "destinationIndex": { + "description": "Index of the destination point", + "type": "integer", + "format": "int32" + }, + "departureTime": { + "description": "The estimated departure time, which takes into account the traffic conditions, is formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used. If departAt or arriveAt is `any`, then departureTime is absent.", + "format": "date-time", + "readOnly": true + }, + "arrivalTime": { + "description": "The estimated arrival time, which takes into account the traffic conditions, is formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used. If departAt or arriveAt is any, then departureTime is absent.", + "format": "date-time", + "readOnly": true + }, + "distanceInMeters": { + "description": "Length In Meters property", + "type": "number", + "readOnly": true + }, + "durationInSeconds": { + "description": "Estimated travel time in seconds that does not include delays on the route due to traffic conditions.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "durationTrafficInSeconds": { + "description": "The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations.", + "format": "int64", + "type": "integer", + "readOnly": true + }, + "error": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" + } + } + }, + "RouteOperation": { + "type": "object", + "description": "This object is returned from a successful Get Operation request.", + "properties": { + "id": { + "description": "Unique identifier for the asynchronous operation.", + "type": "string" + }, + "status": { + "type": "string", + "description": "Current status of the async operation.", + "enum": [ + "NotStarted", + "Running", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "StatusEnum", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "The operation has not started yet." + }, + { + "value": "Running", + "description": "The operation is running." + }, + { + "value": "Completed", + "description": "The operation has completed successfully." + }, + { + "value": "Failed", + "description": "The operation has failed." + } + ] + } + }, + "kind": { + "$ref": "#/definitions/RouteOperationKindEnum" + }, + "result": { + "description": "The result of async operation", + "type": "object", + "properties": { + "resultUrl": { + "description": "URL to the get the result of async operation", + "type": "string", + "format": "uri" + } + } + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the operation was created." + }, + "lastActionDateTime": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the operation status was updated." + }, + "error": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" + } + } + }, + "RouteOperationKindEnum": { + "type": "string", + "description": "Type of asynchronous operation", + "enum": [ + "RouteMatrix" + ], + "x-ms-enum": { + "name": "RouteOperationKindEnum", + "modelAsString": true, + "values": [ + { + "value": "RouteMatrix", + "description": "Route matrix asynchronous job." + } + ] + } + }, + "RouteMatrixSummary": { + "type": "object", + "description": "Summary for the route matrix request", + "properties": { + "successfulCount": { + "description": "Number of successful routes within this matrix.", + "type": "integer", + "format": "int32" + }, + "totalCount": { + "description": "Total number of routes within this matrix.", + "type": "integer", + "format": "int32" + } + } + }, + "DirectionsBatchRequestItem": { + "description": "Batch Query object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OptionalId" + }, + { + "$ref": "#/definitions/DirectionsRequest" + } + ] + }, + "DirectionsBatchRequestBody": { + "description": "The list of directions queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query.", + "type": "object", + "properties": { + "batchItems": { + "description": "The list of queries to process.", + "type": "array", + "items": { + "$ref": "#/definitions/DirectionsBatchRequestItem" + } + } + } + }, + "DirectionsBatchResponseItem": { + "description": "Batch response item", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OptionalId" + }, + { + "$ref": "#/definitions/RouteDirectionsResponse" + }, + { + "type": "object", + "description": "error details", + "properties": { + "error": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" + } + } + } + ] + }, + "DirectionsBatchResponse": { + "description": "This object is returned from a successful Directions Batch service call.", + "type": "object", + "properties": { + "summary": { + "description": "Summary for the batch request", + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "successfulRequests": { + "description": "Number of successful requests in the batch", + "type": "integer", + "format": "int32" + }, + "totalRequests": { + "description": "Total number of requests in the batch", + "type": "integer", + "format": "int32" + } + } + }, + "batchItems": { + "description": "Array containing the batch results.", + "type": "array", + "items": { + "$ref": "#/definitions/DirectionsBatchResponseItem" + } + } + } + }, + "SnapToRoadsBatchRequestBody": { + "description": "The list of snap to roads queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query.", + "type": "object", + "properties": { + "batchItems": { + "description": "The list of queries to process.", + "type": "array", + "items": { + "$ref": "#/definitions/SnapToRoadsBatchRequestItem" + } + } + } + }, + "SnapToRoadsBatchRequestItem": { + "description": "Batch Query object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OptionalId" + }, + { + "$ref": "#/definitions/SnapToRoadsRequest" + } + ] + }, + "SnapToRoadsBatchResponseItem": { + "description": "Batch response item", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OptionalId" + }, + { + "$ref": "#/definitions/SnapToRoadsResponse" + }, + { + "type": "object", + "description": "error details", + "properties": { + "error": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" + } + } + } + ] + }, + "SnapToRoadsBatchResponse": { + "description": "This object is returned from a successful Snap To Roads Batch service call.", + "type": "object", + "properties": { + "summary": { + "description": "Summary for the batch request", + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "successfulRequests": { + "description": "Number of successful requests in the batch", + "type": "integer", + "format": "int32" + }, + "totalRequests": { + "description": "Total number of requests in the batch", + "type": "integer", + "format": "int32" + } + } + }, + "batchItems": { + "description": "Array containing the batch results.", + "type": "array", + "items": { + "$ref": "#/definitions/SnapToRoadsBatchResponseItem" + } + } + } + }, + "RouteRangeBatchRequestBody": { + "description": "The list of route range queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query.", + "type": "object", + "properties": { + "batchItems": { + "description": "The list of queries to process.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteRangeBatchRequestItem" + } + } + } + }, + "RouteRangeBatchRequestItem": { + "description": "Batch Query object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OptionalId" + }, + { + "$ref": "#/definitions/RouteRangeRequest" + } + ] + }, + "RouteRangeBatchResponse": { + "description": "This object is returned from a successful Route Range Batch service call.", + "type": "object", + "properties": { + "summary": { + "description": "Summary for the batch request", + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "successfulRequests": { + "description": "Number of successful requests in the batch", + "type": "integer", + "format": "int32" + }, + "totalRequests": { + "description": "Total number of requests in the batch", + "type": "integer", + "format": "int32" + } + } + }, + "batchItems": { + "description": "Array containing the batch results.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteRangeBatchResponseItem" + } + } + } + }, + "RouteRangeBatchResponseItem": { + "description": "Batch response item", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OptionalId" + }, + { + "$ref": "#/definitions/RouteRangeResponse" + }, + { + "type": "object", + "description": "error details", + "properties": { + "error": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" + } + } + } + ] + } + } +} diff --git a/specification/maps/data-plane/Route/readme.md b/specification/maps/data-plane/Route/readme.md index b04054c72ab5..7ce7126a8d8c 100644 --- a/specification/maps/data-plane/Route/readme.md +++ b/specification/maps/data-plane/Route/readme.md @@ -27,7 +27,7 @@ These are the global settings for Route Client. ``` yaml title: RouteClient openapi-type: data-plane -tag: package-preview-2024-06 +tag: package-preview-2024-07 add-credentials: true credential-default-policy-type: BearerTokenCredentialPolicy credential-scopes: 'https://atlas.microsoft.com/.default' @@ -39,6 +39,19 @@ modelerfour: lenient-model-deduplication: true ``` +### Tag: package-preview-2024-7 + +These settings apply only when `--tag=package-preview-2024-07` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-07' +input-file: + - preview/2024-07-01-preview/route.json + +suppressions: + - code: OperationIdNounVerb + reason: False alarm. Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. +``` + ### Tag: package-preview-2024-6 These settings apply only when `--tag=package-preview-2024-06` is specified on the command line. @@ -51,6 +64,7 @@ suppressions: - code: OperationIdNounVerb reason: False alarm. Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. ``` + ### Tag: package-preview-2024-5 These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. @@ -62,8 +76,8 @@ input-file: suppressions: - code: OperationIdNounVerb reason: False alarm. Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. - ``` + ### Tag: package-preview-2024-04 These settings apply only when `--tag=package-preview-2024-04` is specified on the command line. diff --git a/specification/maps/suppressions.yaml b/specification/maps/suppressions.yaml index cdffaf7392fd..b24910983fb9 100644 --- a/specification/maps/suppressions.yaml +++ b/specification/maps/suppressions.yaml @@ -4,3 +4,6 @@ - tool: TypeSpecRequirement path: ./data-plane/Timezone/preview/1.0/timezone.json reason: Brownfield service not ready to migrate +- tool: TypeSpecRequirement + path: ./data-plane/Route/preview/2024-07-01-preview/route.json + reason: Brownfield service not ready to migrate diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.go.md b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.go.md new file mode 100644 index 000000000000..83879bda9ca6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.go.md @@ -0,0 +1,29 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) && !$(track2) +go: + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true + namespace: migrationassessment +``` + +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/migrationassessment/armmigrationassessment +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +modelerfour: + lenient-model-deduplication: true +``` + +### Tag: package-2018-02 and go + +These settings apply only when `--tag=package-2018-02 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-02' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-02-02/$(namespace) +``` diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.java.md b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.java.md new file mode 100644 index 000000000000..9a97699f53a5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.java.md @@ -0,0 +1,9 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +uuid-as-string: true +service-name: Migration Assessment +``` \ No newline at end of file diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.md b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.md new file mode 100644 index 000000000000..16d24c1f5645 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.md @@ -0,0 +1,151 @@ +# Azure Migrate + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Migrate - Assessment. + +--- + +## Getting Started + +To build the SDK for Migrate, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the API. + +``` yaml +openapi-type: arm +tag: package-preview-2023-09 +``` + +### Tag: package-preview-2023-09 + +These settings apply only when `--tag=package-preview-2023-09` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-09' +input-file: + - preview/2023-09-09-preview/migrate.json +suppressions: + - code: AvoidAdditionalProperties + reason: Migrate feature is widely adopted and requires additionalProperties for these swagger properties. + - code: ProvisioningStateMustBeReadOnly + reason: The current swagger version only modifies the resources which do not have Provisioning states as readOnly and not introducing any new Resources, These are incorrectly flagged for previous versions. + - code: UnSupportedPatchProperties + reason: There is no patch operation that is introduced in this swagger version where it is not readOnly. This is incorrectly flagged for previous versions. +``` + +### Tag: package-preview-2023-05 + +These settings apply only when `--tag=package-preview-2023-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-05' +input-file: + - preview/2023-05-01-preview/migrate.json +suppressions: + - code: AvoidAdditionalProperties + reason: Migrate feature is widely adopted and requires additionalProperties for these swagger properties. + - code: ProvisioningStateMustBeReadOnly + reason: The current swagger version only modifies the resources which do not have Provisioning states as readOnly and not introducing any new Resources, These are incorrectly flagged for previous versions. + - code: UnSupportedPatchProperties + reason: There is no patch operation that is introduced in this swagger version where it is not readOnly. This is incorrectly flagged for previous versions. +``` + +### Tag: package-preview-2023-04 + +These settings apply only when `--tag=package-preview-2023-04` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-04' +input-file: + - preview/2023-04-01-preview/migrate.json +``` + +### Tag: package-2023-03 + +These settings apply only when `--tag=package-2023-03` is specified on the command line. + +```yaml $(tag) == 'package-2023-03' +input-file: + - stable/2023-03-15/migrate.json +``` + +### Tag: package-2019-10 + +These settings apply only when `--tag=package-2019-10` is specified on the command line. + +``` yaml $(tag) == 'package-2019-10' +input-file: +- stable/2019-10-01/migrate.json +``` + +### Tag: package-2018-02 + +These settings apply only when `--tag=package-2018-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02' +input-file: +- stable/2018-02-02/migrate.json +``` + +### Tag: package-preview-2017-11 + +These settings apply only when `--tag=package-preview-2017-11` is specified on the command line. + +``` yaml $(tag) == 'package-preview-2017-11' +input-file: +- preview/2017-11-11-preview/migrate.json +``` + +## Suppression + +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: migrate.json + where: $.definitions.AssessedMachineProperties.properties.monthlyStandardSSDStorageCost + reason: SSD is short form. + - suppress: DefinitionsPropertiesNamesCamelCase + from: migrate.json + where: $.definitions.AssessmentProperties.properties.monthlyStandardSSDStorageCost + reason: SSD is short form. +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-go + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-resource-manager-schemas + - repo: azure-powershell +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.python.md b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.python.md new file mode 100644 index 000000000000..2cfaef8f5ea5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.python.md @@ -0,0 +1,24 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-migrationassessment +namespace: azure.mgmt.migrationassessment +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/migrate/azure-mgmt-migrationassessment/azure/mgmt/migrationassessment +``` + +``` yaml $(python) +modelerfour: + flatten-models: false + lenient-model-deduplication: true +``` diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.typescript.md b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.typescript.md new file mode 100644 index 000000000000..b9a1d0b0772d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-migrationassessment" + output-folder: "$(typescript-sdks-folder)/sdk/migrate/arm-migrationassessment" + generate-metadata: true +``` diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.go.md b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.go.md new file mode 100644 index 000000000000..68c08e532c1d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.go.md @@ -0,0 +1,27 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) && !$(track2) +go: + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true + namespace: migrationhub +``` + +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/migrationhub/armmigrationhub +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` + +### Tag: package-2020-05 and go + +These settings apply only when `--tag=package-2020-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2020-05' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-05-01/$(namespace) +``` diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.java.md b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.java.md new file mode 100644 index 000000000000..b38ca4117f9b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.java.md @@ -0,0 +1,9 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +uuid-as-string: true +service-name: Migration Hub +``` \ No newline at end of file diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.md b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.md new file mode 100644 index 000000000000..be471c5b8b5d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.md @@ -0,0 +1,78 @@ +# Azure Migrate + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Migrate - Migration. + +--- + +## Getting Started + +To build the SDK for Migrate, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the API. + +``` yaml +openapi-type: arm +tag: package-2023-01 +``` + +### Tag: package-2020-05 + +These settings apply only when `--tag=package-2020-05` is specified on the command line. + +``` yaml $(tag) == 'package-2020-05' +input-file: +- stable/2020-05-01/hubmigrate.json +``` + +### Tag: package-2023-01 + +These settings apply only when `--tag=package-2023-01` is specified on the command line. + +``` yaml $(tag) == 'package-2023-01' +input-file: +- stable/2023-01-01/hubmigrate.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-go + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-resource-manager-schemas + - repo: azure-powershell +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.python.md b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.python.md new file mode 100644 index 000000000000..1cc196fbe253 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-migrationhub +namespace: azure.mgmt.migrationhub +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/migrate/azure-mgmt-migrationhub/azure/mgmt/migrationhub +``` + +``` yaml $(python) +modelerfour: + flatten-models: false +``` diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.typescript.md b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.typescript.md new file mode 100644 index 000000000000..3c638fd3ed14 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-migrationhub" + output-folder: "$(typescript-sdks-folder)/sdk/migrate/arm-migrationhub" + generate-metadata: true +``` diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.go.md b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.go.md new file mode 100644 index 000000000000..971dd3371751 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.go.md @@ -0,0 +1,18 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) && !$(track2) +go: + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true + namespace: migrationmodernization +``` + +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/migrationmodernization/armmigrationmodernization +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` \ No newline at end of file diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.java.md b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.java.md new file mode 100644 index 000000000000..250f631a662e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.java.md @@ -0,0 +1,9 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +uuid-as-string: true +service-name: Migration Modernization +``` \ No newline at end of file diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.md b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.md new file mode 100644 index 000000000000..1394588f35e9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.md @@ -0,0 +1,69 @@ +# Azure Migrate + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Migrate. + +--- + +## Getting Started + +To build the SDK for Migrate, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the API. + +``` yaml +openapi-type: arm +tag: package-2022-05 +``` + +### Tag: package-2022-05 + +These settings apply only when `--tag=package-2022-05` is specified on the command line. + +``` yaml $(tag) == 'package-2022-05' +input-file: +- preview/2022-05-01-preview/migrateEngine.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-go + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-resource-manager-schemas + - repo: azure-powershell +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.python.md b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.python.md new file mode 100644 index 000000000000..885105695de4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-migrationmodernization +namespace: azure.mgmt.migrationmodernization +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/migrate/azure-mgmt-migrationmodernization/azure/mgmt/migrationmodernization +``` + +``` yaml $(python) +modelerfour: + flatten-models: false +``` diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.typescript.md b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.typescript.md new file mode 100644 index 000000000000..fb441dff46e5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-migrationmodernization" + output-folder: "$(typescript-sdks-folder)/sdk/migrate/arm-migrationmodernization" + generate-metadata: true +``` diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/readme.go.md b/specification/migrate/resource-manager/Microsoft.OffAzure/readme.go.md new file mode 100644 index 000000000000..27925a9af858 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/readme.go.md @@ -0,0 +1,27 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && !$(track2) +go: + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true + namespace: migrationdiscovery +``` + +```yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/migrationdiscovery/armmigrationdiscovery +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` + +### Tag: package-2020-01 and go + +These settings apply only when `--tag=package-2020-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag)=='package-2020-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-01-01/$(namespace) +``` diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/readme.java.md b/specification/migrate/resource-manager/Microsoft.OffAzure/readme.java.md new file mode 100644 index 000000000000..d71266579e31 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/readme.java.md @@ -0,0 +1,9 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +uuid-as-string: true +service-name: Migration Discovery +``` \ No newline at end of file diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/readme.md b/specification/migrate/resource-manager/Microsoft.OffAzure/readme.md new file mode 100644 index 000000000000..1f3db0d4ab34 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/readme.md @@ -0,0 +1,96 @@ +# Azure Migrate + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Microsoft.OffAzure in Azure Migrate. + +--- + +## Getting Started + +To build the SDK for Microsoft.OffAzure, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the API. + +``` yaml +openapi-type: arm +tag: package-preview-2023-10 +``` + +### Tag: package-preview-2023-10 + +These settings apply only when `--tag=package-preview-2023-10` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-10' +input-file: + - preview/2023-10-01-preview/migrate.json +``` + +### Tag: package-2023-06 + +These settings apply only when `--tag=package-2023-06` is specified on the command line. + +```yaml $(tag) == 'package-2023-06' +input-file: + - stable/2023-06-06/migrate.json +``` + +### Tag: package-2020-01 + +These settings apply only when `--tag=package-2020-01` is specified on the command line. + +``` yaml $(tag) == 'package-2020-01' +input-file: +- stable/2020-01-01/migrate.json +``` + +### Tag: package-2020-07 + +These settings apply only when `--tag=package-2020-07` is specified on the command line. + +``` yaml $(tag) == 'package-2020-07' +input-file: +- stable/2020-07-07/migrate.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-go + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-resource-manager-schemas + - repo: azure-powershell +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) \ No newline at end of file diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/readme.python.md b/specification/migrate/resource-manager/Microsoft.OffAzure/readme.python.md new file mode 100644 index 000000000000..354d5239b2ff --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-migrationdiscovery +namespace: azure.mgmt.migrationdiscovery +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/migrate/azure-mgmt-migrationdiscovery/azure/mgmt/migrationdiscovery +``` + +``` yaml $(python) +modelerfour: + flatten-models: false +``` diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/readme.typescript.md b/specification/migrate/resource-manager/Microsoft.OffAzure/readme.typescript.md new file mode 100644 index 000000000000..e23ce4ff5ab0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-migrationdiscovery" + output-folder: "$(typescript-sdks-folder)/sdk/migrate/arm-migrationdiscovery" + generate-metadata: true +``` diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/AdvancedThreatProtectionSettings.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/AdvancedThreatProtectionSettings.json new file mode 100644 index 000000000000..335c5d1601c6 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/AdvancedThreatProtectionSettings.json @@ -0,0 +1,404 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-10-01-preview", + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}": { + "get": { + "tags": [ + "AdvancedThreatProtectionSettings" + ], + "description": "Get a server's Advanced Threat Protection state", + "operationId": "AdvancedThreatProtectionSettings_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/AdvancedThreatProtectionNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server's Advanced Threat Protection state.", + "schema": { + "$ref": "#/definitions/AdvancedThreatProtection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a server's Advanced Threat Protection settings.": { + "$ref": "./examples/AdvancedThreatProtectionSettingsGet.json" + } + } + }, + "patch": { + "tags": [ + "AdvancedThreatProtectionSettings" + ], + "description": "Updates a server's Advanced Threat Protection state.", + "operationId": "AdvancedThreatProtectionSettings_Update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/AdvancedThreatProtectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The server's Advanced Threat Protection body to update.", + "required": true, + "schema": { + "$ref": "#/definitions/AdvancedThreatProtectionForUpdate" + } + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the server's Advanced Threat Protection state.", + "schema": { + "$ref": "#/definitions/AdvancedThreatProtection" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to retrieve the final result after operation completes.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Enable a server's Advanced Threat Protection settings": { + "$ref": "./examples/AdvancedThreatProtectionSettingsPatchEnabled.json" + }, + "Disable a server's Advanced Threat Protection settings with all parameters": { + "$ref": "./examples/AdvancedThreatProtectionSettingsPatchDisabled.json" + } + } + }, + "put": { + "tags": [ + "AdvancedThreatProtectionSettings" + ], + "description": "Updates a server's Advanced Threat Protection state.", + "operationId": "AdvancedThreatProtectionSettings_UpdatePut", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/AdvancedThreatProtectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The server's Advanced Threat Protection body to update.", + "required": true, + "schema": { + "$ref": "#/definitions/AdvancedThreatProtection" + } + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the server's Advanced Threat Protection state.", + "schema": { + "$ref": "#/definitions/AdvancedThreatProtection" + } + }, + "201": { + "description": "Successfully created the server's Advanced Threat Protection settings.", + "schema": { + "$ref": "#/definitions/AdvancedThreatProtection" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to retrieve the final result after operation completes.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Enable a server's Advanced Threat Protection settings using PUT": { + "$ref": "./examples/AdvancedThreatProtectionSettingsPutEnabled.json" + }, + "Disable a server's Advanced Threat Protection settings with all parameters using PUT": { + "$ref": "./examples/AdvancedThreatProtectionSettingsPutDisabled.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/advancedThreatProtectionSettings": { + "get": { + "tags": [ + "AdvancedThreatProtectionSettings" + ], + "description": "Gets a list of server's Advanced Threat Protection states.", + "operationId": "AdvancedThreatProtectionSettings_List", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server's Advanced Threat Protection states.", + "schema": { + "$ref": "#/definitions/AdvancedThreatProtectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get list of server's Advanced Threat Protection settings": { + "$ref": "./examples/AdvancedThreatProtectionSettingsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AdvancedThreatProtectionState": { + "description": "Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled on the server.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AdvancedThreatProtectionState", + "modelAsString": true + } + }, + "AdvancedThreatProtectionProperties": { + "description": "Properties of an Advanced Threat Protection setting.", + "type": "object", + "properties": { + "creationTime": { + "description": "Specifies the UTC creation time of the policy.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "state": { + "description": "Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server.", + "$ref": "#/definitions/AdvancedThreatProtectionState" + }, + "provisioningState": { + "$ref": "#/definitions/AdvancedThreatProtectionProvisioningState", + "description": "Provisioning state of the Threat Protection." + } + } + }, + "AdvancedThreatProtection": { + "description": "A server's Advanced Threat Protection.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AdvancedThreatProtectionProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "AdvancedThreatProtectionUpdateProperties": { + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server.", + "$ref": "#/definitions/AdvancedThreatProtectionState" + } + }, + "required": [ + "state" + ], + "description": "Properties of Advanced Threat Protection that can be updated." + }, + "AdvancedThreatProtectionForUpdate": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AdvancedThreatProtectionUpdateProperties", + "description": "Resource update properties.", + "x-ms-client-flatten": true + } + }, + "description": "Parameters allowed to update advanced threat protection for a server." + }, + "AdvancedThreatProtectionListResult": { + "description": "A list of the server's Advanced Threat Protection configurations.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/AdvancedThreatProtection" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "AdvancedThreatProtectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Updating", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "AdvancedThreatProtectionProvisioningState", + "modelAsString": true + } + } + }, + "parameters": { + "AdvancedThreatProtectionNameParameter": { + "name": "advancedThreatProtectionName", + "in": "path", + "description": "The name of the Advanced Threat Protection state.", + "required": true, + "enum": [ + "Default" + ], + "type": "string", + "x-ms-enum": { + "name": "AdvancedThreatProtectionName", + "modelAsString": true + }, + "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/FlexibleServers.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/FlexibleServers.json new file mode 100644 index 000000000000..cffc6d7887a4 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/FlexibleServers.json @@ -0,0 +1,1569 @@ +{ + "swagger": "2.0", + "info": { + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations.", + "version": "2024-10-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}": { + "put": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Create", + "x-ms-examples": { + "Create a new server": { + "$ref": "./examples/ServerCreate.json" + }, + "Create a server as a point in time restore": { + "$ref": "./examples/ServerCreateWithPointInTimeRestore.json" + }, + "Create a replica server": { + "$ref": "./examples/ServerCreateReplica.json" + }, + "Create a server with byok": { + "$ref": "./examples/ServerCreateWithBYOK.json" + }, + "Create a server with non-default database port": { + "$ref": "./examples/ServerCreateWithDatabasePort.json" + } + }, + "description": "Creates a new server or updates an existing server. The update action will overwrite the existing server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Server" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Update", + "x-ms-examples": { + "Update a server": { + "$ref": "./examples/ServerUpdate.json" + }, + "Update server customer maintenance window": { + "$ref": "./examples/ServerUpdateWithCustomerMaintenanceWindow.json" + }, + "Update server to opt in virtual canary": { + "$ref": "./examples/MaintenancePolicyPatchOptInVirtualCanary.json" + }, + "Update server to opt out virtual canary": { + "$ref": "./examples/MaintenancePolicyPatchOptOutVirtualCanary.json" + }, + "Update server with byok": { + "$ref": "./examples/ServerUpdateWithBYOK.json" + } + }, + "description": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerForUpdate" + }, + "description": "The required parameters for updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Delete", + "x-ms-examples": { + "Delete a server": { + "$ref": "./examples/ServerDelete.json" + } + }, + "description": "Deletes a server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Get", + "x-ms-examples": { + "Get a server": { + "$ref": "./examples/ServerGet.json" + }, + "Get a server with vnet": { + "$ref": "./examples/ServerGetWithVnet.json" + } + }, + "description": "Gets information about a server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_ListByResourceGroup", + "x-ms-examples": { + "List servers in a resource group": { + "$ref": "./examples/ServersListByResourceGroup.json" + } + }, + "description": "List all the servers in a given resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_List", + "x-ms-examples": { + "List servers in a subscription": { + "$ref": "./examples/ServersList.json" + } + }, + "description": "List all the servers in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/failover": { + "post": { + "tags": [ + "ServerFailover" + ], + "operationId": "Servers_Failover", + "x-ms-examples": { + "Restart a server": { + "$ref": "./examples/ServerFailover.json" + } + }, + "description": "Manual failover a server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/validateEstimateHighAvailability": { + "post": { + "tags": [ + "ServerValidateEstimateHighAvailability" + ], + "operationId": "Servers_ValidateEstimateHighAvailability", + "x-ms-examples": { + "Validate a validation and estimation of high availability.": { + "$ref": "./examples/ServerValidateEstimateHighAvailability.json" + } + }, + "description": "Validate a deployment of high availability.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HighAvailabilityValidationEstimation" + }, + "description": "The required parameters for validation of high availability deployment." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HighAvailabilityValidationEstimation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/restart": { + "post": { + "tags": [ + "ServerRestart" + ], + "operationId": "Servers_Restart", + "x-ms-examples": { + "Restart a server": { + "$ref": "./examples/ServerRestart.json" + } + }, + "description": "Restarts a server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerRestartParameter" + }, + "description": "The required parameters for restarting a server." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/start": { + "post": { + "tags": [ + "ServerStart" + ], + "operationId": "Servers_Start", + "x-ms-examples": { + "Start a server": { + "$ref": "./examples/ServerStart.json" + } + }, + "description": "Starts a server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/stop": { + "post": { + "tags": [ + "ServerStop" + ], + "operationId": "Servers_Stop", + "x-ms-examples": { + "Stop a server": { + "$ref": "./examples/ServerStop.json" + } + }, + "description": "Stops a server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/resetGtid": { + "post": { + "tags": [ + "ServerResetGtid" + ], + "operationId": "Servers_ResetGtid", + "x-ms-examples": { + "Reset GTID on a server": { + "$ref": "./examples/ServerResetGtid.json" + } + }, + "description": "Resets GTID on a server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerGtidSetParameter" + }, + "description": "The required parameters for resetting GTID on a server." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/detachVNet": { + "post": { + "tags": [ + "ServerDetachVNet" + ], + "operationId": "Servers_DetachVNet", + "x-ms-examples": { + "Detach VNet on a server": { + "$ref": "./examples/ServerDetachVNet.json" + } + }, + "description": "Detach VNet on a server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerDetachVNetParameter" + }, + "description": "The required parameters for detach vnet on a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/replicas": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Replicas_ListByServer", + "x-ms-examples": { + "List replicas for a server": { + "$ref": "./examples/ReplicasListByServer.json" + } + }, + "description": "List all the replicas for a given server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/cutoverMigration": { + "post": { + "tags": [ + "ServerMigration" + ], + "operationId": "ServersMigration_CutoverMigration", + "x-ms-examples": { + "Cutover migration for MySQL import": { + "$ref": "./examples/CutoverMigration.json" + } + }, + "description": "Cutover migration for MySQL import, it will switch source elastic server DNS to flexible server.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to retrieve the final result after operation completes.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "ServerVersion": { + "type": "string", + "description": "The major version of a server. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7", + "enum": [ + "5.7", + "8.0.21" + ], + "x-ms-enum": { + "name": "ServerVersion", + "modelAsString": true + } + }, + "EnableStatusEnum": { + "type": "string", + "description": "Enum to indicate whether value is 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnableStatusEnum", + "modelAsString": true + } + }, + "ReplicationRole": { + "type": "string", + "enum": [ + "None", + "Source", + "Replica" + ], + "x-ms-enum": { + "name": "ReplicationRole", + "modelAsString": true + }, + "description": "The replication role." + }, + "DataEncryption": { + "type": "object", + "description": "The date encryption for cmk.", + "properties": { + "primaryUserAssignedIdentityId": { + "type": "string", + "description": "Primary user identity resource id" + }, + "primaryKeyURI": { + "type": "string", + "description": "Primary key uri" + }, + "geoBackupUserAssignedIdentityId": { + "type": "string", + "description": "Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup" + }, + "geoBackupKeyURI": { + "type": "string", + "description": "Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup" + }, + "type": { + "type": "string", + "description": "The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk.", + "enum": [ + "AzureKeyVault", + "SystemManaged" + ], + "x-ms-enum": { + "name": "DataEncryptionType", + "modelAsString": false + } + } + } + }, + "MaintenancePolicy": { + "type": "object", + "description": "Maintenance policy of a server.", + "properties": { + "patchStrategy": { + "$ref": "#/definitions/PatchStrategy", + "description": "The patch strategy of this server" + } + } + }, + "MaintenanceWindow": { + "type": "object", + "description": "Maintenance window of a server.", + "properties": { + "customWindow": { + "type": "string", + "description": "indicates whether custom window is enabled or disabled" + }, + "startHour": { + "type": "integer", + "format": "int32", + "description": "start hour for maintenance window" + }, + "startMinute": { + "type": "integer", + "format": "int32", + "description": "start minute for maintenance window" + }, + "dayOfWeek": { + "type": "integer", + "format": "int32", + "description": "day of week for maintenance window" + } + } + }, + "Backup": { + "type": "object", + "properties": { + "backupRetentionDays": { + "type": "integer", + "format": "int32", + "description": "Backup retention days for the server." + }, + "backupIntervalHours": { + "type": "integer", + "format": "int32", + "description": "Backup interval hours for the server." + }, + "geoRedundantBackup": { + "$ref": "#/definitions/EnableStatusEnum", + "description": "Whether or not geo redundant backup is enabled.", + "default": "Disabled" + }, + "earliestRestoreDate": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Earliest restore point creation time (ISO8601 format)" + } + }, + "description": "Storage Profile properties of a server" + }, + "Storage": { + "type": "object", + "properties": { + "storageSizeGB": { + "type": "integer", + "format": "int32", + "description": "Max storage size allowed for a server." + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "Storage IOPS for a server." + }, + "autoGrow": { + "description": "Enable Storage Auto Grow or not.", + "$ref": "#/definitions/EnableStatusEnum", + "default": "Disabled" + }, + "logOnDisk": { + "description": "Enable Log On Disk or not.", + "$ref": "#/definitions/EnableStatusEnum", + "default": "Disabled" + }, + "storageSku": { + "type": "string", + "readOnly": true, + "description": "The sku name of the server storage." + }, + "autoIoScaling": { + "description": "Enable IO Auto Scaling or not.", + "$ref": "#/definitions/EnableStatusEnum", + "default": "Enabled" + }, + "storageRedundancy": { + "description": "The redundant type of the server storage. The parameter is used for server creation.", + "$ref": "#/definitions/StorageRedundancyEnum", + "default": "LocalRedundancy", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "description": "Storage Profile properties of a server" + }, + "MySQLServerSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the sku, e.g. Standard_D32s_v3." + }, + "tier": { + "type": "string", + "description": "The tier of the particular SKU, e.g. GeneralPurpose.", + "enum": [ + "Burstable", + "GeneralPurpose", + "MemoryOptimized" + ], + "x-ms-enum": { + "name": "ServerSkuTier", + "modelAsString": true + } + } + }, + "required": [ + "name", + "tier" + ], + "description": "Billing information related properties of a server." + }, + "Network": { + "type": "object", + "properties": { + "publicNetworkAccess": { + "$ref": "#/definitions/EnableStatusEnum", + "description": "Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration." + }, + "delegatedSubnetResourceId": { + "type": "string", + "description": "Delegated subnet resource id used to setup vnet for a server." + }, + "privateDnsZoneResourceId": { + "type": "string", + "description": "Private DNS zone resource id." + } + }, + "description": "Network related properties of a server" + }, + "HighAvailability": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "enum": [ + "Disabled", + "ZoneRedundant", + "SameZone" + ], + "x-ms-enum": { + "name": "HighAvailabilityMode", + "modelAsString": true + }, + "description": "High availability mode for a server." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The state of server high availability.", + "enum": [ + "NotEnabled", + "CreatingStandby", + "Healthy", + "FailingOver", + "RemovingStandby" + ], + "x-ms-enum": { + "name": "HighAvailabilityState", + "modelAsString": true + } + }, + "standbyAvailabilityZone": { + "type": "string", + "description": "Availability zone of the standby server." + } + }, + "description": "High availability properties of a server" + }, + "HighAvailabilityValidationEstimation": { + "type": "object", + "properties": { + "estimatedDowntime": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "Estimated seconds of downtime for the deployment." + }, + "scheduledStandbyAvailabilityZone": { + "type": "string", + "readOnly": true, + "description": "Scheduled Availability zone of the standby server." + }, + "expectedStandbyAvailabilityZone": { + "type": "string", + "description": "Expected Availability zone of the standby server." + } + }, + "description": "High availability validation properties of a server" + }, + "ImportSourceProperties": { + "type": "object", + "properties": { + "storageType": { + "type": "string", + "enum": [ + "AzureBlob" + ], + "x-ms-enum": { + "name": "ImportSourceStorageType", + "modelAsString": true + }, + "description": "Storage type of import source.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "storageUrl": { + "type": "string", + "description": "Uri of the import source storage.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "sasToken": { + "type": "string", + "x-ms-secret": true, + "description": "Sas token for accessing source storage. Read and list permissions are required for sas token.", + "x-ms-mutability": [ + "create" + ] + }, + "dataDirPath": { + "type": "string", + "description": "Relative path of data directory in storage.", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "description": "Import source related properties." + }, + "ServerProperties": { + "type": "object", + "properties": { + "administratorLogin": { + "type": "string", + "description": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "administratorLoginPassword": { + "type": "string", + "x-ms-secret": true, + "format": "password", + "description": "The password of the administrator login (required for server creation).", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "version": { + "$ref": "#/definitions/ServerVersion", + "description": "Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7" + }, + "fullVersion": { + "type": "string", + "description": "Major version and actual engine version", + "x-ms-mutability": [ + "read" + ] + }, + "availabilityZone": { + "type": "string", + "description": "availability Zone information of the server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "createMode": { + "type": "string", + "description": "The mode to create a new MySQL server.", + "enum": [ + "Default", + "PointInTimeRestore", + "Replica", + "GeoRestore" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "create" + ] + }, + "sourceServerResourceId": { + "type": "string", + "description": "The source MySQL server id.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "restorePointInTime": { + "type": "string", + "format": "date-time", + "description": "Restore point creation time (ISO8601 format), specifying the time to restore from.", + "x-ms-mutability": [ + "create" + ] + }, + "replicationRole": { + "$ref": "#/definitions/ReplicationRole", + "description": "The replication role." + }, + "replicaCapacity": { + "type": "integer", + "format": "int32", + "minimum": 0, + "readOnly": true, + "description": "The maximum number of replicas that a primary server can have." + }, + "dataEncryption": { + "$ref": "#/definitions/DataEncryption", + "description": "The Data Encryption for CMK." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The state of a server.", + "enum": [ + "Ready", + "Dropping", + "Disabled", + "Starting", + "Stopping", + "Stopped", + "Updating" + ], + "x-ms-enum": { + "name": "ServerState", + "modelAsString": true + } + }, + "fullyQualifiedDomainName": { + "type": "string", + "description": "The fully qualified domain name of a server.", + "readOnly": true + }, + "databasePort": { + "type": "integer", + "format": "int32", + "description": "The server database port. Can only be specified when the server is being created.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage related properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "description": "Backup related properties of a server." + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "description": "High availability related properties of a server." + }, + "network": { + "$ref": "#/definitions/Network", + "description": "Network related properties of a server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "privateEndpointConnections": { + "type": "array", + "items": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "PrivateEndpointConnections related properties of a server.", + "readOnly": true + }, + "maintenancePolicy": { + "$ref": "#/definitions/MaintenancePolicy", + "description": "Maintenance policy of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately.", + "x-ms-mutability": [ + "update", + "read" + ] + }, + "importSourceProperties": { + "$ref": "#/definitions/ImportSourceProperties", + "description": "Source properties for import from storage." + } + }, + "description": "The properties of a server." + }, + "Server": { + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/MySQLServerIdentity", + "description": "The cmk identity for the server." + }, + "sku": { + "$ref": "#/definitions/MySQLServerSku", + "description": "The SKU (pricing tier) of the server." + }, + "properties": { + "$ref": "#/definitions/ServerProperties", + "x-ms-client-flatten": true, + "description": "Properties of the server." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a server." + }, + "ServerPropertiesForUpdate": { + "type": "object", + "properties": { + "administratorLoginPassword": { + "type": "string", + "x-ms-secret": true, + "format": "password", + "description": "The password of the administrator login." + }, + "version": { + "$ref": "#/definitions/ServerVersion", + "description": "Server version." + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage related properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "description": "Backup related properties of a server." + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "description": "High availability related properties of a server." + }, + "maintenancePolicy": { + "$ref": "#/definitions/MaintenancePolicy", + "description": "Maintenance policy of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window of a server." + }, + "replicationRole": { + "$ref": "#/definitions/ReplicationRole", + "description": "The replication role of the server." + }, + "dataEncryption": { + "$ref": "#/definitions/DataEncryption", + "description": "The Data Encryption for CMK." + }, + "network": { + "$ref": "#/definitions/Network", + "description": "Network related properties of a server" + } + }, + "description": "The properties that can be updated for a server." + }, + "ServerForUpdate": { + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/MySQLServerIdentity", + "description": "The cmk identity for the server." + }, + "sku": { + "$ref": "#/definitions/MySQLServerSku", + "description": "The SKU (pricing tier) of the server." + }, + "properties": { + "$ref": "#/definitions/ServerPropertiesForUpdate", + "x-ms-client-flatten": true, + "description": "The properties that can be updated for a server." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "Parameters allowed to update for a server." + }, + "ServerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Server" + }, + "description": "The list of servers" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of servers." + }, + "ServerRestartParameter": { + "type": "object", + "properties": { + "restartWithFailover": { + "$ref": "#/definitions/EnableStatusEnum", + "description": "Whether or not failover to standby server when restarting a server with high availability enabled." + }, + "maxFailoverSeconds": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed failover time in seconds." + } + }, + "description": "Server restart parameters." + }, + "ServerGtidSetParameter": { + "type": "object", + "properties": { + "gtidSet": { + "type": "string", + "description": "The Gtid set of server." + } + }, + "description": "Server Gtid set parameters: Replication with Global Transaction Identifiers." + }, + "ServerDetachVNetParameter": { + "type": "object", + "properties": { + "publicNetworkAccess": { + "$ref": "#/definitions/EnableStatusEnum", + "description": "Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration." + } + }, + "description": "Parameters to detach Vnet." + }, + "MySQLServerIdentity": { + "x-ms-client-flatten": true, + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "ObjectId from the KeyVault", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "TenantId from the KeyVault", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of managed service identity.", + "enum": [ + "UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "description": "", + "items": { + "$ref": "#/definitions/UserAssignedIdentity" + } + }, + "description": "Metadata of user assigned identity." + } + }, + "description": "Properties to configure Identity for Bring your Own Keys" + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "principalId": { + "description": "Principal Id of user assigned identity", + "type": "string", + "x-ms-client-name": "PrincipalId", + "readOnly": true + }, + "clientId": { + "description": "Client Id of user assigned identity", + "type": "string", + "x-ms-client-name": "ClientId", + "readOnly": true + } + }, + "description": "Metadata of user assigned identity." + }, + "StorageRedundancyEnum": { + "type": "string", + "description": "Enum to indicate whether storage sku value is 'ZoneRedundancy' or 'LocalRedundancy'", + "enum": [ + "LocalRedundancy", + "ZoneRedundancy" + ], + "x-ms-enum": { + "name": "StorageRedundancyEnum", + "modelAsString": true + } + }, + "PatchStrategy": { + "type": "string", + "description": "Enum to indicate the patch strategy of a server", + "enum": [ + "Regular", + "VirtualCanary" + ], + "x-ms-enum": { + "name": "PatchStrategy", + "modelAsString": true + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsGet.json new file mode 100644 index 000000000000..aa2d23d9610f --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-6852", + "serverName": "threatprotection-2080", + "advancedThreatProtectionName": "Default", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforMySQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforMySQL/flexibleServers/advancedThreatProtectionSettings", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Enabled", + "creationTime": "2022-04-03T04:41:33.937Z", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsList.json new file mode 100644 index 000000000000..e1587e23a395 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-6852", + "serverName": "threatprotection-2080", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-6852/providers/Microsoft.DBforMySQL/flexibleServers/threatprotection-2080/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforMySQL/flexibleServers/advancedThreatProtectionSettings", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Enabled", + "creationTime": "2022-04-03T04:41:33.937Z", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsPatchDisabled.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsPatchDisabled.json new file mode 100644 index 000000000000..7da443989b1d --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsPatchDisabled.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-4799", + "serverName": "threatprotection-6440", + "advancedThreatProtectionName": "Default", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "state": "Disabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforMySQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforMySQL/flexibleServers/advancedThreatProtectionSettings", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Disabled", + "creationTime": "2022-04-03T04:41:33.937Z", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/azureAsyncOperation/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsPatchEnabled.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsPatchEnabled.json new file mode 100644 index 000000000000..a6c270648d2b --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsPatchEnabled.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-4799", + "serverName": "threatprotection-6440", + "advancedThreatProtectionName": "Default", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforMySQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforMySQL/flexibleServers/advancedThreatProtectionSettings", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Enabled", + "creationTime": "2022-04-03T04:41:33.937Z", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/azureAsyncOperation/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsPutDisabled.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsPutDisabled.json new file mode 100644 index 000000000000..13bab653da7b --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsPutDisabled.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-4799", + "serverName": "threatprotection-6440", + "advancedThreatProtectionName": "Default", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "state": "Disabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforMySQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforMySQL/flexibleServers/advancedThreatProtectionSettings", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Disabled", + "creationTime": "2022-04-03T04:41:33.937Z", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforMySQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforMySQL/flexibleServers/advancedThreatProtectionSettings", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Disabled", + "creationTime": "2022-04-03T04:41:33.937Z", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/azureAsyncOperation/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsPutEnabled.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsPutEnabled.json new file mode 100644 index 000000000000..46526b9d9d2a --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/AdvancedThreatProtectionSettingsPutEnabled.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-4799", + "serverName": "threatprotection-6440", + "advancedThreatProtectionName": "Default", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforMySQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforMySQL/flexibleServers/advancedThreatProtectionSettings", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Enabled", + "creationTime": "2022-04-03T04:41:33.937Z", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforMySQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforMySQL/flexibleServers/advancedThreatProtectionSettings", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Enabled", + "creationTime": "2022-04-03T04:41:33.937Z", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/azureAsyncOperation/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/CutoverMigration.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/CutoverMigration.json new file mode 100644 index 000000000000..ba8a00ce20ce --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/CutoverMigration.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 30, + "iops": 200, + "autoGrow": "Disabled", + "storageSku": "Premium_LRS", + "autoIoScaling": "Disabled" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "3", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 1, + "startHour": 1, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Disabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/MaintenancePolicyPatchOptInVirtualCanary.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/MaintenancePolicyPatchOptInVirtualCanary.json new file mode 100644 index 000000000000..6d89d32a0cd5 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/MaintenancePolicyPatchOptInVirtualCanary.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "maintenancePolicy": { + "patchStrategy": "VirtualCanary" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "3", + "maintenancePolicy": { + "patchStrategy": "VirtualCanary" + }, + "maintenanceWindow": { + "customWindow": "Disabled" + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-02-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-02-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/MaintenancePolicyPatchOptOutVirtualCanary.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/MaintenancePolicyPatchOptOutVirtualCanary.json new file mode 100644 index 000000000000..cac66b8289b4 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/MaintenancePolicyPatchOptOutVirtualCanary.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "maintenancePolicy": { + "patchStrategy": "Default" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "3", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Disabled" + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-02-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-02-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ReplicasListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ReplicasListByServer.json new file mode 100644 index 000000000000..355ebb94a85b --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ReplicasListByServer.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 20, + "iops": 360, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver-repl.orcabrci-seas1-a.mscds.com", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "availabilityZone": "1", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "Replica", + "replicaCapacity": 0, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T08:19:18.00+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver-repl", + "name": "mysqltestserver-repl", + "type": "Microsoft.DBforMySQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 20, + "iops": 360, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver-repl2.orcabrci-seas1-a.mscds.com", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "availabilityZone": "1", + "maintenancePolicy": { + "patchStrategy": "Default" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "Replica", + "replicaCapacity": 0, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-23T08:19:18.00+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver-repl2", + "name": "mysqltestserver-repl", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreate.json new file mode 100644 index 000000000000..a0dc2fbb8bc7 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreate.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "your_password", + "availabilityZone": "1", + "version": "5.7", + "createMode": "Default", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Disabled", + "storageRedundancy": "ZoneRedundancy" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "standbyAvailabilityZone": "3" + } + }, + "location": "southeastasia", + "tags": { + "num": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "3" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "3" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateReplica.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateReplica.json new file mode 100644 index 000000000000..32041c5338b8 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateReplica.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "serverName": "replica-server", + "resourceGroupName": "testgr", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "SoutheastAsia", + "properties": { + "createMode": "Replica", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/source-server" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 20, + "iops": 360, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "replica-server.database.mysql.azure.com", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/source-server", + "availabilityZone": "3", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "Replica", + "replicaCapacity": 0, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T08:19:18.5729164+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/replica-server", + "name": "replica-server", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 20, + "iops": 360, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "replica-server.database.mysql.azure.com", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/source-server", + "availabilityZone": "3", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "Replica", + "replicaCapacity": 0, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T08:19:18.5729164+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/replica-server", + "name": "replica-server", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithBYOK.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithBYOK.json new file mode 100644 index 000000000000..27d52ce64016 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithBYOK.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {} + } + }, + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "your_password", + "availabilityZone": "1", + "version": "5.7", + "createMode": "Default", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Disabled", + "storageRedundancy": "LocalRedundancy" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "standbyAvailabilityZone": "3" + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity", + "primaryKeyURI": "https://test.vault.azure.net/keys/key/c8a92236622244c0a4fdb892666f671a", + "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-identity", + "geoBackupKeyURI": "https://test-geo.vault.azure.net/keys/key/c8a92236622244c0a4fdb892666f671a" + } + }, + "location": "southeastasia", + "tags": { + "num": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "3" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "3" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithBusinessCritical.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithBusinessCritical.json new file mode 100644 index 000000000000..65716830b677 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithBusinessCritical.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "sku": { + "name": "Standard_E2ds_v4", + "tier": "MemoryOptimized" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "your_password", + "availabilityZone": "1", + "version": "5.7", + "fullVersion": "5.7.44", + "createMode": "Default", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Disabled", + "storageRedundancy": "LocalRedundancy" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled" + }, + "highAvailability": { + "mode": "Disabled" + } + }, + "location": "southeastasia", + "tags": { + "num": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_E2ds_v4", + "tier": "MemoryOptimized" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithDatabasePort.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithDatabasePort.json new file mode 100644 index 000000000000..7fb0a3b776e6 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithDatabasePort.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "your_password", + "availabilityZone": "1", + "version": "5.7", + "createMode": "Default", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Disabled", + "storageRedundancy": "LocalRedundancy" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "standbyAvailabilityZone": "3" + }, + "databasePort": 8888 + }, + "location": "southeastasia", + "tags": { + "num": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "3" + }, + "databasePort": 8888 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "3" + }, + "databasePort": 8888 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithPointInTimeRestore.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithPointInTimeRestore.json new file mode 100644 index 000000000000..f13f3ff221bc --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithPointInTimeRestore.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "serverName": "targetserver", + "resourceGroupName": "TargetResourceGroup", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "SoutheastAsia", + "properties": { + "restorePointInTime": "2021-06-24T00:00:37.467Z", + "createMode": "PointInTimeRestore", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/SourceResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/sourceserver" + }, + "sku": { + "name": "Standard_D14_v2", + "tier": "GeneralPurpose" + }, + "tags": { + "num": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "adminuser", + "storage": { + "storageSizeGB": 20, + "iops": 360, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "targetserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T00:15:24.00+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TargetResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/targetserver", + "name": "targetserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "adminuser", + "storage": { + "storageSizeGB": 20, + "iops": 360, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "targetserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T00:15:24.00+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TargetResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/targetserver", + "name": "targetserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithZRS.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithZRS.json new file mode 100644 index 000000000000..f48ec8bcb734 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerCreateWithZRS.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "your_password", + "availabilityZone": "1", + "version": "5.7", + "fullVersion": "5.7.44", + "createMode": "Default", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Disabled", + "storageRedundancy": "ZoneRedundancy" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled" + }, + "highAvailability": { + "mode": "Disabled" + } + }, + "location": "southeastasia", + "tags": { + "num": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerDelete.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerDelete.json new file mode 100644 index 000000000000..4b280f773f65 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerDetachVNet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerDetachVNet.json new file mode 100644 index 000000000000..b693835d69e9 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerDetachVNet.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "publicNetworkAccess": "Enabled" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 30, + "iops": 200, + "autoGrow": "Disabled", + "storageSku": "Premium_LRS", + "autoIoScaling": "Disabled" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "3", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 1, + "startHour": 1, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Disabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerFailover.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerFailover.json new file mode 100644 index 000000000000..2239c01c6cf2 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerFailover.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerGet.json new file mode 100644 index 000000000000..1eb9490cd69d --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerGet.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "autoIoScaling": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "3", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 1, + "startHour": 1, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerGetWithVnet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerGetWithVnet.json new file mode 100644 index 000000000000..cce1d7ca4b3f --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerGetWithVnet.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "3", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/2941a09d-7bcf-42fe-91ca-1765f521c829/resourceGroups/OrcabrCI-Vnet-Resource-Group/providers/Microsoft.Network/virtualNetworks/OrcabrCI-Vnet/subnets/mysql-subnet" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerResetGtid.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerResetGtid.json new file mode 100644 index 000000000000..266b70113c96 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerResetGtid.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "gtidSet": "4aff5b51-97ba-11ed-a955-002248036acc:1-16" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerRestart.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerRestart.json new file mode 100644 index 000000000000..2dd97599a53e --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerRestart.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "restartWithFailover": "Enabled", + "maxFailoverSeconds": 60 + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerStart.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerStart.json new file mode 100644 index 000000000000..2239c01c6cf2 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerStart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerStop.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerStop.json new file mode 100644 index 000000000000..2239c01c6cf2 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerStop.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerUpdate.json new file mode 100644 index 000000000000..15dbaff8bf3d --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerUpdate.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "storage": { + "storageSizeGB": 30, + "iops": 200, + "autoGrow": "Disabled", + "autoIoScaling": "Disabled", + "storageRedundancy": "LocalRedundancy" + }, + "network": { + "publicNetworkAccess": "Disabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 30, + "iops": 200, + "autoGrow": "Disabled", + "storageSku": "Premium_LRS", + "autoIoScaling": "Disabled", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "3", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 1, + "startHour": 1, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Disabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerUpdateWithBYOK.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerUpdateWithBYOK.json new file mode 100644 index 000000000000..9d8f22bc0ecb --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerUpdateWithBYOK.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {} + } + }, + "properties": { + "dataEncryption": { + "type": "AzureKeyVault", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity", + "primaryKeyURI": "https://test.vault.azure.net/keys/key/c8a92236622244c0a4fdb892666f671a", + "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-identity", + "geoBackupKeyURI": "https://test-geo.vault.azure.net/keys/key/c8a92236622244c0a4fdb892666f671a" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "3" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json new file mode 100644 index 000000000000..7e0b8379ac6d --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 1, + "startHour": 8, + "startMinute": 0 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "3", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 1, + "startHour": 8, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerValidateEstimateHighAvailability.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerValidateEstimateHighAvailability.json new file mode 100644 index 000000000000..459b1b9fd726 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServerValidateEstimateHighAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "expectedStandbyAvailabilityZone": "1" + } + }, + "responses": { + "200": { + "body": { + "estimatedDowntime": 0, + "scheduledStandbyAvailabilityZone": "1", + "expectedStandbyAvailabilityZone": "1" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServersList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServersList.json new file mode 100644 index 000000000000..da57c07550c3 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServersList.json @@ -0,0 +1,173 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_B1ms", + "tier": "Burstable" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 23, + "iops": 369, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver1.database.mysql.azure.com", + "availabilityZone": "1", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T07:08:17.4259886+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver1", + "name": "mysqltestserver1", + "type": "Microsoft.DBforMySQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 23, + "iops": 369, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver2.mysql.database.azure.com", + "availabilityZone": "2", + "maintenancePolicy": { + "patchStrategy": "Default" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T07:08:17.4259886+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup2/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver2", + "name": "mysqltestserver2", + "type": "Microsoft.DBforMySQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_E2ds_v4", + "tier": "MemoryOptimized" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver3.mysql.database.azure.com", + "availabilityZone": "1", + "maintenancePolicy": { + "patchStrategy": "Default" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T06:28:19.0611667+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup3/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver3", + "name": "mysqltestserver3", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServersListByResourceGroup.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServersListByResourceGroup.json new file mode 100644 index 000000000000..40970fb70e89 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-10-01-preview/examples/ServersListByResourceGroup.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "resourceGroupName": "TestGroup", + "api-version": "2024-10-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_B1ms", + "tier": "Burstable" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 23, + "iops": 369, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver1.database.mysql.azure.com", + "availabilityZone": "1", + "maintenancePolicy": { + "patchStrategy": "Regular" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T07:08:17.4259886+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver1", + "name": "mysqltestserver1", + "type": "Microsoft.DBforMySQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 23, + "iops": 369, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS", + "storageRedundancy": "LocalRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver2.mysql.database.azure.com", + "availabilityZone": "2", + "maintenancePolicy": { + "patchStrategy": "Default" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T07:08:17.4259886+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver2", + "name": "mysqltestserver2", + "type": "Microsoft.DBforMySQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_E2ds_v4", + "tier": "MemoryOptimized" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_ZRS", + "storageRedundancy": "ZoneRedundancy" + }, + "version": "5.7", + "fullVersion": "5.7.44", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver3.mysql.database.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "backupIntervalHours": 24, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T06:28:19.0611667+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "databasePort": 3306 + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver3", + "name": "mysqltestserver3", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2024-10-01-preview/ServiceOperations.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2024-10-01-preview/ServiceOperations.json new file mode 100644 index 000000000000..56e75ae8ef49 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2024-10-01-preview/ServiceOperations.json @@ -0,0 +1,1009 @@ +{ + "swagger": "2.0", + "info": { + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations.", + "version": "2024-10-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/capabilities": { + "get": { + "tags": [ + "LocationBasedCapabilities" + ], + "operationId": "LocationBasedCapabilities_List", + "x-ms-examples": { + "CapabilitiesList": { + "$ref": "./examples/CapabilitiesByLocationList.json" + } + }, + "description": "Get capabilities at specified location in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/LocationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/capabilitySets": { + "get": { + "tags": [ + "LocationBasedCapability" + ], + "operationId": "LocationBasedCapabilitySet_List", + "x-ms-examples": { + "CapabilitySetsResult": { + "$ref": "./examples/CapabilitySetListByLocation.json" + } + }, + "description": "Get capabilities at specified location in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/LocationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitySetsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/capabilitySets/{capabilitySetName}": { + "get": { + "tags": [ + "LocationBasedCapability" + ], + "operationId": "LocationBasedCapabilitySet_Get", + "x-ms-examples": { + "CapabilityResult": { + "$ref": "./examples/CapabilitySetByLocation.json" + } + }, + "description": "Get capabilities at specified location in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common-types.json#/parameters/LocationNameParameter" + }, + { + "name": "capabilitySetName", + "in": "path", + "required": true, + "description": "Name of capability set", + "type": "string", + "default": "default", + "pattern": "^[a-z0-9][-a-z0-9]*(?`. -``` yaml $(tag) == 'package-flexibleserver-2024-06-01-preview' && $(python) +``` yaml $(tag) == 'package-flexibleserver-2024-10-01-preview' && $(python) title: MySQLManagementClient package-version: 1.0.0b1 package-name: azure-mgmt-mysqlflexibleservers diff --git a/specification/network/resource-manager/readme.python.md b/specification/network/resource-manager/readme.python.md index edaa7e7cee80..5cb74b3b01df 100644 --- a/specification/network/resource-manager/readme.python.md +++ b/specification/network/resource-manager/readme.python.md @@ -1,363 +1,21 @@ ## Python -These settings apply only when `--track2` is specified on the command line. +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. ``` yaml $(python) +title: NetworkManagementClient azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-network -no-namespace-folders: true -package-version: 1.0.0b1 +namespace: azure.mgmt.network +package-version: 28.0.0 +clear-output-folder: true combine-operation-files: true only-path-and-body-params-positional: true ``` -### Python multi-api - -Generate all API versions currently shipped for this package - -```yaml $(python) -multiapi: true -default-api-version: "2024-03-01" -clear-output-folder: true -batch: - - tag: package-2024-03 - - tag: package-2024-01 - - tag: package-2023-11 - - tag: package-2023-09 - - tag: package-2023-06 - - tag: package-2023-05 - - tag: package-2023-04 - - tag: package-2023-02 - - tag: package-2021-02 - - tag: package-2021-02-preview-only - - tag: package-2020-11 - - tag: package-2020-08 - - tag: package-2020-07 - - tag: package-2020-06 - - tag: package-2020-05 - - tag: package-2020-04 - - tag: package-2020-03 - - tag: package-2019-12 - - tag: package-2019-11 - - tag: package-2019-09 - - tag: package-2019-08 - - tag: package-2019-07 - - tag: package-2019-06 - - tag: package-2019-04 - - tag: package-2019-02 - - tag: package-2018-12 - - tag: package-2018-11 - - tag: package-2018-04 - - tag: package-2017-10 - - tag: package-2015-06split - - multiapiscript: true - -``` - -``` yaml $(multiapiscript) -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/ -perform-load: false -clear-output-folder: false -``` - -### Tag: package-2024-03 and python - -These settings apply only when `--tag=package-2024-03 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2024-03' -namespace: azure.mgmt.network.v2024_03_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2024_03_01 -``` - -### Tag: package-2024-01 and python - -These settings apply only when `--tag=package-2024-01 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2024-01' -namespace: azure.mgmt.network.v2024_01_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2024_01_01 -``` - -### Tag: package-2023-11 and python - -These settings apply only when `--tag=package-2023-11 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-11' -namespace: azure.mgmt.network.v2023_11_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2023_11_01 -``` - -### Tag: package-2023-09 and python - -These settings apply only when `--tag=package-2023-09 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-09' -namespace: azure.mgmt.network.v2023_09_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2023_09_01 -``` - -### Tag: package-2023-06 and python - -These settings apply only when `--tag=package-2023-06 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-06' -namespace: azure.mgmt.network.v2023_06_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2023_06_01 -``` - -### Tag: package-2023-05 and python - -These settings apply only when `--tag=package-2023-05 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-05' -namespace: azure.mgmt.network.v2023_05_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2023_05_01 -``` - -### Tag: package-2023-04 and python - -These settings apply only when `--tag=package-2023-04 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-04' -namespace: azure.mgmt.network.v2023_04_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2023_04_01 -``` - -### Tag: package-2023-02 and python - -These settings apply only when `--tag=package-2023-02 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-02' -namespace: azure.mgmt.network.v2023_02_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2023_02_01 -``` - -### Tag: package-2021-02-preview-only and python - -These settings apply only when `--tag=package-2021-02-preview-only --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-02-preview-only' -namespace: azure.mgmt.network.v2021_02_01_preview -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2021_02_01_preview -``` - - -### Tag: package-2021-02 and python - -These settings apply only when `--tag=package-2021-02 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-02' -namespace: azure.mgmt.network.v2021_02_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2021_02_01 -``` - -### Tag: package-2020-11 and python - -These settings apply only when `--tag=package-2020-11 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-11' -namespace: azure.mgmt.network.v2020_11_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2020_11_01 -``` - -### Tag: package-2020-08 and python - -These settings apply only when `--tag=package-2020-08 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-08' -namespace: azure.mgmt.network.v2020_08_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2020_08_01 -``` - -### Tag: package-2020-07 and python - -These settings apply only when `--tag=package-2020-07 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-07' -namespace: azure.mgmt.network.v2020_07_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2020_07_01 -``` - -### Tag: package-2020-06 and python - -These settings apply only when `--tag=package-2020-06 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-06' -namespace: azure.mgmt.network.v2020_06_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2020_06_01 -``` - -### Tag: package-2020-05 and python - -These settings apply only when `--tag=package-2020-05 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-05' -namespace: azure.mgmt.network.v2020_05_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2020_05_01 -``` - -### Tag: package-2020-04 and python - -These settings apply only when `--tag=package-2020-04 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-04' -namespace: azure.mgmt.network.v2020_04_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2020_04_01 -``` - -### Tag: package-2020-03 and python - -These settings apply only when `--tag=package-2020-03 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-03' -namespace: azure.mgmt.network.v2020_03_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2020_03_01 -``` - -### Tag: package-2019-12 and python - -These settings apply only when `--tag=package-2019-12 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-12' -namespace: azure.mgmt.network.v2019_12_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2019_12_01 -``` - -### Tag: package-2019-11 and python - -These settings apply only when `--tag=package-2019-11 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-11' -namespace: azure.mgmt.network.v2019_11_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2019_11_01 -``` - -### Tag: package-2019-09 and python - -These settings apply only when `--tag=package-2019-09 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-09' -namespace: azure.mgmt.network.v2019_09_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2019_09_01 -``` - -### Tag: package-2019-08 and python - -These settings apply only when `--tag=package-2019-08 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-08' -namespace: azure.mgmt.network.v2019_08_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2019_08_01 -``` - -### Tag: package-2019-07 and python - -These settings apply only when `--tag=package-2019-07 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-07' -namespace: azure.mgmt.network.v2019_07_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2019_07_01 -``` - -### Tag: package-2019-06 and python - -These settings apply only when `--tag=package-2019-06 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-06' -namespace: azure.mgmt.network.v2019_06_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2019_06_01 -``` - -### Tag: package-2019-04 and python - -These settings apply only when `--tag=package-2019-04 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-04' -namespace: azure.mgmt.network.v2019_04_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2019_04_01 -``` - -### Tag: package-2019-02 and python - -These settings apply only when `--tag=package-2019-02 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-02' -namespace: azure.mgmt.network.v2019_02_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2019_02_01 -``` - -### Tag: package-2018-12 and python - -These settings apply only when `--tag=package-2018-12 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2018-12' -namespace: azure.mgmt.network.v2018_12_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2018_12_01 -``` - -### Tag: package-2018-11 and python - -These settings apply only when `--tag=package-2018-11 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2018-11' -namespace: azure.mgmt.network.v2018_11_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2018_11_01 -``` - -### Tag: package-2018-04 and python - -These settings apply only when `--tag=package-2018-04 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2018-04' -namespace: azure.mgmt.network.v2018_04_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2018_04_01 -``` - -### Tag: package-2017-10 and python - -These settings apply only when `--tag=package-2017-10 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2017-10' -namespace: azure.mgmt.network.v2017_10_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2017_10_01 -``` - -### Tag: package-2015-06split and python - -These settings apply only when `--tag=package-2015-06split --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2015-06split' -namespace: azure.mgmt.network.v2015_06_15 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2015_06_15 +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network ``` diff --git a/specification/postgresql/resource-manager/readme.python.md b/specification/postgresql/resource-manager/readme.python.md index 81e72c385d06..1d2bc6954db5 100644 --- a/specification/postgresql/resource-manager/readme.python.md +++ b/specification/postgresql/resource-manager/readme.python.md @@ -10,12 +10,12 @@ no-namespace-folders: true clear-output-folder: true ``` -### Tag: package-flexibleserver-2024-08-01 and python +### Tag: package-flexibleserver-2024-11-01-preview and python -These settings apply only when `--tag=package-flexibleserver-2024-08-01 --python` is specified on the command line. +These settings apply only when `--tag=package-flexibleserver-2024-11-01-preview --python` is specified on the command line. Please also specify `--python-sdk-folder=`. -``` yaml $(tag) == 'package-flexibleserver-2024-08-01' && $(python) +``` yaml $(tag) == 'package-flexibleserver-2024-11-01-preview' && $(python) title: PostgreSQLManagementClient package-name: azure-mgmt-postgresqlflexibleservers package-version: 1.0.0b1 diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/readme.python.md b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/readme.python.md index eca631530d0e..aee667a68e77 100644 --- a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/readme.python.md +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/readme.python.md @@ -1,111 +1,18 @@ ## Python These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. ```yaml $(python) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-redhatopenshift -package-version: 1.0.0b1 +namespace: azure.mgmt.redhatopenshift +package-version: 2.0.0 clear-output-folder: true -no-namespace-folders: true -``` - -### Python multi-api - -Generate all API versions currently shipped for this package - -```yaml $(python) -default-api-version: "2023-11-22" -multiapi: true -batch: - - tag: package-2023-11 - - tag: package-2020-04-30 - - tag: package-2021-09-01-preview - - tag: package-2022-04-01 - - tag: package-2022-09-04 - - tag: package-2023-04-01 - - tag: package-2023-09-04 - - multiapiscript: true -``` - -``` yaml $(multiapiscript) -output-folder: $(python-sdks-folder)/redhatopenshift/azure-mgmt-redhatopenshift/azure/mgmt/redhatopenshift/ -clear-output-folder: false -perform-load: false -``` - -### Tag: package-2020-04-30 and python - -These settings apply only when `--tag=package-2020-04-30 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-04-30' && $(python) -namespace: azure.mgmt.redhatopenshift.v2020_04_30 -output-folder: $(python-sdks-folder)/redhatopenshift/azure-mgmt-redhatopenshift/azure/mgmt/redhatopenshift/v2020_04_30 -``` - -### Tag: package-2021-09-01-preview and python - -These settings apply only when `--tag=package-2021-09-01-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-09-01-preview' && $(python) -namespace: azure.mgmt.redhatopenshift.v2021_09_01_preview -output-folder: $(python-sdks-folder)/redhatopenshift/azure-mgmt-redhatopenshift/azure/mgmt/redhatopenshift/v2021_09_01_preview -``` - -### Tag: package-2022-04-01 and python - -These settings apply only when `--tag=package-2022-04-01 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - - -``` yaml $(tag) == 'package-2022-04-01' && $(python) -namespace: azure.mgmt.redhatopenshift.v2022_04_01 -output-folder: $(python-sdks-folder)/redhatopenshift/azure-mgmt-redhatopenshift/azure/mgmt/redhatopenshift/v2022_04_01 -``` - -### Tag: package-2022-09-04 and python - -These settings apply only when `--tag=package-2022-09-04 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - - -``` yaml $(tag) == 'package-2022-09-04' && $(python) -namespace: azure.mgmt.redhatopenshift.v2022_09_04 -output-folder: $(python-sdks-folder)/redhatopenshift/azure-mgmt-redhatopenshift/azure/mgmt/redhatopenshift/v2022_09_04 -``` - -### Tag: package-2023-04-01 and python - -These settings apply only when `--tag=package-2023-04-01 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - - -``` yaml $(tag) == 'package-2023-04-01' && $(python) -namespace: azure.mgmt.redhatopenshift.v2022_09_04 -output-folder: $(python-sdks-folder)/redhatopenshift/azure-mgmt-redhatopenshift/azure/mgmt/redhatopenshift/v2023_04_01 -``` - -### Tag: package-2023-09-04 and python - -These settings apply only when `--tag=package-2023-09-04 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - - -``` yaml $(tag) == 'package-2023-09-04' && $(python) -namespace: azure.mgmt.redhatopenshift.v2023_09_04 -output-folder: $(python-sdks-folder)/redhatopenshift/azure-mgmt-redhatopenshift/azure/mgmt/redhatopenshift/v2023_09_04 ``` -### Tag: package-2023-11 and python - -These settings apply only when `--tag=package-2023-11 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - - -``` yaml $(tag) == 'package-2023-11' && $(python) -namespace: azure.mgmt.redhatopenshift.v2023_11_22 -output-folder: $(python-sdks-folder)/redhatopenshift/azure-mgmt-redhatopenshift/azure/mgmt/redhatopenshift/v2023_11_22 +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/redhatopenshift/azure-mgmt-redhatopenshift/azure/mgmt/redhatopenshift ``` diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseCreate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseCreate.json index 92fa5977abc6..e3d5f7f18a47 100644 --- a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseCreate.json +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseCreate.json @@ -45,6 +45,7 @@ "type": "Microsoft.Cache/redisEnterprise", "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", "location": "West US", + "kind": "v1", "sku": { "name": "EnterpriseFlash_F300", "capacity": 3 @@ -90,6 +91,7 @@ "type": "Microsoft.Cache/redisEnterprise", "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", "location": "West US", + "kind": "v1", "sku": { "name": "EnterpriseFlash_F300", "capacity": 3 diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseGet.json index c26cd724140f..e706b6387a61 100644 --- a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseGet.json +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseGet.json @@ -10,6 +10,7 @@ "body": { "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", "location": "West US", + "kind": "v1", "sku": { "name": "EnterpriseFlash_F300", "capacity": 3 diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseList.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseList.json index 356955019e47..6b18ea307435 100644 --- a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseList.json +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseList.json @@ -10,6 +10,7 @@ { "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", "location": "West US", + "kind": "v1", "sku": { "name": "EnterpriseFlash_F300", "capacity": 3 diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseListByResourceGroup.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseListByResourceGroup.json index c2bc26c5e69a..138d6aa13a8a 100644 --- a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseListByResourceGroup.json +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseListByResourceGroup.json @@ -11,6 +11,7 @@ { "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", "location": "West US", + "kind": "v1", "sku": { "name": "EnterpriseFlash_F300", "capacity": 3 diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseUpdate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseUpdate.json index edd71a083e03..caa96fdc4452 100644 --- a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseUpdate.json +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/examples/RedisEnterpriseUpdate.json @@ -24,6 +24,7 @@ "name": "cache1", "type": "Microsoft.Cache/redisEnterprise", "location": "West US", + "kind": "v1", "sku": { "name": "EnterpriseFlash_F300", "capacity": 9 diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/redisenterprise.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/redisenterprise.json index e28b301ce4f3..b731f4bcac98 100644 --- a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/redisenterprise.json +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2024-09-01-preview/redisenterprise.json @@ -1722,6 +1722,19 @@ } }, "definitions": { + "Kind": { + "type": "string", + "readOnly": true, + "description": "Distinguishes the kind of cluster. Read-only.", + "enum": [ + "v1", + "v2" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, "Sku": { "description": "SKU parameters supplied to the create Redis Enterprise cluster operation.", "type": "object", @@ -1847,6 +1860,9 @@ "description": "Describes the Redis Enterprise cluster", "type": "object", "properties": { + "kind": { + "$ref": "#/definitions/Kind" + }, "sku": { "$ref": "#/definitions/Sku", "description": "The SKU to create, which affects price, performance, and features." diff --git a/specification/resourcehealth/resource-manager/readme.python.md b/specification/resourcehealth/resource-manager/readme.python.md index d88b796069c3..f91a0035e092 100644 --- a/specification/resourcehealth/resource-manager/readme.python.md +++ b/specification/resourcehealth/resource-manager/readme.python.md @@ -17,3 +17,7 @@ title: ResourceHealthMgmtClient no-namespace-folders: true output-folder: $(python-sdks-folder)/resourcehealth/azure-mgmt-resourcehealth/azure/mgmt/resourcehealth ``` + +``` yaml $(python) +flatten-models: false +``` diff --git a/specification/resources/resource-manager/readme.typescript.md b/specification/resources/resource-manager/readme.typescript.md index 04c8eae80e72..58515df1b7bd 100644 --- a/specification/resources/resource-manager/readme.typescript.md +++ b/specification/resources/resource-manager/readme.typescript.md @@ -23,6 +23,7 @@ batch: ``` ```yaml $(typescript) && $(package-databoundaries) && !$(profile-content) +title: DataboundariesManegementClient typescript: package-name: "@azure/arm-databoundaries" output-folder: "$(typescript-sdks-folder)/sdk/databoundaries/arm-databoundaries" diff --git a/specification/terraform/Microsoft.AzureTerraform.Management/client.tsp b/specification/terraform/Microsoft.AzureTerraform.Management/client.tsp index ccee335ee281..1b0070b98acb 100644 --- a/specification/terraform/Microsoft.AzureTerraform.Management/client.tsp +++ b/specification/terraform/Microsoft.AzureTerraform.Management/client.tsp @@ -28,3 +28,4 @@ using Microsoft.AzureTerraform; @@clientName(targetProvider.azapi, "AzApi", "csharp"); @@clientName(targetProvider.azurerm, "AzureRM", "csharp"); @@clientName(Terraform.exportTerraform, "ExportTerraform", "csharp"); +@@clientName(Microsoft.AzureTerraform, "TerraformMgmt", "python"); diff --git a/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml b/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml index 35c8eda84655..cfd71d61c9b8 100644 --- a/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml +++ b/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml @@ -16,6 +16,12 @@ options: clear-output-folder: true model-namespace: false namespace: "{package-dir}" + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-terraform" + package-name: "{package-dir}" + flavor: "azure" + generate-test: true + generate-sample: true linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager"